org.xmcda

Class Threshold<T>

java.lang.Object

org.xmcda.Threshold<T>

All Implemented Interfaces:

Serializable, CommonAttributes

public class Threshold<T>
extends Object
implements CommonAttributes, Serializable

xmcda:type:threshold

Author:

Sébastien Bigaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Threshold.Type xmcda:element:threshold/affine/type

Constructor Summary

Constructors

Constructor and Description
Threshold(QualifiedValue<T> constant)
Threshold(QualifiedValue<T> slope, QualifiedValue<T> intercept)
Threshold(Threshold.Type type, QualifiedValue<T> slope, QualifiedValue<T> intercept)

Method Summary

Modifier and Type	Method and Description
QualifiedValue<T>	getConstant() Returns the constant value for this threshold.
QualifiedValue<T>	getIntercept() Returns the intercept of the threshold's affine function.
QualifiedValue<T>	getSlope() Returns the slope of the threshold's affine function.
Threshold.Type	getType() Returns the type of the affine threshold.
String	id()
boolean	isAffine()
boolean	isConstant()
String	mcdaConcept()
String	name()
protected void	reset() Resets all attributes to null.
void	setAffine(QualifiedValue<T> slope, QualifiedValue<T> intercept) Sets the slope and intercept for an affine threshold.
void	setAffine(Threshold.Type type, QualifiedValue<T> slope, QualifiedValue<T> intercept) Sets the slope, intercept and type for an affine threshold.
void	setConstant(QualifiedValue<T> constant) Sets the value corresponding to a constant thresholds.
void	setId(String id)
void	setMcdaConcept(String mcdaConcept)
void	setName(String name)
void	setType(Threshold.Type type) Sets the threshold's type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Threshold

public Threshold(QualifiedValue<T> constant)

Threshold

public Threshold(QualifiedValue<T> slope,
                 QualifiedValue<T> intercept)

Threshold

public Threshold(Threshold.Type type,
                 QualifiedValue<T> slope,
                 QualifiedValue<T> intercept)

Method Detail

reset

protected void reset()

Resets all attributes to null. This method must be called before setting any of the attributes 'constant', 'type', 'slope' or 'intercept'.

isConstant

public boolean isConstant()

isAffine

public boolean isAffine()

getConstant

public QualifiedValue<T> getConstant()

Returns the constant value for this threshold. Returned value is always null if the threshold is not a constant but an affine function.

Returns:

the (non-null) constant value, or null if this is an affine threshold.

setConstant

public void setConstant(QualifiedValue<T> constant)

Sets the value corresponding to a constant thresholds.

Parameters:

constant - the constant value for this threshold.

Throws:

NullPointerException - if constant] is null

getType

public Threshold.Type getType()

Returns the type of the affine threshold.

Returns:

the (non-null) type of the affine threshold, or null if the threshold is a constant.

getSlope

public QualifiedValue<T> getSlope()

Returns the slope of the threshold's affine function. The returned value is always null if the threshold is a constant.

Returns:

the (non-null) slope of the affine function, or null if the threshold is a constant.

getIntercept

public QualifiedValue<T> getIntercept()

Returns the intercept of the threshold's affine function. The returned value is always null if the threshold is a constant.

Returns:

the (non-null) intercept of the affine function, or null if the threshold is a constant.

setAffine

public void setAffine(QualifiedValue<T> slope,
                      QualifiedValue<T> intercept)

Sets the slope and intercept for an affine threshold. The threshold's type is set to .

Parameters:

slope - the slope for this affine threshold

intercept - the intercept value for this affine threshold

Throws:

NullPointerException - if either slope or intercept is null.

setAffine

public void setAffine(Threshold.Type type,
                      QualifiedValue<T> slope,
                      QualifiedValue<T> intercept)

Sets the slope, intercept and type for an affine threshold. The threshold's type is set to .

Parameters:

slope - the slope for this affine threshold. It may not be null.

intercept - the intercept value for this affine threshold. It may not be null.

type - the threshold's type. It may not be null.

Throws:

NullPointerException - if either slope, intercept or type is null.

setType

public void setType(Threshold.Type type)

Sets the threshold's type.

Parameters:

type - the threshold's type. It may not be null.

Throws:

IllegalStateException - if the threshold is not an affine function.

NullPointerException - if the type is null.

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