Package com.ptc.windchill.esi.treenavigation

Class TreeNavigatorFactory

java.lang.Object

com.ptc.windchill.esi.treenavigation.TreeNavigatorFactory

public class TreeNavigatorFactory
extends Object

Creates an appropriate TreeNavigator instance and sets data for it.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
static TreeNavigator	newTreeNavigator(Persistable root, int depth, NavigationCriteria navCriteria, Map<String,Object> navigationOptions)	Creates an appropriate TreeNavigator instance.

Methods inherited from class java.lang.Object

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

Method Details

newTreeNavigator

public static TreeNavigator newTreeNavigator(Persistable root,
 int depth,
 NavigationCriteria navCriteria,
 Map<String,Object> navigationOptions)
                                      throws ESIRendererException

Creates an appropriate TreeNavigator instance. To obtain the name of the class to instantiate, it reads the preference "com.ptc.windchill.esi.BOM.bomTreeNavigator" if the input root is a WTPart, reads the preference "com.ptc.windchill.esi.epmdoc.treeNavigator" otherwise. Calls setData() on the instantiated object before returning it.

Supported API: true

Parameters:

root - Persistable object whose structure is to be navigated.

depth - Number of levels in the structure to navigate.

navCriteria - Navigation criteria to be used for navigating the structure.

Returns:

TreeNavigator Instance of the TreeNavigator.

Throws:

ESIRendererException - if any of the invoked APIs throws an exception.