wt.series
Class Series

java.lang.Object
  wt.series.Series

All Implemented Interfaces:

Cloneable, Externalizable, NetFactor, ObjectMappable, Serializable

Direct Known Subclasses:

FileBasedSeries, IntegerSeries, MulticharacterSeries, MultilevelSeries

public abstract class Series

extends Object

implements ObjectMappable, Cloneable, Externalizable

Specifies an abstract model of items in a predefined sequence. This model has a value, ways to iterate through the sequence, and comparison tests between two values of the same sequence.

The idea is to subclass this abstract class to define a particular kind of series. For example, a simple specialized series would be whole integer numbers where there would be a predefined minimum value, maximum value, and an increment or safe delta between to adjacent numbers.

Supported API: true

Extendable: true

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private String	value
static String	VALUE Label for the attribute; The current value of an increment in the series.
private static int	VALUE_UPPER_LIMIT

Constructor Summary

Series()

Method Summary

Object	clone()
abstract void	decrement() Specifies an abstract means of decrementing the value to the next adjacent descending value in a series.
abstract boolean	equals(Series object) Tests if this series is equal to the given one and returns true.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getValue() Gets the value of the attribute: VALUE.
abstract boolean	greaterThan(Series object) Tests if this series is greater than to the given one and returns true.
abstract void	increment() Specifies an abstract means of incrementing the value to the next adjacent ascending value in a series.
abstract boolean	lessThan(Series object) Tests if this series is less than to the given one and returns true.
static Series	newSeries(String userClassName) Makes a new instance of one of the subclassed series as defined in a property where the using class is paired with the series subclass.
static Series	newSeries(String userClassName, String value) Makes a new instance of one of the subclassed series as defined in a property where the using class is paired with the series subclass.
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(Series thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
abstract void	reset() Specifies an abstract means of resetting the value to the first one in a series.
protected void	setValue(String a_Value) Sets the value of the attribute: VALUE.
void	setValueWithoutValidating(String a_Value) Sets the series value without validating.
String	toString() Returns the conceptual (modeled) name for the class.
private void	valueValidate(String a_Value)
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 java.lang.Object

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

Methods inherited from interface wt.fc.NetFactor

getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

VALUE

public static final String VALUE

Label for the attribute; The current value of an increment in the series.

Supported API: true

See Also:

Constant Field Values

VALUE_UPPER_LIMIT

private static int VALUE_UPPER_LIMIT

value

private String value

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

Series

public Series()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(Series 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

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

Parameters:

input -

Throws:

SQLException

DatastoreException

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getValue

public String getValue()

Gets the value of the attribute: VALUE. The current value of an increment in the series.

Supported API: true

Returns:

String

setValue

protected void setValue(String a_Value)
                 throws WTPropertyVetoException

Sets the value of the attribute: VALUE. The current value of an increment in the series.

Supported API: true

Parameters:

a_Value -

Throws:

WTPropertyVetoException

valueValidate

private void valueValidate(String a_Value)
                    throws WTPropertyVetoException

Parameters:

a_Value -

Throws:

WTPropertyVetoException

newSeries

public static final Series newSeries(String userClassName)
                              throws SeriesException

Makes a new instance of one of the subclassed series as defined in a property where the using class is paired with the series subclass.

Supported API: true

Parameters:

userClassName -

Returns:

Series

Throws:

SeriesException

newSeries

public static final Series newSeries(String userClassName,
                                     String value)
                              throws SeriesException

Makes a new instance of one of the subclassed series as defined in a property where the using class is paired with the series subclass. Plus, the initial value of this new instance is set to the given value.

Supported API: true

Parameters:

userClassName -

value -

Returns:

Series

Throws:

SeriesException

reset

public abstract void reset()
                    throws SeriesException,
                           WTPropertyVetoException

Specifies an abstract means of resetting the value to the first one in a series.

Supported API: true

Throws:

SeriesException

WTPropertyVetoException

increment

public abstract void increment()
                        throws SeriesException,
                               WTPropertyVetoException

Specifies an abstract means of incrementing the value to the next adjacent ascending value in a series.

Supported API: true

Throws:

SeriesException

WTPropertyVetoException

decrement

public abstract void decrement()
                        throws SeriesException,
                               WTPropertyVetoException

Specifies an abstract means of decrementing the value to the next adjacent descending value in a series.

Supported API: true

Throws:

SeriesException

WTPropertyVetoException

equals

public abstract boolean equals(Series object)

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

Supported API: true

Parameters:

object -

Returns:

boolean

lessThan

public abstract boolean lessThan(Series object)

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

Supported API: true

Parameters:

object -

Returns:

boolean

greaterThan

public abstract boolean greaterThan(Series object)

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

Supported API: true

Parameters:

object -

Returns:

boolean

clone

public Object clone()
             throws CloneNotSupportedException

Throws:

CloneNotSupportedException

setValueWithoutValidating

public void setValueWithoutValidating(String a_Value)
                               throws WTPropertyVetoException

Sets the series value without validating.

Supported API: false

Parameters:

a_Value -

Throws:

WTPropertyVetoException