wt.epm.structure
Interface NavigateResultProcessor

All Superinterfaces:

ResultProcessor

All Known Implementing Classes:

EPMNavigateUtility.QueryResultProcessor, NavigateCollectors.AbstractCollector

public interface NavigateResultProcessor

extends ResultProcessor

A NavigateResultProcessor specifies, collects and optionally processes the results returned when navigating a Binary link from one set of objects to another. It may return the results as a Collection, a Map or some other type of object.

It may specify to return the links, the other-side objects, or specific attributes of either object or any combination of the three. It may also post process the results. For example, it may return the appropriate iteration for each other-side master by applying a ConfigSpec.

It works in conjuction with the navigate() and the expand() methods in the EPMSrvStructureService. It may gather results from multiple calls to navigate() or expand() and add them to the same Collection or Map.

Supported API: false

Extendable: false

Method Summary

void	clearPreviousResults() Clears previous results.
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.

Methods inherited from interface wt.fc.ResultProcessor

addElement, size

Method Detail

selectWhatToReturn

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

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

Parameters:

relationship - relationship that is being navigated

querySpec - query spec that describes how to perform the navigation

Throws:

WTException

processResults

public void processResults(WTCollection fromObjects)
                    throws WTException

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

Supported API: false

Parameters:

fromObjects - objects we navigated from

Throws:

WTException

getResults

public Object getResults()

Returns the processed results.

Supported API: false

Returns:

Object

clearPreviousResults

public void clearPreviousResults()

Clears previous results.

Supported API: false