wt.vc.config
Class BaselineConfigSpec

java.lang.Object
  wt.vc.config.BaselineConfigSpec

All Implemented Interfaces:

ConfigSpec, Externalizable, NetFactor, ObjectMappable, Serializable, SQLFunctionConfigSpec

public class BaselineConfigSpec

extends Object

implements ConfigSpec, ObjectMappable, SQLFunctionConfigSpec, Externalizable

The BaselineConfigSpec can be applied to Baselineables to filter those elements based on membership in a baseline. Only Baselineable elements in the specified baseline are returned.

Use the newBaselineConfigSpec static factory method(s), not the BaselineConfigSpec 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:

Baselineable, Serialized Form

Field Summary

static String	BASELINE Label for the attribute; The baseline to filter against when this ConfigSpec is applied.
private static Class	BASELINE_MEMBER_LINK
private static String	BASELINE_ROLE
private static String	BASELINEABLE_ROLE
private ObjectReference	baselineRef
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private static String	ID
private static String	MASTER_OID
private static String	OBJECT_IDENTIFIER
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SQL_FUNCTION_ENABLED Label for the attribute.
private boolean	sqlFunctionEnabled

Constructor Summary

BaselineConfigSpec()

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends a "baseline = getBaseline()" to the QuerySpec, indicating that all iterations must belong to the baseline.
StatementParameter[]	getAdditionalParameters() Supported API: false
Baseline	getBaseline() Gets the value of the attribute: BASELINE.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
String	getSQLFunctionName() Supported API: false
protected void	initialize(Baseline baseline) Supports initialization, following construction of an instance.
boolean	isSqlFunctionEnabled() Gets the value of the attribute: SQL_FUNCTION_ENABLED.
static BaselineConfigSpec	newBaselineConfigSpec(Baseline baseline) Constructs a new BaselineConfigSpec using the specified baseline.
QueryResult	process(QueryResult results) Returns a clone of the results.
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(BaselineConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setBaseline(Baseline a_Baseline) Sets the value of the attribute: BASELINE.
void	setSqlFunctionEnabled(boolean a_SqlFunctionEnabled) Sets the value of the attribute: SQL_FUNCTION_ENABLED.
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.
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

BASELINE

public static final String BASELINE

Label for the attribute; The baseline to filter against when this ConfigSpec is applied. It can not be null.

Supported API: true

See Also:

Constant Field Values

baselineRef

private ObjectReference baselineRef

SQL_FUNCTION_ENABLED

public static final String SQL_FUNCTION_ENABLED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

sqlFunctionEnabled

private boolean sqlFunctionEnabled

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

BASELINE_MEMBER_LINK

private static final Class BASELINE_MEMBER_LINK

BASELINE_ROLE

private static final String BASELINE_ROLE

See Also:

Constant Field Values

BASELINEABLE_ROLE

private static final String BASELINEABLE_ROLE

See Also:

Constant Field Values

MASTER_OID

private static final String MASTER_OID

See Also:

Constant Field Values

OBJECT_IDENTIFIER

private static final String OBJECT_IDENTIFIER

See Also:

Constant Field Values

ID

private static final String ID

See Also:

Constant Field Values

Constructor Detail

BaselineConfigSpec

public BaselineConfigSpec()

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

getBaseline

public Baseline getBaseline()
                     throws ObjectNoLongerExistsException

Gets the value of the attribute: BASELINE. The baseline to filter against when this ConfigSpec is applied. It can not be null.

Supported API: true

Returns:

Baseline

Throws:

ObjectNoLongerExistsException

setBaseline

public void setBaseline(Baseline a_Baseline)
                 throws WTPropertyVetoException

Sets the value of the attribute: BASELINE. The baseline to filter against when this ConfigSpec is applied. It can not be null.

Supported API: true

Parameters:

a_Baseline -

Throws:

WTPropertyVetoException

isSqlFunctionEnabled

public boolean isSqlFunctionEnabled()

Gets the value of the attribute: SQL_FUNCTION_ENABLED.

Supported API: false

Returns:

boolean

setSqlFunctionEnabled

public void setSqlFunctionEnabled(boolean a_SqlFunctionEnabled)
                           throws WTPropertyVetoException

Sets the value of the attribute: SQL_FUNCTION_ENABLED.

Supported API: false

Parameters:

a_SqlFunctionEnabled -

Throws:

WTPropertyVetoException

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Appends a "baseline = getBaseline()" to the QuerySpec, indicating that all iterations must belong to the baseline.

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

Returns a clone of the results. No processing is done: it is expected that the results have already been pre-filtered by the search.

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

newBaselineConfigSpec

public static BaselineConfigSpec newBaselineConfigSpec(Baseline baseline)
                                                throws WTPropertyVetoException

Constructs a new BaselineConfigSpec using the specified baseline.

Supported API: true

Parameters:

baseline -

Returns:

BaselineConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(Baseline baseline)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

baseline -

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[]