wt.vc
Class IterationIdentifier

java.lang.Object
  wt.vc.IterationIdentifier

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Serializable

public class IterationIdentifier

extends Object

implements ObjectMappable, Externalizable

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

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private static int	ITERATION_ID_UPPER_LIMIT
private String	iterationId
static String	ITERATIONID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private Series	series
static String	SERIES Label for the attribute.

Constructor Summary

IterationIdentifier()

Method Summary

ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
Series	getSeries() Supported API: true
String	getValue() Gets the aggregated series' value and returns it as a string.
protected void	initialize() Supported API: true
protected void	initialize(Series value) Supported API: true
protected void	initialize(String number) Supports initialization, following construction of an instance.
static IterationIdentifier	newIterationIdentifier() Supported API: true
static IterationIdentifier	newIterationIdentifier(Series value) Supported API: true
static IterationIdentifier	newIterationIdentifier(String number) Supported API: true
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(IterationIdentifier thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
String	toString() Returns the conceptual (modeled) name for the class.
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

clone, 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

ITERATION_ID_UPPER_LIMIT

private static int ITERATION_ID_UPPER_LIMIT

iterationId

private String iterationId

SERIES

public static final String SERIES

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

series

private Series series

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

ITERATIONID

public static final String ITERATIONID

See Also:

Constant Field Values

Constructor Detail

IterationIdentifier

public IterationIdentifier()

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(IterationIdentifier 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

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

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

newIterationIdentifier

public static IterationIdentifier newIterationIdentifier()
                                                  throws WTException

Supported API: true

Returns:

IterationIdentifier

Throws:

WTException

newIterationIdentifier

public static IterationIdentifier newIterationIdentifier(Series value)
                                                  throws WTException

Supported API: true

Parameters:

value -

Returns:

IterationIdentifier

Throws:

WTException

getSeries

public Series getSeries()
                 throws VersionControlException

Supported API: true

Returns:

Series

Throws:

VersionControlException

getValue

public String getValue()

Gets the aggregated series' value and returns it as a string.

Supported API: true

Returns:

String

initialize

protected void initialize()
                   throws WTException

Supported API: true

Throws:

WTException

initialize

protected void initialize(Series value)
                   throws WTException

Supported API: true

Parameters:

value -

Throws:

WTException

newIterationIdentifier

public static IterationIdentifier newIterationIdentifier(String number)
                                                  throws WTException

Supported API: true

Parameters:

number -

Returns:

IterationIdentifier

Throws:

WTException

initialize

protected void initialize(String number)
                   throws WTException

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

Supported API: true

Parameters:

number -

Throws:

WTException