wt.epm.structure
Class NavigateCollectors.Links

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

All Implemented Interfaces:

NavigateResultProcessor, ResultProcessor

Enclosing class:

NavigateCollectors

public static class NavigateCollectors.Links

extends NavigateCollectors.AbstractCollector

This NavigateResultProcessor collects the links and adds them to a Collection or WTKeyedMap.

Field Summary

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

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

Constructor Summary

NavigateCollectors.Links(Collection collection)
With this constructor, the class will add the links returned to the given Collection.

NavigateCollectors.Links(WTKeyedMap map, boolean reverse)
With this constructor, the class will add the links 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	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, processResults, size

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigateCollectors.Links

public NavigateCollectors.Links(Collection collection)

With this constructor, the class will add the links returned to the given Collection.

NavigateCollectors.Links

public NavigateCollectors.Links(WTKeyedMap map,
                                boolean reverse)

With this constructor, the class will add the links to the given WTKeyedMap. The values are WTSets of links.

If the reverse flag is false, the class will sort the links based upon the role that we navigated from.

If the reverse flag is true, the class will sort the links based based upon the role that we navigated to (i.e. other-side role).

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