wt.visitor
Class ProductStructureNavigatorFactory

java.lang.Object
  wt.visitor.ProductStructureNavigatorFactory

All Implemented Interfaces:

Externalizable, Serializable

public final class ProductStructureNavigatorFactory
extends Object
implements Externalizable

This class provides static methods for creating product structure navigators. It provides methods for several basic types of product structure navigation. Once a navigator is created, it can be set up with a visitor and the traverse method can be called. The methods in this class hide the details involved with setting up a particular structure navigation.

Supported API: true

Extendable: false

See Also:

Navigator, ConfigSpecNodeExpander, Serialized Form

Field Summary

static int	BREADTH_FIRST_NAVIGATOR Used to specify a breadth first navigation.
static int	DEPTH_FIRST_NAVIGATOR Used to specify a depth first navigation.

Method Summary

static wt.visitor.Navigator	newEPMDocNavigator(ConfigSpec a_configSpec, int a_navigatorType) This method creates a Navigator for traversing the "uses" links of an EPMDocumentt structure.
static wt.visitor.Navigator	newEPMDocReqNavigator(ConfigSpec a_configSpec, int a_navigatorType) This method creates a Navigator for traversing the "uses" links of an EPMDocumentt structure which are marked as "REQUIRED".
static wt.visitor.Navigator	newNavigator(ConfigSpec a_configSpec, int a_navigatorType) This method creates a Navigator for traversing the "uses" links of a Product structure via the generic IteratedUsageLink class.
static wt.visitor.Navigator	newOccurrencedReverseNavigator(WTProductConfiguration a_Configuration, int a_navigatorType) This method creates a Navigator for traversing the "used by" links of a Product structure via the generic IteratedUsageLink class.
static wt.visitor.Navigator	newPartNavigator(BaselineConfigurationConfigSpec a_configSpec, int a_navigatorType) This method creates a Navigator for traversing the "uses" links of a Part structure.
static wt.visitor.Navigator	newPartNavigator(ConfigSpec a_configSpec, int a_navigatorType) This method creates a Navigator for traversing the "uses" links of a Part structure.
static wt.visitor.Navigator	newPartNavigator(WTPartConfigSpec a_configSpec, int a_navigatorType) This method creates a Navigator for traversing the "uses" links of a Part structure.
static wt.visitor.Navigator	newReverseNavigator(ConfigSpec a_configSpec, int a_navigatorType) This method creates a Navigator for traversing the "used by" links of a Product structure via the generic IteratedUsageLink class.

Methods inherited from class java.lang.Object

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

Field Detail

DEPTH_FIRST_NAVIGATOR

public static final int DEPTH_FIRST_NAVIGATOR

Used to specify a depth first navigation.

Supported API: true

See Also:

Constant Field Values

BREADTH_FIRST_NAVIGATOR

public static final int BREADTH_FIRST_NAVIGATOR

Used to specify a breadth first navigation.

Supported API: true

See Also:

Constant Field Values

Method Detail

newEPMDocNavigator

public static wt.visitor.Navigator newEPMDocNavigator(ConfigSpec a_configSpec,
                                                      int a_navigatorType)
                                               throws WTPropertyVetoException

This method creates a Navigator for traversing the "uses" links of an EPMDocumentt structure. The navigation can be specified as DEPTH_FIRST_NAVIGATOR or BREADTH_FIRST_NAVIGATOR

Supported API: true

Parameters:

a_configSpec -

a_navigatorType -

Returns:

Navigator

Throws:

WTPropertyVetoException

newEPMDocReqNavigator

public static wt.visitor.Navigator newEPMDocReqNavigator(ConfigSpec a_configSpec,
                                                         int a_navigatorType)
                                                  throws WTPropertyVetoException

This method creates a Navigator for traversing the "uses" links of an EPMDocumentt structure which are marked as "REQUIRED". The navigation can be specified as DEPTH_FIRST_NAVIGATOR or BREADTH_FIRST_NAVIGATOR

Supported API: true

Parameters:

a_configSpec -

a_navigatorType -

Returns:

Navigator

Throws:

WTPropertyVetoException

newNavigator

public static wt.visitor.Navigator newNavigator(ConfigSpec a_configSpec,
                                                int a_navigatorType)
                                         throws WTPropertyVetoException

This method creates a Navigator for traversing the "uses" links of a Product structure via the generic IteratedUsageLink class. The navigation can be specified as DEPTH_FIRST_NAVIGATOR or BREADTH_FIRST_NAVIGATOR.

Supported API: true

Parameters:

a_configSpec -

a_navigatorType -

Returns:

Navigator

Throws:

WTPropertyVetoException

newOccurrencedReverseNavigator

public static wt.visitor.Navigator newOccurrencedReverseNavigator(WTProductConfiguration a_Configuration,
                                                                  int a_navigatorType)
                                                           throws WTException,
                                                                  WTPropertyVetoException

This method creates a Navigator for traversing the "used by" links of a Product structure via the generic IteratedUsageLink class. The navigation can be specified as DEPTH_FIRST_NAVIGATOR or BREADTH_FIRST_NAVIGATOR.

Supported API: true

Parameters:

a_Configuration -

a_navigatorType -

Returns:

Navigator

Throws:

WTException

WTPropertyVetoException

newPartNavigator

public static wt.visitor.Navigator newPartNavigator(WTPartConfigSpec a_configSpec,
                                                    int a_navigatorType)
                                             throws WTPropertyVetoException

This method creates a Navigator for traversing the "uses" links of a Part structure. The navigation can be specified as DEPTH_FIRST_NAVIGATOR or BREADTH_FIRST_NAVIGATOR.

Supported API: true

Parameters:

a_configSpec -

a_navigatorType -

Returns:

Navigator

Throws:

WTPropertyVetoException

newPartNavigator

public static wt.visitor.Navigator newPartNavigator(BaselineConfigurationConfigSpec a_configSpec,
                                                    int a_navigatorType)
                                             throws WTPropertyVetoException

This method creates a Navigator for traversing the "uses" links of a Part structure. The navigation can be specified as DEPTH_FIRST_NAVIGATOR or BREADTH_FIRST_NAVIGATOR.

Supported API: true

Parameters:

a_configSpec -

a_navigatorType -

Returns:

Navigator

Throws:

WTPropertyVetoException

newPartNavigator

public static wt.visitor.Navigator newPartNavigator(ConfigSpec a_configSpec,
                                                    int a_navigatorType)
                                             throws WTPropertyVetoException

This method creates a Navigator for traversing the "uses" links of a Part structure. The navigation can be specified as DEPTH_FIRST_NAVIGATOR or BREADTH_FIRST_NAVIGATOR.

Supported API: true

Parameters:

a_configSpec -

a_navigatorType -

Returns:

Navigator

Throws:

WTPropertyVetoException

newReverseNavigator

public static wt.visitor.Navigator newReverseNavigator(ConfigSpec a_configSpec,
                                                       int a_navigatorType)
                                                throws WTPropertyVetoException

This method creates a Navigator for traversing the "used by" links of a Product structure via the generic IteratedUsageLink class. The navigation can be specified as DEPTH_FIRST_NAVIGATOR or BREADTH_FIRST_NAVIGATOR.

Supported API: true

Parameters:

a_configSpec -

a_navigatorType -

Returns:

Navigator

Throws:

WTPropertyVetoException