wt.epm.structure
Class NavigateCollectors.Iterations

java.lang.Object
  wt.epm.structure.NavigateCollectors.AbstractCollector
      wt.epm.structure.NavigateCollectors.Iterations

All Implemented Interfaces:

NavigateResultProcessor, ResultProcessor

Enclosing class:

NavigateCollectors

public static class NavigateCollectors.Iterations

extends NavigateCollectors.AbstractCollector

This NavigateResultProcessor processes iteration-to-master links. Using the config spec, it finds the appropriate iteration of each other-side master and adds it to a Collection or WTKeyedMap. Note: If the config spec does not select any iteration for a particular master, it adds the master instead.

Field Summary

private boolean	checkForDuplicates
private EPMCache.IterationCache	iterationSelector
private Set	queryKeys
private WTSet	visited

Fields inherited from class wt.epm.structure.NavigateCollectors.AbstractCollector

COLLECTION, INITIAL_SIZE, MAP, otherSideRole, results, resultType, reverse, role

Constructor Summary

NavigateCollectors.Iterations(ConfigSpec configSpec, Collection collection)
With this constructor, the class will add the config spec selected iterations of the other-side masters to the given Collection.

NavigateCollectors.Iterations(ConfigSpec configSpec, WTKeyedMap map, boolean reverse)
With this constructor, the class will add the config spec selected iterations of the other-side masters to the given WTKeyedMap.

Method Summary

void	addElement(Object object) Add the specified object to the result processor, and increase the size by one Supported API: false
void	processResults(WTCollection fromObjects) Post processes the results once all of the Binary links have been navigated.
void	selectWhatToReturn(Relationship relationship, QuerySpec querySpec) Specifies what objects or attributes to return when navigating a Binary link from one set of objects to another.

Methods inherited from class wt.epm.structure.NavigateCollectors.AbstractCollector

clearPreviousResults, createQueryKey, getResults, size

Methods inherited from class java.lang.Object

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

Field Detail

iterationSelector

private EPMCache.IterationCache iterationSelector

queryKeys

private Set queryKeys

checkForDuplicates

private boolean checkForDuplicates

visited

private WTSet visited

Constructor Detail

NavigateCollectors.Iterations

public NavigateCollectors.Iterations(ConfigSpec configSpec,
                                     Collection collection)

With this constructor, the class will add the config spec selected iterations of the other-side masters to the given Collection. Note: If the config spec does not select any iteration for a particular master, the master will be added the return collection.

NavigateCollectors.Iterations

public NavigateCollectors.Iterations(ConfigSpec configSpec,
                                     WTKeyedMap map,
                                     boolean reverse)

With this constructor, the class will add the config spec selected iterations of the other-side masters to the given WTKeyedMap. Note: If the config spec does not select any iteration for a particular master, the master will be added the given WTKeyedMap.

If the reverse flag is false, the values will be WTSets that hold the config spec selected iterations of the other-side masters and the keys will be the query keys for the objects that we navigated from.

If the reverse flag is true, the keys will be the config spec selected iterations of the other-side masters and the values will be WTSets that hold the query keys for the objects that we navigated from.

Method Detail

selectWhatToReturn

public void selectWhatToReturn(Relationship relationship,
                               QuerySpec querySpec)
                        throws WTException

Description copied from interface: NavigateResultProcessor

Specifies what objects or attributes to return when navigating a Binary link from one set of objects to another. The method may specify to return the links, the other-side objects, or specific attributes of either object or any combination of the three.

Supported API: false

Specified by:

selectWhatToReturn in interface NavigateResultProcessor

Overrides:

selectWhatToReturn in class NavigateCollectors.AbstractCollector

Throws:

WTException

addElement

public void addElement(Object object)

Description copied from interface: ResultProcessor

Add the specified object to the result processor, and increase the size by one

Supported API: false

Specified by:

addElement in interface ResultProcessor

Specified by:

addElement in class NavigateCollectors.AbstractCollector

processResults

public void processResults(WTCollection fromObjects)
                    throws WTException

Description copied from interface: NavigateResultProcessor

Post processes the results once all of the Binary links have been navigated.

Supported API: false

Specified by:

processResults in interface NavigateResultProcessor

Overrides:

processResults in class NavigateCollectors.AbstractCollector

Throws:

WTException