wt.series
Class MulticharacterSeries

java.lang.Object
  wt.series.Series
      wt.series.MulticharacterSeries

All Implemented Interfaces:

Cloneable, Externalizable, NetFactor, ObjectMappable, Serializable

public class MulticharacterSeries

extends Series

implements Externalizable

Defines a sequencing model of multicharacter values from one character up to a span of characters of length, where each single character ranges from min to max with an increment of delta between each adjacent value.

For example, this series could be a length of 3, with a min of A and a max of Z, and a delta of 1. With this the initial value would be A. The max value with the length would be ZZZ. When the series reached a value of Z and was incremented it would then be BA. When the series reached a value of AA and was decremented it would then be Z.

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

Nested Class Summary

private static class

MulticharacterSeries.SeriesProperties

Field Summary

private static String	CLASSNAME
private static String	DEFAULT
private static Integer	delta
protected static String	DELTA Label for the attribute; The increment between adjacent characters within the series.
static long	EXTERNALIZATION_VERSION_UID
private static Integer	length
protected static String	LENGTH Label for the attribute; The total length in characters that the series can grow.
private static Character	max
static String	MAX Label for the attribute; The maximum limit of a character within the series.
private static Character	min
static String	MIN Label for the attribute; The minimum limit of a character within the series.
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
private static String	SEED
(package private) static long	serialVersionUID
static String	SERIES_NAME Label for the attribute.
private static String	SERIES_NAMES
private static Hashtable	seriesMap
private String	seriesName
private static String	SKIP_LIST

Fields inherited from class wt.series.Series

VALUE

Constructor Summary

MulticharacterSeries()

Method Summary

protected Character	currCharAt(int pos) Determines the current character in the series.
void	decrement() Decrements the value of the series to the next adjacent value.
protected Character	decrementedCharAt(int pos) Determines the next decremented character of the character at the position in the series.
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 static Integer	getLength() Gets the value of the attribute: LENGTH.
static Character	getMax() Gets the value of the attribute: MAX.
static Character	getMin() Gets the value of the attribute: MIN.
Integer	getSeriesDelta()
Integer	getSeriesLength()
Character	getSeriesMax()
Character	getSeriesMin()
String	getSeriesName() Gets the value of the attribute: SERIES_NAME.
Character	getSeriesSeed()
String	getSeriesSkipList()
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 Character	incrementedCharAt(int pos) Determines the next incremented character of the character at the given position in the series.
protected void	initialize() Supported API: true
protected void	initialize(String value) Supports initialization, following construction of an instance.
protected void	initialize(String seriesName, String 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 MulticharacterSeries	newMulticharacterSeries() Makes a new instance.
static MulticharacterSeries	newMulticharacterSeries(String value) Makes a new instance where the value is set to the given string.
static MulticharacterSeries	newMulticharacterSeries(String seriesName, String value) Makes a new instance where the value is set to the given string.
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(MulticharacterSeries 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 static void	setLength(Integer a_Length) Sets the value of the attribute: LENGTH.
protected static void	setMax(Character a_Max) Sets the value of the attribute: MAX.
protected static void	setMin(Character 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.
private void	validateValue(String aValue)
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 a character within the series.

Supported API: true

See Also:

Constant Field Values

min

private static Character min

MAX

public static final String MAX

Label for the attribute; The maximum limit of a character within the series.

Supported API: true

See Also:

Constant Field Values

max

private static Character max

DELTA

protected static final String DELTA

Label for the attribute; The increment between adjacent characters within the series.

Supported API: true

See Also:

Constant Field Values

delta

private static Integer delta

LENGTH

protected static final String LENGTH

Label for the attribute; The total length in characters that the series can grow.

Supported API: true

See Also:

Constant Field Values

length

private static Integer length

SERIES_NAME

public static final String SERIES_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

seriesName

private String seriesName

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

seriesMap

private static Hashtable seriesMap

SERIES_NAMES

private static final String SERIES_NAMES

See Also:

Constant Field Values

DEFAULT

private static final String DEFAULT

See Also:

Constant Field Values

SEED

private static final String SEED

See Also:

Constant Field Values

SKIP_LIST

private static final String SKIP_LIST

See Also:

Constant Field Values

Constructor Detail

MulticharacterSeries

public MulticharacterSeries()

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(MulticharacterSeries 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 Character getMin()

Gets the value of the attribute: MIN. The minimum limit of a character within the series.

Supported API: true

Returns:

Character

setMin

protected static void setMin(Character a_Min)
                      throws WTPropertyVetoException

Sets the value of the attribute: MIN. The minimum limit of a character within the series.

Supported API: true

Parameters:

a_Min -

Throws:

WTPropertyVetoException

getMax

public static Character getMax()

Gets the value of the attribute: MAX. The maximum limit of a character within the series.

Supported API: true

Returns:

Character

setMax

protected static void setMax(Character a_Max)
                      throws WTPropertyVetoException

Sets the value of the attribute: MAX. The maximum limit of a character within 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 characters 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 characters within the series.

Supported API: true

Parameters:

a_Delta -

Throws:

WTPropertyVetoException

getLength

protected static Integer getLength()

Gets the value of the attribute: LENGTH. The total length in characters that the series can grow.

Supported API: true

Returns:

Integer

setLength

protected static void setLength(Integer a_Length)
                         throws WTPropertyVetoException

Sets the value of the attribute: LENGTH. The total length in characters that the series can grow.

Supported API: true

Parameters:

a_Length -

Throws:

WTPropertyVetoException

getSeriesName

public String getSeriesName()

Gets the value of the attribute: SERIES_NAME.

Supported API: false

Returns:

String

newMulticharacterSeries

public static MulticharacterSeries newMulticharacterSeries()
                                                    throws WTPropertyVetoException

Makes a new instance.

Supported API: true

Returns:

MulticharacterSeries

Throws:

WTPropertyVetoException

newMulticharacterSeries

public static MulticharacterSeries newMulticharacterSeries(String value)
                                                    throws WTPropertyVetoException

Makes a new instance where the value is set to the given string.

Supported API: true

Parameters:

value -

Returns:

MulticharacterSeries

Throws:

WTPropertyVetoException

initialize

protected void initialize(String 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

newMulticharacterSeries

public static MulticharacterSeries newMulticharacterSeries(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:

MulticharacterSeries

Throws:

WTPropertyVetoException

initialize

protected void initialize(String seriesName,
                          String value)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

seriesName -

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

currCharAt

protected Character currCharAt(int pos)

Determines the current character in the series.

Supported API: true

Parameters:

pos -

Returns:

Character

incrementedCharAt

protected Character incrementedCharAt(int pos)

Determines the next incremented character of the character at the given position in the series.

Supported API: true

Parameters:

pos -

Returns:

Character

decrementedCharAt

protected Character decrementedCharAt(int pos)

Determines the next decremented character of the character at the position in the series.

Supported API: true

Parameters:

pos -

Returns:

Character

initialize

protected void initialize()
                   throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

getSeriesMin

public Character getSeriesMin()

getSeriesMax

public Character getSeriesMax()

getSeriesSeed

public Character getSeriesSeed()

getSeriesSkipList

public String getSeriesSkipList()

getSeriesLength

public Integer getSeriesLength()

getSeriesDelta

public Integer getSeriesDelta()

validateValue

private void validateValue(String aValue)
                    throws WTPropertyVetoException

Throws:

WTPropertyVetoException