org.xmcda.utils

Class Matrix<DIMENSION,VALUE_TYPE>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<Coord<DIMENSION,DIMENSION>,QualifiedValues<VALUE_TYPE>>

org.xmcda.utils.Matrix<DIMENSION,VALUE_TYPE>

All Implemented Interfaces:

Serializable, Cloneable, Map<Coord<DIMENSION,DIMENSION>,QualifiedValues<VALUE_TYPE>>, CommonAttributes, HasDescription

Direct Known Subclasses:

AlternativesMatrix, AlternativesSetsMatrix, CategoriesMatrix, CategoriesSetsMatrix, CriteriaMatrix, CriteriaSetsMatrix

public class Matrix<DIMENSION,VALUE_TYPE>
extends LinkedHashMap<Coord<DIMENSION,DIMENSION>,QualifiedValues<VALUE_TYPE>>
implements HasDescription, CommonAttributes, Serializable

Superclass for matrices of alternatives, criteria and categories, holding QualifiedValues as cells' values. This implementation of Map does not allow null values for keys or values.

Author:

Sébastien Bigaret

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected Scale	valuation

Constructor Summary

Constructors

Constructor and Description
Matrix()

Method Summary

Modifier and Type	Method and Description
<U> void	checkConversion(Class<U> clazz)
<U> Matrix<DIMENSION,U>	convertTo(Class<U> clazz) Converts the matrix' values to the specified type.
QualifiedValues<VALUE_TYPE>	get(DIMENSION row, DIMENSION column)
Type[]	getCellsType() Returns the cells' type of a non-empty, homogeneous matrix
Set<Type[]>	getCellsTypes() Returns the types used in this matrix' cells.
Set<DIMENSION>	getColumns()
Description	getDescription()
Set<DIMENSION>	getRows()
Scale	getValuation()
Set<Type>	getValuesTypes() Returns the types of the values contained in the matrix.
boolean	hasMissingValues() Returns true if there is at least one undefined cell.
String	id()
boolean	isHomogeneous() Returns true if this matrix is homogeneous in term of types of its cells' values.
boolean	isHomogeneous(List<Type[]> types) Returns true if this matrix is homogeneous in term of types of its cells' values.
boolean	isNumeric() A performance table is said to be numeric if all its values are numeric
boolean	isSimple() Returns true if none of its cells has more than one value.
String	mcdaConcept()
String	name()
QualifiedValues<VALUE_TYPE>	put(Coord<DIMENSION,DIMENSION> key, QualifiedValues<VALUE_TYPE> value) Maps the specified key to the specified value.
void	put(DIMENSION row, DIMENSION column, QualifiedValue<VALUE_TYPE> qvalue)
void	put(DIMENSION row, DIMENSION column, QualifiedValues<VALUE_TYPE> qvalues)
void	put(DIMENSION row, DIMENSION column, VALUE_TYPE value)
void	putAll(Map<? extends Coord<DIMENSION,DIMENSION>,? extends QualifiedValues<VALUE_TYPE>> m)
QualifiedValues<VALUE_TYPE>	putIfAbsent(Coord<DIMENSION,DIMENSION> key, QualifiedValues<VALUE_TYPE> value) If the specified key is not already associated with a value, associates it with the given value and returns null, else returns the current value.
void	setDescription(Description description)
void	setId(String id)
void	setMcdaConcept(String mcdaConcept)
void	setName(String name)
void	setValuation(Scale valuation)

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, remove, remove, replace, replace, size

Field Detail

valuation

protected Scale valuation

Constructor Detail

Matrix

public Matrix()

Method Detail

getValuation

public Scale getValuation()

Returns:

the valuation

setValuation

public void setValuation(Scale valuation)

Parameters:

valuation - the valuation to set

get

public QualifiedValues<VALUE_TYPE> get(DIMENSION row,
                                       DIMENSION column)

getRows

public Set<DIMENSION> getRows()

getColumns

public Set<DIMENSION> getColumns()

put

public void put(DIMENSION row,
                DIMENSION column,
                QualifiedValues<VALUE_TYPE> qvalues)

put

public void put(DIMENSION row,
                DIMENSION column,
                QualifiedValue<VALUE_TYPE> qvalue)

put

public void put(DIMENSION row,
                DIMENSION column,
                VALUE_TYPE value)

isNumeric

public boolean isNumeric()

A performance table is said to be numeric if all its values are numeric

Returns:

true if the performance table has numeric values only

checkConversion

public <U> void checkConversion(Class<U> clazz)
                         throws ValueConverters.ConversionException

Throws:

ValueConverters.ConversionException

getCellsTypes

public Set<Type[]> getCellsTypes()

Returns the types used in this matrix' cells. The type of a cell is an array of types, since each cell is a QualifiedValues which contains one or more values. The

Returns:

the distinct cells' types used in this matrix

See Also:

getValuesTypes()

getValuesTypes

public Set<Type> getValuesTypes()

Returns the types of the values contained in the matrix. This method scans the matrix and gathers the types of its cells' values individually.

Returns:

the distinct types of the values in the matrix

See Also:

getCellsTypes()

getCellsType

public Type[] getCellsType()

Returns the cells' type of a non-empty, homogeneous matrix

Returns:

the cell type in a non-empty, homogeneous matrix

See Also:

HashMap.isEmpty(), isHomogeneous()

hasMissingValues

public boolean hasMissingValues()

Returns true if there is at least one undefined cell. More formally, returns ture if there exists a row r and a column c for which this.containsKey(new Coord(r,c))==false

Returns:

true if at least a cell in the matrix is undefined.

isHomogeneous

public boolean isHomogeneous()

Returns true if this matrix is homogeneous in term of types of its cells' values. More formally, it returns true if and only if the set of its cells' types has exactly one element. In particular, an empty matrix is not homogeneous.

Returns:

true if the matrix is not empty and the cells have all the same set of types.

See Also:

getCellsTypes(), HashMap.isEmpty(), #isHomogeneous(Set), isSimple()

isHomogeneous

public boolean isHomogeneous(List<Type[]> types)

Returns true if this matrix is homogeneous in term of types of its cells' values. More formally, it returns true if and only if the set of its cells' types has exactly one element. In particular, an empty matrix is not homogeneous.
The cell's types are added to the provided list.

Parameters:

types - the list into which the cells' types are added. It may be null.

Returns:

true if the cells have all the same set of types.

See Also:

getCellsTypes(), HashMap.isEmpty(), isHomogeneous(), isSimple()

isSimple

public boolean isSimple()

Returns true if none of its cells has more than one value.

Returns:

true if every cell has only one value

See Also:

HashMap.isEmpty(), isHomogeneous(), isSimple()

convertTo

public <U> Matrix<DIMENSION,U> convertTo(Class<U> clazz)
                                  throws ValueConverters.ConversionException

Converts the matrix' values to the specified type. If the conversion cannot be done, ConversionException is raised, and the values are left untouched.

Type Parameters:

U - class of the converted values

Parameters:

clazz - the expected class of the converted values

Returns:

this object

Throws:

ValueConverters.ConversionException - if at least one element cannot be converted; in this case, the values are left unmodified.

id

public String id()

Specified by:

id in interface CommonAttributes

setId

public void setId(String id)

Specified by:

setId in interface CommonAttributes

name

public String name()

Specified by:

name in interface CommonAttributes

mcdaConcept

public String mcdaConcept()

Specified by:

mcdaConcept in interface CommonAttributes

setName

public void setName(String name)

Specified by:

setName in interface CommonAttributes

setMcdaConcept

public void setMcdaConcept(String mcdaConcept)

Specified by:

setMcdaConcept in interface CommonAttributes

setDescription

public void setDescription(Description description)

Specified by:

setDescription in interface HasDescription

getDescription

public Description getDescription()

Specified by:

getDescription in interface HasDescription

put

public QualifiedValues<VALUE_TYPE> put(Coord<DIMENSION,DIMENSION> key,
                                       QualifiedValues<VALUE_TYPE> value)

Maps the specified key to the specified value. Neither the key nor the value can be null.

The value can be retrieved by calling the get method with a key that is equal to the original key.

Specified by:

put in interface Map<Coord<DIMENSION,DIMENSION>,QualifiedValues<VALUE_TYPE>>

Overrides:

put in class HashMap<Coord<DIMENSION,DIMENSION>,QualifiedValues<VALUE_TYPE>>

Returns:

the previous value associated with key, or null if there was no mapping for key

Throws:

NullPointerException - if the key or value is null

putAll

public void putAll(Map<? extends Coord<DIMENSION,DIMENSION>,? extends QualifiedValues<VALUE_TYPE>> m)

Specified by:

putAll in interface Map<Coord<DIMENSION,DIMENSION>,QualifiedValues<VALUE_TYPE>>

Overrides:

putAll in class HashMap<Coord<DIMENSION,DIMENSION>,QualifiedValues<VALUE_TYPE>>

Throws:

NullPointerException - if the specified map is null, or if one or its key or value is null.

putIfAbsent

public QualifiedValues<VALUE_TYPE> putIfAbsent(Coord<DIMENSION,DIMENSION> key,
                                               QualifiedValues<VALUE_TYPE> value)

If the specified key is not already associated with a value, associates it with the given value and returns null, else returns the current value.

Specified by:

putIfAbsent in interface Map<Coord<DIMENSION,DIMENSION>,QualifiedValues<VALUE_TYPE>>

Overrides:

putIfAbsent in class HashMap<Coord<DIMENSION,DIMENSION>,QualifiedValues<VALUE_TYPE>>

Throws:

NullPointerException - if the key or value is null