Package wt.series
Class IntegerSeries
java.lang.Object
wt.series._Series
wt.series.Series
wt.series._IntegerSeries
wt.series.IntegerSeries
- All Implemented Interfaces:
Externalizable,Serializable,Cloneable,wt.fc._NetFactor,wt.fc._ObjectMappable,NetFactor,ObjectMappable
@GenAsObjectMappable(superClass=Series.class,
extendable=true,
properties=@GeneratedProperty(name="seriesName",type=java.lang.String.class,accessors=@PropertyAccessors(setAccess=PRIVATE),columnProperties=@ColumnProperties(persistent=false)))
public class IntegerSeries
extends wt.series._IntegerSeries
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:
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoidDecrements the value of the series to the next adjacent value.booleanTests if the value of this series is equal to the given one and returns true.protected static IntegergetDelta()Gets the value of the attribute: DELTA.protected IntegerGets the integer value of the series.static IntegergetMax()Gets the value of the attribute: MAX.static IntegergetMin()Gets the value of the attribute: MIN.getValue()Overrides super class' getter to specifically deal with an integer value stored as a string.booleangreaterThan(Series object) Tests if the value of this series is greater than to the given one and returns true.voidIncrements the value of the series to the next adjacent value.protected void
Supported API: trueprotected voidinitialize(Integer value) Supports initialization, following construction of an instance.protected voidinitialize(String seriesName, Integer value) Supports initialization, following construction of an instance.protected voidinitialize(String seriesName, String value) Supports initialization, following construction of an instance.booleanTests if the value of this series is less than to the given one and returns true.static IntegerSeriesMakes a new instance.static IntegerSeriesnewIntegerSeries(Integer value) Makes a new instance where the value is set to the given integer.static IntegerSeriesnewIntegerSeries(String seriesName, Integer value) Makes a new instance where the value is set to the given string.static IntegerSeriesnewIntegerSeries(String seriesName, String value) Makes a new instance where the value is set to the given string.voidreset()Resets the value of the series to its min.protected static voidSets the value of the attribute: DELTA.protected voidsetIntegerValue(Integer aValue) Sets the integer value of the series.protected static voidSets the value of the attribute: MAX.protected static voidSets the value of the attribute: MIN.protected voidOverrides super class' setter to specifically deal with an integer value stored as a string.
-
Method Details
-
getMin
Gets the value of the attribute: MIN. The minimum limit of the series.
Supported API: true- Returns:
- Integer
-
setMin
Sets the value of the attribute: MIN. The minimum limit of the series.
Supported API: true- Parameters:
a_Min-- Throws:
WTPropertyVetoException
-
getMax
Gets the value of the attribute: MAX. The maximum limit of the series.
Supported API: true- Returns:
- Integer
-
setMax
Sets the value of the attribute: MAX. The maximum limit of the series.
Supported API: true- Parameters:
a_Max-- Throws:
WTPropertyVetoException
-
getDelta
Gets the value of the attribute: DELTA. The increment between adjacent values within the series.
Supported API: true- Returns:
- Integer
-
setDelta
Sets the value of the attribute: DELTA. The increment between adjacent values within the series.
Supported API: true- Parameters:
a_Delta-- Throws:
WTPropertyVetoException
-
newIntegerSeries
Makes a new instance.
Supported API: true- Returns:
- IntegerSeries
- Throws:
WTPropertyVetoException
-
newIntegerSeries
Makes a new instance where the value is set to the given integer.
Supported API: true- Parameters:
value-- Returns:
- IntegerSeries
- Throws:
WTPropertyVetoException
-
initialize
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.
Supported API: true- Parameters:
value-- Throws:
WTPropertyVetoException
-
reset
Resets the value of the series to its min.
Supported API: true- Specified by:
resetin classSeries- Throws:
SeriesExceptionWTPropertyVetoException
-
increment
Increments the value of the series to the next adjacent value.
Supported API: true- Specified by:
incrementin classSeries- Throws:
SeriesExceptionWTPropertyVetoException
-
decrement
Decrements the value of the series to the next adjacent value.
Supported API: true- Specified by:
decrementin classSeries- Throws:
SeriesExceptionWTPropertyVetoException
-
equals
Tests if the value of this series is equal to the given one and returns true. Otherwise, returns false.
Supported API: true -
lessThan
Tests if the value of this series is less than to the given one and returns true. Otherwise, returns false.
Supported API: true -
greaterThan
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:
greaterThanin classSeries- Parameters:
object-- Returns:
- boolean
-
getValue
Overrides super class' getter to specifically deal with an integer value stored as a string.
Supported API: true -
setValue
Overrides super class' setter to specifically deal with an integer value stored as a string.
Supported API: true- Overrides:
setValuein class_Series- Parameters:
aValue-- Throws:
WTPropertyVetoException- See Also:
-
getIntegerValue
Gets the integer value of the series.
Supported API: true- Returns:
- Integer
-
setIntegerValue
Sets the integer value of the series.
Supported API: true- Parameters:
aValue-- Throws:
WTPropertyVetoException
-
initialize
Supported API: true- Throws:
WTPropertyVetoException
-
newIntegerSeries
public static IntegerSeries newIntegerSeries(String seriesName, Integer value) throws WTPropertyVetoException Makes a new instance where the value is set to the given string.
Supported API: true- Parameters:
seriesName-value-- Returns:
- IntegerSeries
- Throws:
WTPropertyVetoException
-
newIntegerSeries
public static IntegerSeries newIntegerSeries(String seriesName, String value) throws WTPropertyVetoException Makes a new instance where the value is set to the given string.
Supported API: true- Parameters:
seriesName-value-- Returns:
- IntegerSeries
- Throws:
WTPropertyVetoException
-
initialize
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.
Supported API: true- Parameters:
seriesName-value-- Throws:
WTPropertyVetoException
-
initialize
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.
Supported API: true- Parameters:
seriesName-value-- Throws:
WTPropertyVetoException
-