wt.series
Class FileBasedSeries

java.lang.Object
  wt.series.Series
      wt.series.FileBasedSeries

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, NetFactor, ObjectMappable

public class FileBasedSeries
extends Series
implements Externalizable

Defines a sequencing model based on an XML input file stored in the SeriesTemplate table.

Use the newFileBasedSeries static factory method(s), not the FileBasedSeries 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: false

See Also:

Serialized Form

Field Summary

Fields inherited from class wt.series.Series

VALUE

Method Summary

void	decrement() Specifies an abstract means of decrementing the value to the next adjacent descending value in a series.
boolean	equals(Series object) Tests if this series is equal to the given one and returns true.
boolean	greaterThan(Series object) Tests if this series is greater than to the given one and returns true.
void	increment() Specifies an abstract means of incrementing the value to the next adjacent ascending value in a series.
protected void	initialize(String series, String maturity) Supports initialization, following construction of an instance.
boolean	lessThan(Series object) Tests if this series is less than to the given one and returns true.
static FileBasedSeries	newFileBasedSeries(String series, String maturity) Makes a new instance where the value at the given series and maturity level is set to the given string.
void	reset() Specifies an abstract means of resetting the value to the first one in a series.

Methods inherited from class wt.series.Series

getValue, newSeries, newSeries, setValue

Methods inherited from class java.lang.Object

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

Method Detail

newFileBasedSeries

public static FileBasedSeries newFileBasedSeries(String series,
                                                 String maturity)
                                          throws SeriesException,
                                                 WTPropertyVetoException

Makes a new instance where the value at the given series and maturity level is set to the given string.

Supported API: true

Parameters:

series -

maturity -

Returns:

FileBasedSeries

Throws:

SeriesException

WTPropertyVetoException

initialize

protected void initialize(String series,
                          String maturity)
                   throws SeriesException,
                          WTPropertyVetoException

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

Supported API: true

Parameters:

series -

maturity -

Throws:

SeriesException

WTPropertyVetoException

reset

public void reset()
           throws SeriesException,
                  WTPropertyVetoException

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

Supported API: true

Specified by:

reset in class Series

Throws:

SeriesException

WTPropertyVetoException

increment

public 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

Specified by:

increment in class Series

Throws:

SeriesException

WTPropertyVetoException

decrement

public 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

Specified by:

decrement in class Series

Throws:

SeriesException

WTPropertyVetoException

equals

public boolean equals(Series object)

Tests if 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 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 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