wt.epm.structure
Class NavigateCollectors.AbstractCollector

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

All Implemented Interfaces:

NavigateResultProcessor, ResultProcessor

Direct Known Subclasses:

NavigateCollectors.Endpoints, NavigateCollectors.Iterations, NavigateCollectors.Links, NavigateCollectors.LinksIterations, NavigateCollectors.LinksObjects, NavigateCollectors.OtherSideObjects

Enclosing class:

NavigateCollectors

protected abstract static class NavigateCollectors.AbstractCollector

extends Object

implements NavigateResultProcessor

Field Summary

protected static int	COLLECTION
protected static int	INITIAL_SIZE
protected static int	MAP
protected Relationship.Role	otherSideRole
protected Object	results
protected int	resultType
protected boolean	reverse
protected Relationship.Role	role

Constructor Summary

protected	NavigateCollectors.AbstractCollector(Collection collection)
protected	NavigateCollectors.AbstractCollector(WTKeyedMap map, boolean reverse)

Method Summary

abstract void	addElement(Object object) Add the specified object to the result processor, and increase the size by one Supported API: false
void	clearPreviousResults() Clears previous results.
protected QueryKey	createQueryKey(Relationship.Role role, Object className, Object identifier)
Object	getResults() Returns the processed results.
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.
int	size() Return the number of objects which have been added by the result processor Supported API: false

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_SIZE

protected static final int INITIAL_SIZE

See Also:

Constant Field Values

COLLECTION

protected static final int COLLECTION

See Also:

Constant Field Values

MAP

protected static final int MAP

See Also:

Constant Field Values

resultType

protected int resultType

results

protected Object results

role

protected Relationship.Role role

otherSideRole

protected Relationship.Role otherSideRole

reverse

protected boolean reverse

Constructor Detail

NavigateCollectors.AbstractCollector

protected NavigateCollectors.AbstractCollector(Collection collection)

NavigateCollectors.AbstractCollector

protected NavigateCollectors.AbstractCollector(WTKeyedMap map,
                                               boolean reverse)

Method Detail

addElement

public abstract 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

Parameters:

object -

size

public int size()

Description copied from interface: ResultProcessor

Return the number of objects which have been added by the result processor

Supported API: false

Specified by:

size in interface ResultProcessor

Returns:

int

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

Parameters:

relationship - relationship that is being navigated

querySpec - query spec that describes how to perform the navigation

Throws:

WTException

clearPreviousResults

public void clearPreviousResults()

Description copied from interface: NavigateResultProcessor

Clears previous results.

Supported API: false

Specified by:

clearPreviousResults in interface NavigateResultProcessor

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

Parameters:

fromObjects - objects we navigated from

Throws:

WTException

getResults

public Object getResults()

Description copied from interface: NavigateResultProcessor

Returns the processed results.

Supported API: false

Specified by:

getResults in interface NavigateResultProcessor

Returns:

Object

createQueryKey

protected QueryKey createQueryKey(Relationship.Role role,
                                  Object className,
                                  Object identifier)