wt.series
Class IntegerSeries

java.lang.Object
  wt.series.Series
      wt.series.IntegerSeries

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, NetFactor, ObjectMappable

public class IntegerSeries
extends Series
implements Externalizable

Defines a sequencing model of whole integer values ranging from min to max with an increment of delta between each adjacent value.

Use the newIntegerSeries static factory method(s), not the IntegerSeries constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: true

See Also:

Serialized Form

Field Summary

protected static String	DELTA Label for the attribute; The increment between adjacent values within the series.
static String	MAX Label for the attribute; The maximum limit of the series.
static String	MIN Label for the attribute; The minimum limit of the series.

Fields inherited from class wt.series.Series

VALUE

Method Summary

void	decrement() Decrements the value of the series to the next adjacent value.
boolean	equals(Series object) Tests if the value of this series is equal to the given one and returns true.
protected static Integer	getDelta() Gets the value of the attribute: DELTA.
protected Integer	getIntegerValue() Gets the integer value of the series.
static Integer	getMax() Gets the value of the attribute: MAX.
static Integer	getMin() Gets the value of the attribute: MIN.
String	getValue() Overrides super class' getter to specifically deal with an integer value stored as a string.
boolean	greaterThan(Series object) Tests if the value of this series is greater than to the given one and returns true.
void	increment() Increments the value of the series to the next adjacent value.
protected void	initialize() Supported API: true
protected void	initialize(Integer value) Supports initialization, following construction of an instance.
boolean	lessThan(Series object) Tests if the value of this series is less than to the given one and returns true.
static IntegerSeries	newIntegerSeries() Makes a new instance.
static IntegerSeries	newIntegerSeries(Integer value) Makes a new instance where the value is set to the given integer.
void	reset() Resets the value of the series to its min.
protected static void	setDelta(Integer a_Delta) Sets the value of the attribute: DELTA.
protected void	setIntegerValue(Integer aValue) Sets the integer value of the series.
protected static void	setMax(Integer a_Max) Sets the value of the attribute: MAX.
protected static void	setMin(Integer a_Min) Sets the value of the attribute: MIN.
protected void	setValue(String aValue) Overrides super class' setter to specifically deal with an integer value stored as a string.

Methods inherited from class wt.series.Series

getUniqueSeriesName, newSeries, newSeries

Methods inherited from class java.lang.Object

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

Field Detail

MIN

public static final String MIN

Label for the attribute; The minimum limit of the series.

Supported API: true

See Also:

Constant Field Values

MAX

public static final String MAX

Label for the attribute; The maximum limit of the series.

Supported API: true

See Also:

Constant Field Values

DELTA

protected static final String DELTA

Label for the attribute; The increment between adjacent values within the series.

Supported API: true

See Also:

Constant Field Values

Method Detail

getMin

public static Integer getMin()

Gets the value of the attribute: MIN. The minimum limit of the series.

Supported API: true

Returns:

Integer

setMin

protected static void setMin(Integer a_Min)
                      throws WTPropertyVetoException

Sets the value of the attribute: MIN. The minimum limit of the series.

Supported API: true

Parameters:

a_Min -

Throws:

WTPropertyVetoException

getMax

public static Integer getMax()

Gets the value of the attribute: MAX. The maximum limit of the series.

Supported API: true

Returns:

Integer

setMax

protected static void setMax(Integer a_Max)
                      throws WTPropertyVetoException

Sets the value of the attribute: MAX. The maximum limit of the series.

Supported API: true

Parameters:

a_Max -

Throws:

WTPropertyVetoException

getDelta

protected static Integer getDelta()

Gets the value of the attribute: DELTA. The increment between adjacent values within the series.

Supported API: true

Returns:

Integer

setDelta

protected static void setDelta(Integer a_Delta)
                        throws WTPropertyVetoException

Sets the value of the attribute: DELTA. The increment between adjacent values within the series.

Supported API: true

Parameters:

a_Delta -

Throws:

WTPropertyVetoException

newIntegerSeries

public static IntegerSeries newIntegerSeries()
                                      throws WTPropertyVetoException

Makes a new instance.

Supported API: true

Returns:

IntegerSeries

Throws:

WTPropertyVetoException

newIntegerSeries

public static IntegerSeries newIntegerSeries(Integer value)
                                      throws WTPropertyVetoException

Makes a new instance where the value is set to the given integer.

Supported API: true

Parameters:

value -

Returns:

IntegerSeries

Throws:

WTPropertyVetoException

initialize

protected void initialize(Integer value)
                   throws WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

value -

Throws:

WTPropertyVetoException

reset

public void reset()
           throws SeriesException,
                  WTPropertyVetoException

Resets the value of the series to its min.

Supported API: true

Specified by:

reset in class Series

Throws:

SeriesException

WTPropertyVetoException

increment

public void increment()
               throws SeriesException,
                      WTPropertyVetoException

Increments the value of the series to the next adjacent value.

Supported API: true

Specified by:

increment in class Series

Throws:

SeriesException

WTPropertyVetoException

decrement

public void decrement()
               throws SeriesException,
                      WTPropertyVetoException

Decrements the value of the series to the next adjacent value.

Supported API: true

Specified by:

decrement in class Series

Throws:

SeriesException

WTPropertyVetoException

equals

public boolean equals(Series object)

Tests if the value of this series is equal to the given one and returns true. Otherwise, returns false.

Supported API: true

Specified by:

equals in class Series

Parameters:

object -

Returns:

boolean

lessThan

public boolean lessThan(Series object)

Tests if the value of this series is less than to the given one and returns true. Otherwise, returns false.

Supported API: true

Specified by:

lessThan in class Series

Parameters:

object -

Returns:

boolean

greaterThan

public boolean greaterThan(Series object)

Tests if the value of this series is greater than to the given one and returns true. Otherwise, returns false.

Supported API: true

Specified by:

greaterThan in class Series

Parameters:

object -

Returns:

boolean

getValue

public String getValue()

Overrides super class' getter to specifically deal with an integer value stored as a string.

Supported API: true

Overrides:

getValue in class Series

Returns:

String

setValue

protected void setValue(String aValue)
                 throws WTPropertyVetoException

Overrides super class' setter to specifically deal with an integer value stored as a string.

Supported API: true

Overrides:

setValue in class Series

Parameters:

aValue -

Throws:

WTPropertyVetoException

getIntegerValue

protected Integer getIntegerValue()

Gets the integer value of the series.

Supported API: true

Returns:

Integer

setIntegerValue

protected void setIntegerValue(Integer aValue)
                        throws WTPropertyVetoException

Sets the integer value of the series.

Supported API: true

Parameters:

aValue -

Throws:

WTPropertyVetoException

initialize

protected void initialize()
                   throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException