wt.series
Class IntegerSeries

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

All Implemented Interfaces:

Cloneable, Externalizable, NetFactor, ObjectMappable, Serializable

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

private static String	CLASSNAME
private static Integer	delta
protected static String	DELTA Label for the attribute; The increment between adjacent values within the series.
static long	EXTERNALIZATION_VERSION_UID
private static Integer	max
static String	MAX Label for the attribute; The maximum limit of the series.
private static Integer	min
static String	MIN Label for the attribute; The minimum limit of the series.
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.series.Series

VALUE

Constructor Summary

IntegerSeries()

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.
String	getConceptualClassname() Deprecated.
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	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(IntegerSeries thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.series.Series

clone, getClassInfo, newSeries, newSeries, readVersion, setValueWithoutValidating, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

MIN

public static final String MIN

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

Supported API: true

See Also:

Constant Field Values

min

private static Integer min

MAX

public static final String MAX

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

Supported API: true

See Also:

Constant Field Values

max

private static Integer max

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

delta

private static Integer delta

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

IntegerSeries

public IntegerSeries()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class Series

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class Series

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(IntegerSeries thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class Series

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class Series

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

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