wt.vc.config
Class BaselineConfigSpec

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

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable, ConfigSpec

public class BaselineConfigSpec
extends Object
implements ConfigSpec, ObjectMappable, 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.

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends a "baseline = getBaseline()" to the QuerySpec, indicating that all iterations must belong to the baseline.
Baseline	getBaseline() Gets the value of the attribute: BASELINE.
protected void	initialize(Baseline baseline) Supports initialization, following construction of an instance.
static BaselineConfigSpec	newBaselineConfigSpec(Baseline baseline) Constructs a new BaselineConfigSpec using the specified baseline.
QueryResult	process(QueryResult results) Returns a clone of the results.
void	setBaseline(Baseline a_Baseline) Sets the value of the attribute: BASELINE.

Methods inherited from class java.lang.Object

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

Field Detail

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

Method Detail

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

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