wt.configuration
Class SerialNumberedConfiguredInstanceConfigSpec

java.lang.Object
  wt.configuration.SerialNumberedConfiguredInstanceConfigSpec

All Implemented Interfaces:

ConfigSpec, Externalizable, NetFactor, Serializable, SQLFunctionConfigSpec

public class SerialNumberedConfiguredInstanceConfigSpec

extends Object

implements SQLFunctionConfigSpec, NetFactor, Externalizable

The config spec used by SerialNumberedConfiguredInstanceVersion objects. This config spec will use the configuration to navigate the ConfigurationManageable elements and the date/planningDate to resolve versions of instances mapped (allocated) by this instance. To further traverse those mapped instances, create a new config spec for them.

Use the newSerialNumberedConfiguredInstanceConfigSpec static factory method(s), not the SerialNumberedConfiguredInstanceConfigSpec 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
private Timestamp	date
static String	DATE Label for the attribute.
static long	EXTERNALIZATION_VERSION_UID
private SerialNumberedConfiguredInstanceVersion	instance
static String	INSTANCE Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
static String	PLANNING_DATE Label for the attribute.
private boolean	planningDate
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

SerialNumberedConfiguredInstanceConfigSpec()

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends to the supplied QuerySpec additional search criteria to reduce the resulting iterations to only those that will be considered by this ConfigSpec.
StatementParameter[]	getAdditionalParameters() Supported API: false
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
Timestamp	getDate() Gets the value of the attribute: DATE.
SerialNumberedConfiguredInstanceVersion	getInstance() Gets the value of the attribute: INSTANCE.
String	getSQLFunctionName() Supported API: false
protected void	initialize(SerialNumberedConfiguredInstanceVersion instance, Timestamp date, boolean planningDate) Supports initialization, following construction of an instance.
private void	instanceValidate(SerialNumberedConfiguredInstanceVersion a_Instance)
boolean	isPlanningDate() Gets the value of the attribute: PLANNING_DATE.
static SerialNumberedConfiguredInstanceConfigSpec	newSerialNumberedConfiguredInstanceConfigSpec(SerialNumberedConfiguredInstanceVersion instance, Timestamp date, boolean planningDate) Supported API: true
QueryResult	process(QueryResult results) Process the QueryResult of iterations, returning only those that "match" according to the algorithm.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
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(SerialNumberedConfiguredInstanceConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDate(Timestamp a_Date) Sets the value of the attribute: DATE.
void	setInstance(SerialNumberedConfiguredInstanceVersion a_Instance) Sets the value of the attribute: INSTANCE.
void	setPlanningDate(boolean a_PlanningDate) Sets the value of the attribute: PLANNING_DATE.
String	toString() Returns the conceptual (modeled) name for the class.
boolean	useFunction() Supported API: false
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

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

INSTANCE

public static final String INSTANCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

instance

private SerialNumberedConfiguredInstanceVersion instance

DATE

public static final String DATE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

date

private Timestamp date

PLANNING_DATE

public static final String PLANNING_DATE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

planningDate

private boolean planningDate

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

SerialNumberedConfiguredInstanceConfigSpec

public SerialNumberedConfiguredInstanceConfigSpec()

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

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

getInstance

public SerialNumberedConfiguredInstanceVersion getInstance()

Gets the value of the attribute: INSTANCE.

Supported API: true

Returns:

SerialNumberedConfiguredInstanceVersion

setInstance

public void setInstance(SerialNumberedConfiguredInstanceVersion a_Instance)
                 throws WTPropertyVetoException

Sets the value of the attribute: INSTANCE.

Supported API: true

Parameters:

a_Instance -

Throws:

WTPropertyVetoException

instanceValidate

private void instanceValidate(SerialNumberedConfiguredInstanceVersion a_Instance)
                       throws WTPropertyVetoException

Parameters:

a_Instance -

Throws:

WTPropertyVetoException

getDate

public Timestamp getDate()

Gets the value of the attribute: DATE.

Supported API: true

Returns:

Timestamp

setDate

public void setDate(Timestamp a_Date)
             throws WTPropertyVetoException

Sets the value of the attribute: DATE.

Supported API: true

Parameters:

a_Date -

Throws:

WTPropertyVetoException

isPlanningDate

public boolean isPlanningDate()

Gets the value of the attribute: PLANNING_DATE.

Supported API: true

Returns:

boolean

setPlanningDate

public void setPlanningDate(boolean a_PlanningDate)
                     throws WTPropertyVetoException

Sets the value of the attribute: PLANNING_DATE.

Supported API: true

Parameters:

a_PlanningDate -

Throws:

WTPropertyVetoException

newSerialNumberedConfiguredInstanceConfigSpec

public static SerialNumberedConfiguredInstanceConfigSpec newSerialNumberedConfiguredInstanceConfigSpec(SerialNumberedConfiguredInstanceVersion instance,
                                                                                                       Timestamp date,
                                                                                                       boolean planningDate)
                                                                                                throws WTPropertyVetoException

Supported API: true

Parameters:

instance -

date -

planningDate -

Returns:

SerialNumberedConfiguredInstanceConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(SerialNumberedConfiguredInstanceVersion instance,
                          Timestamp date,
                          boolean planningDate)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

instance -

date -

planningDate -

Throws:

WTPropertyVetoException

useFunction

public boolean useFunction()

Supported API: false

Specified by:

useFunction in interface SQLFunctionConfigSpec

Returns:

boolean

getSQLFunctionName

public String getSQLFunctionName()

Supported API: false

Specified by:

getSQLFunctionName in interface SQLFunctionConfigSpec

Returns:

String

getAdditionalParameters

public StatementParameter[] getAdditionalParameters()

Supported API: false

Specified by:

getAdditionalParameters in interface SQLFunctionConfigSpec

Returns:

StatementParameter[]

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Appends to the supplied QuerySpec additional search criteria to reduce the resulting iterations to only those that will be considered by this ConfigSpec. Appending additional classes to the QuerySpec is allowed (for join purposes), but those that are marked as selectable will be trimmed by "filteredIterationsOf" prior to it calling the "process" API.

The QueryResult returned should be a copy of the passed in one (taking advantage of side-effects is not encouraged).

Supported API: true

Specified by:

appendSearchCriteria in interface ConfigSpec

Parameters:

querySpec - A QuerySpec with a target class that is Iterated.

Returns:

QuerySpec

Throws:

WTException

QueryException

See Also:

QuerySpec, SearchCondition

process

public QueryResult process(QueryResult results)
                    throws WTException

Process the QueryResult of iterations, returning only those that "match" according to the algorithm.

The QueryResult returned should be a copy of the passed-in QueryResult (side-effects should be avoided).

Supported API: true

Specified by:

process in interface ConfigSpec

Parameters:

results - QueryResult of iterations to filter. Assumed to be the result of a query that included the additional search conditions applied by appendSearchCriteria. Note that after enumerating through the elements of this QueryResult, it should be reset.

Returns:

QueryResult

Throws:

WTException

See Also:

QueryResult, Iterated