wt.epm.structure
Class PLSQLNavigator

java.lang.Object
  wt.epm.structure.PLSQLNavigator

public class PLSQLNavigator

extends Object

The PLSQLNavigator is a server-side only class that navigates links using PL/SQL stored procedures.

Supported API: false

Extendable: false

Constructor Summary

PLSQLNavigator()

Method Summary

static List	filter(Collection allLinks, LinkProxy.Role otherSideRole, EPMCache.ObjectCache objectCache, EPMFilter filter) Returns the link to each other-side object that was returned by the given filter.
static List	filter(Collection allLinks, LinkProxy.Role otherSideRole, EPMCache.VersionCache versionCache, EPMFilter filter) Returns the link to each other-side object that was returned by the given filter.
static List	filterByConfigSpec(Collection linksAndMasters, LinkProxy.Role otherSideRole, EPMCache.IterationCache iterationCache, boolean returnMissingLinks) Returns the link to the iteration of other-side object that was selected by a config spec.
private static List	filterLinks(List links, LinkProxy.Role otherSideRole, EPMCache.ObjectCache objectCache, EPMFilter filter)
private static List	filterLinks(List links, LinkProxy.Role otherSideRole, EPMCache.VersionCache versionCache, EPMFilter filter)
static List	filterOnLatest(Collection allLinks, LinkProxy.Role otherSideRole, EPMCache.ObjectCache objectCache) Returns the link to the latest iteration of each other-side object.
private static Collection	getSelected(List links, LinkProxy.Role otherSideRole, Map iterationToMaster, EPMCache.IterationCache iterationCache, boolean returnMissingLinks)
static List	navigate(NavigateQuery query) Navigates a link class and returns a LinkProxy object for each link found that matches the search criteria specified in the query.
static List	navigateIterationToMaster(NavigateToMasterQuery query) Navigates a link class to the other-side object, which must be an Iterated object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PLSQLNavigator

public PLSQLNavigator()

Method Detail

navigate

public static List navigate(NavigateQuery query)
                     throws WTException

Navigates a link class and returns a LinkProxy object for each link found that matches the search criteria specified in the query.

Supported API: false

Returns:

List of LinkProxy objects one for each link found.

Throws:

WTException

navigateIterationToMaster

public static List navigateIterationToMaster(NavigateToMasterQuery query)
                                      throws WTException

Navigates a link class to the other-side object, which must be an Iterated object. Returns a a LinkProxy object for each link found that matches the search criteria specified in the query and the object identifier of the master of the other-side object.

Supported API: false

Returns:

List of Object[] where [0] is a LinkProxy object and [1] is the object identifier of the master of the other-side object

Throws:

WTException

filterOnLatest

public static List filterOnLatest(Collection allLinks,
                                  LinkProxy.Role otherSideRole,
                                  EPMCache.ObjectCache objectCache)
                           throws WTException

Returns the link to the latest iteration of each other-side object. The other-side object must be an Iterated object.

Supported API: false

Returns:

List of LinkProxy objects, each to the latest iteration of the other-side object

Throws:

WTException

filter

public static List filter(Collection allLinks,
                          LinkProxy.Role otherSideRole,
                          EPMCache.ObjectCache objectCache,
                          EPMFilter filter)
                   throws WTException

Returns the link to each other-side object that was returned by the given filter.

Supported API: false

Returns:

List of LinkProxy objects, each to the other-side object that was returned by the filter

Throws:

WTException

filterLinks

private static List filterLinks(List links,
                                LinkProxy.Role otherSideRole,
                                EPMCache.ObjectCache objectCache,
                                EPMFilter filter)
                         throws WTException

Throws:

WTException

filter

public static List filter(Collection allLinks,
                          LinkProxy.Role otherSideRole,
                          EPMCache.VersionCache versionCache,
                          EPMFilter filter)
                   throws WTException

Returns the link to each other-side object that was returned by the given filter.

Supported API: false

Returns:

List of LinkProxy objects, each to the other-side object that was returned by the filter

Throws:

WTException

filterLinks

private static List filterLinks(List links,
                                LinkProxy.Role otherSideRole,
                                EPMCache.VersionCache versionCache,
                                EPMFilter filter)
                         throws WTException

Throws:

WTException

filterByConfigSpec

public static List filterByConfigSpec(Collection linksAndMasters,
                                      LinkProxy.Role otherSideRole,
                                      EPMCache.IterationCache iterationCache,
                                      boolean returnMissingLinks)
                               throws WTException

Returns the link to the iteration of other-side object that was selected by a config spec. (The config spec is associated with the Iteration Cache.) If a link does not exist from a particular object to the iteration of the other-side object selected by the config spec, this method will return a "missing link". Returning a "missing link" signifies that you can navigate from an object to other iterations of the same master but not to the one selected by the config spec.

Supported API: false

Returns:

List of LinkProxy objects, each to the iteration of the other-side object selected by the config spec

Throws:

WTException

getSelected

private static Collection getSelected(List links,
                                      LinkProxy.Role otherSideRole,
                                      Map iterationToMaster,
                                      EPMCache.IterationCache iterationCache,
                                      boolean returnMissingLinks)
                               throws WTException

Throws:

WTException