wt.series
Class HarvardSeries

java.lang.Object
  wt.series.Series
      wt.series.MultilevelSeries
          wt.series.HarvardSeries

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, NetFactor, ObjectMappable

public class HarvardSeries
extends MultilevelSeries
implements Externalizable

Defines a sequencing model of another subclassed series separated by a delimiter. In the classic definition a harvard series is like 1, 1.1, 1.1.1, etc.

This harvard series can contain any other predefined subclassed series. For example, a harvard series could be like A, A.A, A.A.A, etc.

Use the newHarvardSeries static factory method(s), not the HarvardSeries 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

static String

DELIMITER Label for the attribute; The delimiter that separates to adjacent subvalues within the series.

Fields inherited from class wt.series.MultilevelSeries

DEPTH, LEVEL, SUBSERIES

Fields inherited from class wt.series.Series

VALUE

Method Summary

void	decrement() Decrements the subvalue at the current level within the series to the next adjacent value.
boolean	equals(Series object) Tests if the subvalue at the current level within this series is equal to the subvalue at the current level within given one and returns true.
static Character	getDelimiter() Gets the value of the attribute: DELIMITER.
Series	getSubvalue() Gets the subvalue at the current level within the series.
boolean	greaterThan(Series object) Tests if the subvalue at the current level within this series is greater than to the subvalue at the current level within given one and returns true.
void	increment() Increments the subvalue at the current level within the series to the next adjacent value.
protected void	initialize() Supported API: true
protected void	initialize(Series[] values) Supports initialization, following construction of an instance.
protected void	initialize(String seriesName, Series[] values) Supports initialization, following construction of an instance.
boolean	lessThan(Series object) Tests if the subvalue at the current level within this series is less than to the subvalue at the current level within given one and returns true.
static HarvardSeries	newHarvardSeries() Makes a new instance.
static HarvardSeries	newHarvardSeries(Series[] values) Makes a new instance where the value is set to the given array of series.
static HarvardSeries	newHarvardSeries(String seriesName, Series[] values) Makes a new instance where the value is set to the given array of series.
void	reset() Resets the subvalue at the current level within the series to its min.
protected static void	setDelimiter(Character a_Delimiter) Sets the value of the attribute: DELIMITER.
void	setSubvalue(Series aValue) Sets the subvalue at the current level within the series.
void	toLeft() Moves the current level one to the left.
void	toRight() Moves the current level one to the right.

Methods inherited from class wt.series.MultilevelSeries

getDepth, getLevel, getSubseries, newMultilevelSeries, newMultilevelSeries, newMultilevelSeries, setDepth, setLevel, setSubseries, setValueWithValidation

Methods inherited from class wt.series.Series

getValue, newSeries, newSeries

Methods inherited from class java.lang.Object

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

Field Detail

DELIMITER

public static final String DELIMITER

Label for the attribute; The delimiter that separates to adjacent subvalues within the series.

Supported API: true

See Also:

Constant Field Values

Method Detail

getDelimiter

public static Character getDelimiter()

Gets the value of the attribute: DELIMITER. The delimiter that separates to adjacent subvalues within the series.

Supported API: true

Returns:

Character

setDelimiter

protected static void setDelimiter(Character a_Delimiter)
                            throws WTPropertyVetoException

Sets the value of the attribute: DELIMITER. The delimiter that separates to adjacent subvalues within the series.

Supported API: true

Parameters:

a_Delimiter -

Throws:

WTPropertyVetoException

newHarvardSeries

public static HarvardSeries newHarvardSeries()
                                      throws SeriesException,
                                             WTPropertyVetoException

Makes a new instance.

Supported API: true

Returns:

HarvardSeries

Throws:

SeriesException

WTPropertyVetoException

newHarvardSeries

public static HarvardSeries newHarvardSeries(Series[] values)
                                      throws SeriesException,
                                             WTPropertyVetoException

Makes a new instance where the value is set to the given array of series.

Supported API: true

Parameters:

values -

Returns:

HarvardSeries

Throws:

SeriesException

WTPropertyVetoException

initialize

protected void initialize(Series[] values)
                   throws SeriesException,
                          WTPropertyVetoException

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

Supported API: true

Parameters:

values -

Throws:

SeriesException

WTPropertyVetoException

reset

public void reset()
           throws SeriesException,
                  WTPropertyVetoException

Resets the subvalue at the current level within the series to its min.

Supported API: true

Overrides:

reset in class MultilevelSeries

Throws:

SeriesException

WTPropertyVetoException

increment

public void increment()
               throws SeriesException,
                      WTPropertyVetoException

Increments the subvalue at the current level within the series to the next adjacent value.

Supported API: true

Overrides:

increment in class MultilevelSeries

Throws:

SeriesException

WTPropertyVetoException

decrement

public void decrement()
               throws SeriesException,
                      WTPropertyVetoException

Decrements the subvalue at the current level within the series to the next adjacent value.

Supported API: true

Overrides:

decrement in class MultilevelSeries

Throws:

SeriesException

WTPropertyVetoException

equals

public boolean equals(Series object)

Tests if the subvalue at the current level within this series is equal to the subvalue at the current level within given one and returns true. Otherwise, returns false.

Supported API: true

Overrides:

equals in class MultilevelSeries

Parameters:

object -

Returns:

boolean

lessThan

public boolean lessThan(Series object)

Tests if the subvalue at the current level within this series is less than to the subvalue at the current level within given one and returns true. Otherwise, returns false.

Supported API: true

Overrides:

lessThan in class MultilevelSeries

Parameters:

object -

Returns:

boolean

greaterThan

public boolean greaterThan(Series object)

Tests if the subvalue at the current level within this series is greater than to the subvalue at the current level within given one and returns true. Otherwise, returns false.

Supported API: true

Overrides:

greaterThan in class MultilevelSeries

Parameters:

object -

Returns:

boolean

toLeft

public void toLeft()
            throws SeriesException,
                   WTPropertyVetoException

Moves the current level one to the left.

Supported API: true

Overrides:

toLeft in class MultilevelSeries

Throws:

SeriesException

WTPropertyVetoException

toRight

public void toRight()
             throws SeriesException,
                    WTPropertyVetoException

Moves the current level one to the right.

Supported API: true

Overrides:

toRight in class MultilevelSeries

Throws:

SeriesException

WTPropertyVetoException

getSubvalue

public Series getSubvalue()
                   throws SeriesException,
                          WTPropertyVetoException

Gets the subvalue at the current level within the series.

Supported API: true

Overrides:

getSubvalue in class MultilevelSeries

Returns:

Series

Throws:

SeriesException

WTPropertyVetoException

setSubvalue

public void setSubvalue(Series aValue)
                 throws WTPropertyVetoException

Sets the subvalue at the current level within the series.

Supported API: true

Overrides:

setSubvalue in class MultilevelSeries

Parameters:

aValue -

Throws:

WTPropertyVetoException

initialize

protected void initialize()
                   throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

newHarvardSeries

public static HarvardSeries newHarvardSeries(String seriesName,
                                             Series[] values)
                                      throws SeriesException,
                                             WTPropertyVetoException

Makes a new instance where the value is set to the given array of series.

Supported API: true

Parameters:

seriesName -

values -

Returns:

HarvardSeries

Throws:

SeriesException

WTPropertyVetoException

initialize

protected void initialize(String seriesName,
                          Series[] values)
                   throws SeriesException,
                          WTPropertyVetoException

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

Supported API: true

Parameters:

seriesName -

values -

Throws:

SeriesException

WTPropertyVetoException