wt.configuration
Class BaselineConfigurationConfigSpec

java.lang.Object
  wt.configuration.BaselineConfigurationConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ConfigSpec

public class BaselineConfigurationConfigSpec
extends Object
implements NetFactor, ConfigSpec, Externalizable

The config spec used by a BaselineConfigurationVersion to traverse its structure.

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

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.
BaselineConfigurationVersion	getConfiguration() Gets the value of the attribute: configuration.
protected void	initialize(BaselineConfigurationVersion configuration) Supports initialization, following construction of an instance.
static BaselineConfigurationConfigSpec	newBaselineConfigurationConfigSpec(BaselineConfigurationVersion configuration) Supported API: true
QueryResult	process(QueryResult results) Process the QueryResult of iterations, returning only those that "match" according to the algorithm.
void	setConfiguration(BaselineConfigurationVersion a_Configuration) Sets the value of the attribute: configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getConfiguration

public BaselineConfigurationVersion getConfiguration()

Gets the value of the attribute: configuration.

Supported API: true

Returns:

BaselineConfigurationVersion

setConfiguration

public void setConfiguration(BaselineConfigurationVersion a_Configuration)
                      throws WTPropertyVetoException

Sets the value of the attribute: configuration.

Supported API: true

Parameters:

a_Configuration -

Throws:

WTPropertyVetoException

newBaselineConfigurationConfigSpec

public static BaselineConfigurationConfigSpec newBaselineConfigurationConfigSpec(BaselineConfigurationVersion configuration)
                                                                          throws WTPropertyVetoException

Supported API: true

Parameters:

configuration -

Returns:

BaselineConfigurationConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(BaselineConfigurationVersion configuration)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

configuration -

Throws:

WTPropertyVetoException

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