wt.epm.workspaces
Class WorkspaceConfigSpec

java.lang.Object
  wt.epm.workspaces.WorkspaceConfigSpec

All Implemented Interfaces:

ConfigSpec, Externalizable, Serializable

public class WorkspaceConfigSpec

extends Object

implements ConfigSpec, Externalizable

This config spec filters objects based on its checkout info and its workspace checkpoint. Only objects that are either not working or working and in its workspace checkpoint are returned.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private EPMCheckpoint	checkpoint
private static String	CLASSNAME
private ConfigSpec	configSpec
private static String	EPMRESOURCE
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private HashMap	workingCopyCache
private EPMWorkspace	workspace

Constructor Summary

WorkspaceConfigSpec()


Supported API: false

WorkspaceConfigSpec(EPMWorkspace workspace, ConfigSpec configSpec)


Supported API: false

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.
private void	configSpecValidate(ConfigSpec a_ConfigSpec)
private ObjectVector	filterWorkingCopies(ObjectVector filtered, List workingCopies)
ConfigSpec	getConfigSpec() Gets the value of the attribute: configSpec.
private Object	getKey(Persistable p)
EPMWorkspace	getWorkspace() Gets the value of the attribute: workspace.
private Boolean	inCheckpoint(Workable workingCopy)
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(WorkspaceConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private boolean	sameBaseline()
void	setConfigSpec(ConfigSpec a_ConfigSpec) Sets the value of the attribute: configSpec.
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, toString, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

workspace

private EPMWorkspace workspace

configSpec

private ConfigSpec configSpec

checkpoint

private EPMCheckpoint checkpoint

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

EPMRESOURCE

private static final String EPMRESOURCE

See Also:

Constant Field Values

workingCopyCache

private HashMap workingCopyCache

Constructor Detail

WorkspaceConfigSpec

public WorkspaceConfigSpec(EPMWorkspace workspace,
                           ConfigSpec configSpec)
                    throws WTException

Supported API: false

Parameters:

workspace -

configSpec -

Throws:

WTException

WorkspaceConfigSpec

public WorkspaceConfigSpec()

Supported API: false

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

getWorkspace

public EPMWorkspace getWorkspace()

Gets the value of the attribute: workspace.

Supported API: false

Returns:

EPMWorkspace

getConfigSpec

public ConfigSpec getConfigSpec()

Gets the value of the attribute: configSpec.

Supported API: false

Returns:

ConfigSpec

setConfigSpec

public void setConfigSpec(ConfigSpec a_ConfigSpec)
                   throws WTPropertyVetoException

Sets the value of the attribute: configSpec.

Supported API: false

Parameters:

a_ConfigSpec -

Throws:

WTPropertyVetoException

configSpecValidate

private void configSpecValidate(ConfigSpec a_ConfigSpec)
                         throws WTPropertyVetoException

Parameters:

a_ConfigSpec -

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

getKey

private Object getKey(Persistable p)
               throws WTException

Throws:

WTException

inCheckpoint

private Boolean inCheckpoint(Workable workingCopy)
                      throws WTException

Throws:

WTException

filterWorkingCopies

private ObjectVector filterWorkingCopies(ObjectVector filtered,
                                         List workingCopies)
                                  throws WTException

Throws:

WTException

sameBaseline

private boolean sameBaseline()
                      throws WTException

Throws:

WTException