wt.epm.structure
Class NavigateCollectors.LinksIterations

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

All Implemented Interfaces:

NavigateResultProcessor, ResultProcessor

Enclosing class:

NavigateCollectors

public static class NavigateCollectors.LinksIterations

extends NavigateCollectors.AbstractCollector

This NavigateResultProcessor processes iteration-to-master links. Using the config spec, it finds the appropriate iteration of each other-side master. It pairs the links with the selected iterations and adds the pairs to a Collection or WTKeyedMap. An object pair is a two-element array where the first element is the link and the second is the selected iteration. Note: If the config spec does not select any iteration for a particular master, it pairs the link with the master instead.

Field Summary

private EPMCache.IterationCache	iterationSelector
private List	links

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

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

Constructor Summary

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

NavigateCollectors.LinksIterations(ConfigSpec configSpec, WTKeyedMap map)
With this constructor, the class will pair the links with the config spec selected iterations of the other-side masters and add the pair 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

links

private List links

Constructor Detail

NavigateCollectors.LinksIterations

public NavigateCollectors.LinksIterations(ConfigSpec configSpec,
                                          Collection collection)

With this constructor, the class will pair the links with the config spec selected iterations of the other-side masters and add the pair to the given Collection. An object pair is a two-element array where the first element is the link and the second is the selected iteration. Note: If the config spec does not select any iteration for a particular master, the link will be paired with the master.

NavigateCollectors.LinksIterations

public NavigateCollectors.LinksIterations(ConfigSpec configSpec,
                                          WTKeyedMap map)

With this constructor, the class will pair the links with the config spec selected iterations of the other-side masters and add the pair to the given WTKeyedMap. The values are Lists of object pairs. An object pair is a two-element array where the first element is the link and the second is the selected iteration. Note: If the config spec does not select any iteration for a particular master, the link will be paired with the master.

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