org.jbpm.graph.def
Class Node

java.lang.Object
  org.jbpm.graph.def.GraphElement
      org.jbpm.graph.def.Node

All Implemented Interfaces:

java.io.Serializable, Identifiable, Parsable

Direct Known Subclasses:

Decision, EndState, Fork, InterleaveEnd, InterleaveStart, Join, MailNode, Merge, MilestoneNode, ParallelSplit, ProcessState, StartState, State, SuperState, TaskNode

public class Node
extends GraphElement
implements Parsable

See Also:

Serialized Form

Nested Class Summary

static class

Node.NodeType

Field Summary

protected Action	action
protected java.util.Set<Transition>	arrivingTransitions
protected boolean	isAsync
protected boolean	isAsyncExclusive
protected java.util.List<Transition>	leavingTransitions
protected SuperState	superState
static java.lang.String[]	supportedEventTypes

Fields inherited from class org.jbpm.graph.def.GraphElement

description, events, exceptionHandlers, name, processDefinition

Constructor Summary

Node()
creates an unnamed node.

Node(java.lang.String name)
creates a node with the given name.

Method Summary

Transition	addArrivingTransition(Transition arrivingTransition) add a bidirection relation between this node and the given arriving transition.
Transition	addLeavingTransition(Transition leavingTransition) creates a bidirection relation between this node and the given leaving transition.
protected void	addNodeLog(Token token)
protected ExecuteNodeJob	createAsyncContinuationJob(Token token)
void	enter(ExecutionContext executionContext) called by a transition to pass execution to this node.
void	execute(ExecutionContext executionContext) override this method to customize the node behaviour.
java.lang.String	generateNextLeavingTransitionName() generates a new name for a transition that will be added as a leaving transition.
Action	getAction()
java.util.Set<Transition>	getArrivingTransitions() are the arriving transitions.
Transition	getDefaultLeavingTransition() is the default leaving transition.
java.lang.String	getFullyQualifiedName() the slash separated name that includes all the superstate names.
Transition	getLeavingTransition(java.lang.String transitionName) retrieves a leaving transition by name.
java.util.List<Transition>	getLeavingTransitions()
java.util.List<Transition>	getLeavingTransitionsList()
java.util.Map<java.lang.String,Transition>	getLeavingTransitionsMap() are the leaving Transitions, mapped by their name (java.lang.String).
java.lang.String	getNameExt()
java.util.List<Node>	getNodes() returns a list of child nodes (only applicable for SuperState)s.
Node.NodeType	getNodeType()
GraphElement	getParent() is the SuperState or the ProcessDefinition in which this node is contained.
ProcessDefinition	getProcessDefinition()
SuperState	getSuperState()
java.lang.String[]	getSupportedEventTypes() indicative set of event types supported by this graph element.
boolean	hasLeavingTransition(java.lang.String transitionName) checks for the presence of a leaving transition with the given name.
boolean	hasNoLeavingTransitions() true if this transition has leaving transitions.
boolean	isAsync()
boolean	isAsyncExclusive()
boolean	isSuperStateNode() indicates wether this node is a superstate.
void	leave(ExecutionContext executionContext) called by the implementation of this node to continue execution over the default transition.
void	leave(ExecutionContext executionContext, java.lang.String transitionName) called by the implementation of this node to continue execution over the specified transition.
void	leave(ExecutionContext executionContext, Transition transition) called by the implementation of this node to continue execution over the given transition.
void	read(org.dom4j.Element nodeElement, JpdlXmlReader jpdlXmlReader)
void	removeArrivingTransition(Transition arrivingTransition) removes the bidirection relation between this node and the given arriving transition.
void	removeLeavingTransition(Transition leavingTransition) removes the bidirection relation between this node and the given leaving transition.
void	reorderLeavingTransition(int oldIndex, int newIndex) moves one leaving transition from the oldIndex and inserts it at the newIndex.
void	setAction(Action action)
void	setAsync(boolean isAsync)
void	setAsyncExclusive(boolean isAsyncExclusive)
void	setName(java.lang.String name) updates the name of this node
void	write(org.dom4j.Element nodeElement)

Methods inherited from class org.jbpm.graph.def.GraphElement

addEvent, addExceptionHandler, createAsyncActionExecutionJob, equals, executeAction, findExceptionHandler, fireAndPropagateEvent, fireEvent, getDescription, getEvent, getEvents, getExceptionHandlers, getId, getName, getParentChain, getParents, hasEvent, hasEvents, raiseException, removeEvent, removeExceptionHandler, reorderExceptionHandler, setDescription, setProcessDefinition, toString

Methods inherited from class java.lang.Object

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

Field Detail

leavingTransitions

protected java.util.List<Transition> leavingTransitions

arrivingTransitions

protected java.util.Set<Transition> arrivingTransitions

action

protected Action action

superState

protected SuperState superState

isAsync

protected boolean isAsync

isAsyncExclusive

protected boolean isAsyncExclusive

supportedEventTypes

public static final java.lang.String[] supportedEventTypes

Constructor Detail

Node

public Node()

creates an unnamed node.

Node

public Node(java.lang.String name)

creates a node with the given name.

Method Detail

getNodeType

public Node.NodeType getNodeType()

getNameExt

public java.lang.String getNameExt()

getSupportedEventTypes

public java.lang.String[] getSupportedEventTypes()

Description copied from class: GraphElement

indicative set of event types supported by this graph element. this is currently only used by the process designer to know which event types to show on a given graph element. in process definitions and at runtime, there are no contstraints on the event-types.

Specified by:

getSupportedEventTypes in class GraphElement

read

public void read(org.dom4j.Element nodeElement,
                 JpdlXmlReader jpdlXmlReader)

Specified by:

read in interface Parsable

write

public void write(org.dom4j.Element nodeElement)

Specified by:

write in interface Parsable

getLeavingTransitions

public java.util.List<Transition> getLeavingTransitions()

getLeavingTransitionsList

public java.util.List<Transition> getLeavingTransitionsList()

getLeavingTransitionsMap

public java.util.Map<java.lang.String,Transition> getLeavingTransitionsMap()

are the leaving Transitions, mapped by their name (java.lang.String).

addLeavingTransition

public Transition addLeavingTransition(Transition leavingTransition)

creates a bidirection relation between this node and the given leaving transition.

Throws:

java.lang.IllegalArgumentException - if leavingTransition is null.

removeLeavingTransition

public void removeLeavingTransition(Transition leavingTransition)

removes the bidirection relation between this node and the given leaving transition.

Throws:

java.lang.IllegalArgumentException - if leavingTransition is null.

hasLeavingTransition

public boolean hasLeavingTransition(java.lang.String transitionName)

checks for the presence of a leaving transition with the given name.

Returns:

true if this node has a leaving transition with the given name, false otherwise.

getLeavingTransition

public Transition getLeavingTransition(java.lang.String transitionName)

retrieves a leaving transition by name. note that also the leaving transitions of the supernode are taken into account.

hasNoLeavingTransitions

public boolean hasNoLeavingTransitions()

true if this transition has leaving transitions.

generateNextLeavingTransitionName

public java.lang.String generateNextLeavingTransitionName()

generates a new name for a transition that will be added as a leaving transition.

getDefaultLeavingTransition

public Transition getDefaultLeavingTransition()

is the default leaving transition.

reorderLeavingTransition

public void reorderLeavingTransition(int oldIndex,
                                     int newIndex)

moves one leaving transition from the oldIndex and inserts it at the newIndex.

getArrivingTransitions

public java.util.Set<Transition> getArrivingTransitions()

are the arriving transitions.

addArrivingTransition

public Transition addArrivingTransition(Transition arrivingTransition)

add a bidirection relation between this node and the given arriving transition.

Throws:

java.lang.IllegalArgumentException - if t is null.

removeArrivingTransition

public void removeArrivingTransition(Transition arrivingTransition)

removes the bidirection relation between this node and the given arriving transition.

Throws:

java.lang.IllegalArgumentException - if t is null.

getParent

public GraphElement getParent()

is the SuperState or the ProcessDefinition in which this node is contained.

Overrides:

getParent in class GraphElement

enter

public void enter(ExecutionContext executionContext)

called by a transition to pass execution to this node.

createAsyncContinuationJob

protected ExecuteNodeJob createAsyncContinuationJob(Token token)

execute

public void execute(ExecutionContext executionContext)

override this method to customize the node behaviour.

leave

public void leave(ExecutionContext executionContext)

called by the implementation of this node to continue execution over the default transition.

leave

public void leave(ExecutionContext executionContext,
                  java.lang.String transitionName)

called by the implementation of this node to continue execution over the specified transition.

leave

public void leave(ExecutionContext executionContext,
                  Transition transition)

called by the implementation of this node to continue execution over the given transition.

addNodeLog

protected void addNodeLog(Token token)

getProcessDefinition

public ProcessDefinition getProcessDefinition()

Overrides:

getProcessDefinition in class GraphElement

setName

public void setName(java.lang.String name)

updates the name of this node

Overrides:

setName in class GraphElement

getFullyQualifiedName

public java.lang.String getFullyQualifiedName()

the slash separated name that includes all the superstate names.

isSuperStateNode

public boolean isSuperStateNode()

indicates wether this node is a superstate.

getNodes

public java.util.List<Node> getNodes()

returns a list of child nodes (only applicable for SuperState)s.

getSuperState

public SuperState getSuperState()

getAction

public Action getAction()

setAction

public void setAction(Action action)

isAsync

public boolean isAsync()

setAsync

public void setAsync(boolean isAsync)

isAsyncExclusive

public boolean isAsyncExclusive()

setAsyncExclusive

public void setAsyncExclusive(boolean isAsyncExclusive)