Package de.xima.fc.interfaces.workflow.value

Class ValueDescriptorNodeVisitor

java.lang.Object

de.xima.fc.interfaces.workflow.value.ValueDescriptorNodeVisitor

All Implemented Interfaces:

TreeVisit.ITreeVisitor<ValueDescriptorNode<?,?>>

public abstract class ValueDescriptorNodeVisitor
extends Object
implements TreeVisit.ITreeVisitor<ValueDescriptorNode<?,?>>

Implements TreeVisit.ITreeVisitor for ValueDescriptorNode and adds specific methods for each subtype of value descriptor node. Can be used as a base class for visitors that need to handle specific node types. The default implementation of each specific method does nothing and returns the default traversal behavior (i.e. to continue traversal).

Since:

8.5.0

Nested Class Summary

Nested classes/interfaces inherited from interface de.xima.fc.common.tree.TreeVisit.ITreeVisitor

TreeVisit.ITreeVisitor.Pathless<Node>

Constructor Summary

Constructors

Constructor	Description
ValueDescriptorNodeVisitor()

Method Summary

Modifier and Type	Method	Description
protected void	afterEnter(ValueDescriptorNode<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path, TreeVisit.ETreeVisitResult result)	Called after entering any node.
protected void	afterExit(ValueDescriptorNode<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path, boolean result)	Called after exiting any node.
protected void	afterVisit(ValueDescriptorNode<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path, boolean result)	Called after visiting any node.
protected void	beforeEnter(ValueDescriptorNode<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Called before entering any node.
protected void	beforeExit(ValueDescriptorNode<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Called before exiting any node.
protected void	beforeVisit(ValueDescriptorNode<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Called before visiting any node.
protected String	buildJsonPath()	When trackJsonPath() is enabled, builds the current JSON path as a string.
TreeVisit.ETreeVisitResult	enter(ValueDescriptorNode<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Enters a tree node.
protected TreeVisit.ETreeVisitResult	enterListItem(ValueDescriptorNode.ListItem<?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Enters a ValueDescriptorNode.ListItem node.
protected TreeVisit.ETreeVisitResult	enterMapValue(ValueDescriptorNode.MapValue<?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Enters a ValueDescriptorNode.MapValue node.
protected TreeVisit.ETreeVisitResult	enterRecordKey(ValueDescriptorNode.RecordKey node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Enters a ValueDescriptorNode.RecordKey node.
protected TreeVisit.ETreeVisitResult	enterRoot(ValueDescriptorNode.Root<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Enters a ValueDescriptorNode.Root node.
protected TreeVisit.ETreeVisitResult	enterTupleIndex(ValueDescriptorNode.TupleIndex node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Enters a ValueDescriptorNode.TupleIndex node.
protected TreeVisit.ETreeVisitResult	enterUnionMember(ValueDescriptorNode.UnionMember node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Enters a ValueDescriptorNode.UnionMember node.
boolean	exit(ValueDescriptorNode<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Exists a tree node.
protected boolean	exitListItem(ValueDescriptorNode.ListItem<?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Exits a ValueDescriptorNode.ListItem node.
protected boolean	exitMapValue(ValueDescriptorNode.MapValue<?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Exits a ValueDescriptorNode.MapValue node.
protected boolean	exitRecordKey(ValueDescriptorNode.RecordKey node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Exits a ValueDescriptorNode.RecordKey node.
protected boolean	exitRoot(ValueDescriptorNode.Root<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Exits a ValueDescriptorNode.Root node.
protected boolean	exitTupleIndex(ValueDescriptorNode.TupleIndex node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Exits a ValueDescriptorNode.TupleIndex node.
protected boolean	exitUnionMember(ValueDescriptorNode.UnionMember node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Exits a ValueDescriptorNode.UnionMember node.
protected boolean	trackJsonPath()	Templates method to configure whether this visitor should track the current JSON path.
boolean	visit(ValueDescriptorNode<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Visits a tree node.
protected boolean	visitListItem(ValueDescriptorNode.ListItem<?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Visits a ValueDescriptorNode.ListItem node.
protected boolean	visitMapValue(ValueDescriptorNode.MapValue<?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Visits a ValueDescriptorNode.MapValue node.
protected boolean	visitRecordKey(ValueDescriptorNode.RecordKey node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Visits a ValueDescriptorNode.RecordKey node.
protected boolean	visitRoot(ValueDescriptorNode.Root<?,?> node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Visits a ValueDescriptorNode.Root node.
protected boolean	visitTupleIndex(ValueDescriptorNode.TupleIndex node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Visits a ValueDescriptorNode.TupleIndex node.
protected boolean	visitUnionMember(ValueDescriptorNode.UnionMember node, List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)	Visits a ValueDescriptorNode.UnionMember node.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueDescriptorNodeVisitor

public ValueDescriptorNodeVisitor()

Method Detail

enter

public final TreeVisit.ETreeVisitResult enter(ValueDescriptorNode<?,?> node,
                                              List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Description copied from interface: TreeVisit.ITreeVisitor

Enters a tree node. This is called when the node is first reached, before any visitor methods are called on child nodes. See TreeVisit for an example of the call order.

Specified by:

enter in interface TreeVisit.ITreeVisitor<ValueDescriptorNode<?,?>>

Parameters:

node - A tree node.

path - The path of the node, i.e. all parents of the node. This is always an empty list when includePath is set to false

Returns:

How to proceed with the tree visit.

exit

public final boolean exit(ValueDescriptorNode<?,?> node,
                          List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Description copied from interface: TreeVisit.ITreeVisitor

Exists a tree node. This is called at the end, after all children were visited. No more visitor methods will be called on any children of the node. See TreeVisit for an example of the call order.

Specified by:

exit in interface TreeVisit.ITreeVisitor<ValueDescriptorNode<?,?>>

Parameters:

node - A tree node.

path - The path of the node, i.e. all parents of the node. This is always an empty list when includePath is set to false

Returns:

true to continue with the tree visit, false to exit the visit (see TreeVisit.ETreeVisitResult.QUIT).

visit

public final boolean visit(ValueDescriptorNode<?,?> node,
                           List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Description copied from interface: TreeVisit.ITreeVisitor

Visits a tree node. This is called between enter and exit. See TreeVisit for an example of the call order.

Specified by:

visit in interface TreeVisit.ITreeVisitor<ValueDescriptorNode<?,?>>

Parameters:

node - A tree node.

path - The path of the node, i.e. all parents of the node. This is always an empty list when includePath is set to false

Returns:

true to continue with the tree visit, false to exit the visit (see TreeVisit.ETreeVisitResult.QUIT).

afterEnter

protected void afterEnter(ValueDescriptorNode<?,?> node,
                          List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path,
                          TreeVisit.ETreeVisitResult result)

Called after entering any node.

Parameters:

node - The node.

path - The path to the node.

result - The result of the enter method.

afterExit

protected void afterExit(ValueDescriptorNode<?,?> node,
                         List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path,
                         boolean result)

Called after exiting any node.

Parameters:

node - The node.

path - The path to the node.

result - The result of the exit method.

afterVisit

protected void afterVisit(ValueDescriptorNode<?,?> node,
                          List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path,
                          boolean result)

Called after visiting any node.

Parameters:

node - The node.

path - The path to the node.

result - The result of the visit method.

beforeEnter

protected void beforeEnter(ValueDescriptorNode<?,?> node,
                           List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Called before entering any node.

Parameters:

node - The node.

path - The path to the node.

beforeExit

protected void beforeExit(ValueDescriptorNode<?,?> node,
                          List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Called before exiting any node.

Parameters:

node - The node.

path - The path to the node.

beforeVisit

protected void beforeVisit(ValueDescriptorNode<?,?> node,
                           List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Called before visiting any node.

Parameters:

node - The node.

path - The path to the node.

buildJsonPath

protected final String buildJsonPath()

When trackJsonPath() is enabled, builds the current JSON path as a string.

Returns:

The current JSON path.

enterListItem

protected TreeVisit.ETreeVisitResult enterListItem(ValueDescriptorNode.ListItem<?> node,
                                                   List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Enters a ValueDescriptorNode.ListItem node.

Parameters:

node - The node.

path - The path to the node.

Returns:

The visit result that indicates how to proceed with the traversal.

enterMapValue

protected TreeVisit.ETreeVisitResult enterMapValue(ValueDescriptorNode.MapValue<?> node,
                                                   List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Enters a ValueDescriptorNode.MapValue node.

Parameters:

node - The node.

path - The path to the node.

Returns:

The visit result that indicates how to proceed with the traversal.

enterRecordKey

protected TreeVisit.ETreeVisitResult enterRecordKey(ValueDescriptorNode.RecordKey node,
                                                    List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Enters a ValueDescriptorNode.RecordKey node.

Parameters:

node - The node.

path - The path to the node.

Returns:

The visit result that indicates how to proceed with the traversal.

enterRoot

protected TreeVisit.ETreeVisitResult enterRoot(ValueDescriptorNode.Root<?,?> node,
                                               List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Enters a ValueDescriptorNode.Root node.

Parameters:

node - The node.

path - The path to the node.

Returns:

The visit result that indicates how to proceed with the traversal.

enterTupleIndex

protected TreeVisit.ETreeVisitResult enterTupleIndex(ValueDescriptorNode.TupleIndex node,
                                                     List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Enters a ValueDescriptorNode.TupleIndex node.

Parameters:

node - The node.

path - The path to the node.

Returns:

The visit result that indicates how to proceed with the traversal.

enterUnionMember

protected TreeVisit.ETreeVisitResult enterUnionMember(ValueDescriptorNode.UnionMember node,
                                                      List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Enters a ValueDescriptorNode.UnionMember node.

Parameters:

node - The node.

path - The path to the node.

Returns:

The visit result that indicates how to proceed with the traversal.

exitListItem

protected boolean exitListItem(ValueDescriptorNode.ListItem<?> node,
                               List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Exits a ValueDescriptorNode.ListItem node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

exitMapValue

protected boolean exitMapValue(ValueDescriptorNode.MapValue<?> node,
                               List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Exits a ValueDescriptorNode.MapValue node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

exitRecordKey

protected boolean exitRecordKey(ValueDescriptorNode.RecordKey node,
                                List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Exits a ValueDescriptorNode.RecordKey node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

exitRoot

protected boolean exitRoot(ValueDescriptorNode.Root<?,?> node,
                           List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Exits a ValueDescriptorNode.Root node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

exitTupleIndex

protected boolean exitTupleIndex(ValueDescriptorNode.TupleIndex node,
                                 List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Exits a ValueDescriptorNode.TupleIndex node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

exitUnionMember

protected boolean exitUnionMember(ValueDescriptorNode.UnionMember node,
                                  List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Exits a ValueDescriptorNode.UnionMember node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

trackJsonPath

protected boolean trackJsonPath()

Templates method to configure whether this visitor should track the current JSON path. Disabled by default. To enable, override this method to return true. When enabled, call buildJsonPath() to get the current JSON path as a string.

Returns:

True to track the JSON path, false otherwise.

visitListItem

protected boolean visitListItem(ValueDescriptorNode.ListItem<?> node,
                                List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Visits a ValueDescriptorNode.ListItem node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

visitMapValue

protected boolean visitMapValue(ValueDescriptorNode.MapValue<?> node,
                                List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Visits a ValueDescriptorNode.MapValue node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

visitRecordKey

protected boolean visitRecordKey(ValueDescriptorNode.RecordKey node,
                                 List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Visits a ValueDescriptorNode.RecordKey node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

visitRoot

protected boolean visitRoot(ValueDescriptorNode.Root<?,?> node,
                            List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Visits a ValueDescriptorNode.Root node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

visitTupleIndex

protected boolean visitTupleIndex(ValueDescriptorNode.TupleIndex node,
                                  List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Visits a ValueDescriptorNode.TupleIndex node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.

visitUnionMember

protected boolean visitUnionMember(ValueDescriptorNode.UnionMember node,
                                   List<TreeVisit.TreePathFragment<ValueDescriptorNode<?,?>>> path)

Visits a ValueDescriptorNode.UnionMember node.

Parameters:

node - The node.

path - The path to the node.

Returns:

True to continue traversal, false to stop.