org.xmcda

Class QualifiedValue<T>

java.lang.Object

org.xmcda.QualifiedValue<T>

All Implemented Interfaces:

Serializable, CommonAttributes, HasDescription

public class QualifiedValue<T>
extends Object
implements CommonAttributes, HasDescription, Serializable

Hold an evaluation of a alternative on a criterion, along with a description and the XMCDA so-called "common attributes".

Author:

Sébastien Bigaret

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QualifiedValue()
QualifiedValue(T value)

Method Summary

Modifier and Type	Method and Description
static <DESTINATION> void	checkConversion(QualifiedValue<?> value, Class<DESTINATION> toClass) Checks that the conversion can be done but leave the object untouched.
<DESTINATION> QualifiedValue<DESTINATION>	convertTo(Class<DESTINATION> clazz)
QualifiedValue<Double>	convertToDouble() Converts this value to double.
Description	getDescription()
T	getValue()
String	getXMCDATag() Return the XMCDA tag for this value.
Type	getXMCDAType() Return the XMCDA Type for this value.
String	id()
boolean	isNA() Return true if the value is NA
boolean	isNumeric() Return true if the value is of type integer, float, double or Rational
String	mcdaConcept()
String	name()
void	setDescription(Description description)
void	setId(String id)
void	setMcdaConcept(String mcdaConcept)
void	setName(String name)
void	setValue(T value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QualifiedValue

public QualifiedValue()

QualifiedValue

public QualifiedValue(T value)

Method Detail

getValue

public T getValue()

setValue

public void setValue(T value)

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

checkConversion

public static <DESTINATION> void checkConversion(QualifiedValue<?> value,
                                                 Class<DESTINATION> toClass)
                                          throws ValueConverters.ConversionException

Checks that the conversion can be done but leave the object untouched.

Type Parameters:

DESTINATION - the class to which the value should be converted

Parameters:

value - the value to be converted

toClass - the class to which the value should be converted

Throws:

ValueConverters.ConversionException - raised if the conversion cannot be done

See Also:

convertTo(Class)

convertTo

public <DESTINATION> QualifiedValue<DESTINATION> convertTo(Class<DESTINATION> clazz)
                                                    throws ValueConverters.ConversionException

Throws:

ValueConverters.ConversionException

convertToDouble

public QualifiedValue<Double> convertToDouble()
                                       throws ValueConverters.ConversionException

Converts this value to double. This a equivalent to this.convertTo(Double.class).

Returns:

this object converted to QualifiedValue<Double>

Throws:

ValueConverters.ConversionException - if the value could not be converted to a double. Note that this may happen even if isNumeric() is True: converting a rational with a denominator equal to zero throw a ConversionException.

isNumeric

public boolean isNumeric()

Return true if the value is of type integer, float, double or Rational

Returns:

true if the value belongs to a sub-type of XMCDA:numeric.

isNA

public boolean isNA()

Return true if the value is NA

Returns:

true if the value is NA, false otherwise.

getXMCDATag

public String getXMCDATag()
                   throws IllegalStateException,
                          NullPointerException

Return the XMCDA tag for this value. Returned value are the one valid within the XMCDA type "value": "integer", "real", "interval", "rational, "label", "boolean", "NA", "fuzzyNumber" and "valuedLabel".

Returns:

the XMCDA tag for this value

Throws:

NullPointerException - if getValue() is null.

IllegalArgumentException - if the getValue() is an instance of an invalid class for an XMCDA value.

IllegalStateException

getXMCDAType

public Type getXMCDAType()
                  throws IllegalStateException,
                         NullPointerException

Return the XMCDA Type for this value.

Returns:

the XMCDA type for this value

Throws:

NullPointerException - if getValue() is null.

IllegalArgumentException - if the getValue() is an instance of an invalid class for a XMCDA value.

IllegalStateException