Package org.graffiti.plugin.parameter

Class IntegerParameter

java.lang.Object

org.graffiti.plugin.parameter.AbstractSingleParameter

org.graffiti.plugin.parameter.AbstractLimitableParameter

org.graffiti.plugin.parameter.IntegerParameter

All Implemented Interfaces:

Displayable, LimitableParameter, Parameter, SingleParameter, ProvidesScenarioSupportCommand

Direct Known Subclasses:

LandmarkParameter

public class IntegerParameter
extends AbstractLimitableParameter
implements ProvidesScenarioSupportCommand

Parameter that can contain Integer/int values.

Version:

2.6.5

Recent revisions:

2.6.5

Constructor Summary

Constructors

Constructor	Description
IntegerParameter(Integer value, Integer min, Integer max, Integer distance, String name, String description)	Constructs a new Integer parameter.
IntegerParameter(Integer value, Integer min, Integer max, String name, String description)	Constructs a new Integer parameter.
IntegerParameter(Integer value, Integer distance, String name, String description)	Constructs a new Integer parameter.
IntegerParameter(Integer value, String name, String description)	Constructs a new Integer parameter.

Method Summary

Modifier and Type	Method	Description
Integer	getInteger()	Returns the value of this parameter as an Integer.
Comparable<Integer>	getMax()	Returns the maximum of the interval.
Comparable<Integer>	getMin()	Returns the minimum of the interval.
String	getScenarioCommand()
Collection<String>	getScenarioImports()
Object	getValue()	Returns the value of this parameter.
Number	getValuesBall()	The closed ball diameter exclusive for the current parameter value, such that v(t) = val v(t+1) = (val +|- ballDiameter) whereas t stands for time point.
boolean	isValid()	Returns true if the value is between the minimum and the maximum, false otherwise.
void	setValue(Object value)	Sets the value of the AttributeParameter.
void	setValuesBallSize(Integer ball)	Set new intervalue distance.

Methods inherited from class org.graffiti.plugin.parameter.AbstractLimitableParameter

toXMLString

Methods inherited from class org.graffiti.plugin.parameter.AbstractSingleParameter

getDescription, getIcon, getImage, getName, isLeftAligned, setDescription, setLeftAligned, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.graffiti.plugin.Displayable

getDescription, getIcon, getName, setDescription

Methods inherited from interface org.graffiti.plugin.parameter.Parameter

getImage

Constructor Details

IntegerParameter

public IntegerParameter(Integer value,
String name,
String description)

Constructs a new Integer parameter.

Parameters:

value - the new Integer value. May be null.

name - the name of the parameter.

description - the description of the parameter.

IntegerParameter

public IntegerParameter(Integer value,
Integer min,
Integer max,
String name,
String description)

Constructs a new Integer parameter.

Parameters:

value - the new Integer value. May be null.

min - the minimum value.

max - the maximum value.

name - the name of the parameter.

description - the description of the parameter.

IntegerParameter

public IntegerParameter(Integer value,
Integer min,
Integer max,
Integer distance,
String name,
String description)

Constructs a new Integer parameter.

Parameters:

value - the new Integer value. May be null.

min - the minimum value.

max - the maximum value.

distance - the distance between any two points in the [min, max] interval.

name - the name of the parameter.

description - the description of the parameter.

IntegerParameter

public IntegerParameter(Integer value,
Integer distance,
String name,
String description)

Constructs a new Integer parameter.

Parameters:

value - the new Integer value. May be null.

distance - the distance between any two points in the open interval.

name - the name of the parameter.

description - the description of the parameter.

Method Details

getInteger

public Integer getInteger()

Returns the value of this parameter as an Integer.

Returns:

the value of this parameter as an Integer.

getMax

public Comparable<Integer> getMax()

Returns the maximum of the interval.

Specified by:

getMax in interface LimitableParameter

Returns:

the maximum of the interval.

getMin

public Comparable<Integer> getMin()

Returns the minimum of the interval.

Specified by:

getMin in interface LimitableParameter

Returns:

the minimum of the interval.

isValid

public boolean isValid()

Description copied from interface: LimitableParameter

Returns true if the value is between the minimum and the maximum, false otherwise.

Specified by:

isValid in interface LimitableParameter

Returns:

true if the value is between the minimum and the maximum, false otherwise.

setValue

public void setValue(Object value)

Sets the value of the AttributeParameter.

Specified by:

setValue in interface Displayable

Overrides:

setValue in class AbstractSingleParameter

Parameters:

value - the new value of the AttributeParameter.

Throws:

IllegalArgumentException - thrown if value is not of the correct type.

getValue

public Object getValue()

Returns the value of this parameter.

Specified by:

getValue in interface Displayable

Overrides:

getValue in class AbstractSingleParameter

Returns:

the value of this parameter.

setValuesBallSize

public void setValuesBallSize(Integer ball)

Set new intervalue distance.

Parameters:

ball - the change-size between two valid values

getValuesBall

public Number getValuesBall()

Description copied from class: AbstractLimitableParameter

The closed ball diameter exclusive for the current parameter value, such that

v(t) = val
v(t+1) = (val +|- ballDiameter)

whereas t stands for time point.

Specified by:

getValuesBall in class AbstractLimitableParameter

Returns:

a Number instance

getScenarioCommand

public String getScenarioCommand()

Specified by:

getScenarioCommand in interface ProvidesScenarioSupportCommand

getScenarioImports

public Collection<String> getScenarioImports()

Specified by:

getScenarioImports in interface ProvidesScenarioSupportCommand