uk.org.taverna.scufl2.api.common

Class Visitor.VisitorWithPath

java.lang.Object

uk.org.taverna.scufl2.api.common.Visitor.VisitorWithPath

All Implemented Interfaces:

Visitor

Direct Known Subclasses:

DispatchingVisitor

Enclosing interface:

Visitor

public abstract static class Visitor.VisitorWithPath
extends Object
implements Visitor

Nested Class Summary

Nested classes/interfaces inherited from interface uk.org.taverna.scufl2.api.common.Visitor

Visitor.VisitorAdapter, Visitor.VisitorWithPath

Constructor Summary

Constructors

Constructor and Description
Visitor.VisitorWithPath()

Method Summary

Methods

Modifier and Type	Method and Description
WorkflowBean	getCurrentNode() Returns the WorkflowBean currently visited.
Stack<WorkflowBean>	getCurrentPath() Return the current path of WorkflowBeans.
abstract boolean	visit() Similar to Visitor.visit(WorkflowBean) - but called for every node, even if it can have children.
boolean	visit(WorkflowBean node) Final to maintain current path.
boolean	visitEnter(WorkflowBean node) Final to maintain current path.
boolean	visitLeave() Override this method to be informed when leaving a node.
boolean	visitLeave(WorkflowBean node) Final to maintain current path.

Methods inherited from class java.lang.Object

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

Constructor Detail

Visitor.VisitorWithPath

public Visitor.VisitorWithPath()

Method Detail

getCurrentNode

public WorkflowBean getCurrentNode()

Returns the WorkflowBean currently visited.

Returns:

the WorkflowBean currently visited

getCurrentPath

public Stack<WorkflowBean> getCurrentPath()

Return the current path of WorkflowBeans.

The list will never contain the current node, which can instead be found in getCurrentNode(). That means that Stack.peek() will be the intermediate parent of the current node.

The first object of the stack will be the initial object where WorkflowBean.accept(Visitor) was called, not necessarily the WorkflowBundle.

So for instance if you are in visit(WorkflowBean) on an InputProcessorPort, getCurrentPath() will have a list [workflowBundle, workflow, processor]. This should generally match the path from following Child.getParent() recursively.

This method returns the same List instance throughout the use of the visitor, it is dynamically modified by visitEnter(WorkflowBean) and visitLeave(WorkflowBean).

Returns:

A List of the current path of the ancestors of the currently visiting WorkflowBean.

visit

public abstract boolean visit()

Similar to Visitor.visit(WorkflowBean) - but called for every node, even if it can have children.

The current node is available in getCurrentNode().

Returns:

true if this node's children should be visited. (return value is ignored for nodes which can't have children)

visit

public final boolean visit(WorkflowBean node)

Final to maintain current path. Override visit() instead.

Specified by:

visit in interface Visitor

Parameters:

node - the currently visited WorkflowBean

Returns:

true if the visits over the current beans' siblings should continue, false to immediately leave the parent.

See Also:

visit()

visitEnter

public final boolean visitEnter(WorkflowBean node)

Final to maintain current path. Override visit() instead.

Specified by:

visitEnter in interface Visitor

Parameters:

node - the currently visited WorkflowBean

Returns:

true if the children of this bean should be visited.

See Also:

visit()

visitLeave

public boolean visitLeave()

Override this method to be informed when leaving a node. Similar to Visitor.visitLeave(WorkflowBean), but also called for nodes which can't have children.

The current node is present in getCurrentPath() and can be retrieved using getCurrentNode().

Returns:

true if the visits over the current beans' siblings should continue, false to immediately leave the parent.

visitLeave

public final boolean visitLeave(WorkflowBean node)

Final to maintain current path. Override visitLeave() instead.

Specified by:

visitLeave in interface Visitor

Parameters:

node - the currently visited WorkflowBean

Returns:

false if the visits over the current beans' siblings should continue, false to immediately leave the parent.

See Also:

visitLeave()