wt.doc
Class DocumentStructureNavigatorFactory

java.lang.Object
  wt.doc.DocumentStructureNavigatorFactory

All Implemented Interfaces:

Externalizable, Serializable

public class DocumentStructureNavigatorFactory
extends Object
implements Externalizable

This class provides static methods for creating document structure navigators. It provides methods for several basic types of document 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	newDocumentNavigator(ConfigSpec a_configSpec, int a_navigatorType) This method creates a Navigator for traversing the "uses" links of a Document structure.
static wt.visitor.Navigator	newDocumentNavigator(WTDocumentConfigSpec a_configSpec, int a_navigatorType) This method creates a Navigator for traversing the "uses" links of a Document structure.
static wt.visitor.Navigator	newNavigator(ConfigSpec a_configSpec, int a_navigatorType) This method creates a Navigator for traversing the "uses" links of a Document 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

newDocumentNavigator

public static wt.visitor.Navigator newDocumentNavigator(WTDocumentConfigSpec a_configSpec,
                                                        int a_navigatorType)
                                                 throws WTPropertyVetoException

This method creates a Navigator for traversing the "uses" links of a Document 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

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 Document 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

newDocumentNavigator

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

This method creates a Navigator for traversing the "uses" links of a Document 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