wt.part
Class WTPartBaselineConfigSpec

java.lang.Object
  wt.part.WTPartBaselineConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable, ConfigSpec

public class WTPartBaselineConfigSpec
extends Object
implements ConfigSpec, ObjectMappable, Externalizable

This class implements a ConfigSpec to filter Iterations that belong to a Baseline.

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

static String

BASELINE Label for the attribute.

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.
Baseline	getBaseline() Gets the value of the attribute: BASELINE.
protected void	initialize(Baseline a_baseline) Supports initialization, following construction of an instance.
static WTPartBaselineConfigSpec	newWTPartBaselineConfigSpec(Baseline a_baseline) Supported API: true
QueryResult	process(QueryResult results) Process the QueryResult of iterations, returning only those that "match" according to the algorithm.
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.

Supported API: true

See Also:

Constant Field Values

Method Detail

getBaseline

public Baseline getBaseline()
                     throws ObjectNoLongerExistsException

Gets the value of the attribute: BASELINE.

Supported API: true

Returns:

Baseline

Throws:

ObjectNoLongerExistsException

setBaseline

public void setBaseline(Baseline a_Baseline)
                 throws WTPropertyVetoException

Sets the value of the attribute: BASELINE.

Supported API: true

Parameters:

a_Baseline -

Throws:

WTPropertyVetoException

newWTPartBaselineConfigSpec

public static WTPartBaselineConfigSpec newWTPartBaselineConfigSpec(Baseline a_baseline)
                                                            throws WTPropertyVetoException

Supported API: true

Parameters:

a_baseline -

Returns:

WTPartBaselineConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(Baseline a_baseline)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_baseline -

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