ProcessModel

java.lang.Object
- net.frapu.code.visualization.ProcessModel

All Implemented Interfaces:

java.lang.Cloneable, ProcessObjectListener

Direct Known Subclasses:

ArchimateModel, BPMNModel, ClassModel, CMMNModel, DomainModel, EPKModel, GanttModel, LifecycleModel, OntologyModel, OrgChartModel, PetriNetModel, ProcessMapModel, ReportingModel, StoryboardModel, TWFModel, XFormsModel
```
public abstract class ProcessModel
extends java.lang.Object
implements ProcessObjectListener, java.lang.Cloneable
```
This class provides a data model for a process used within ProcessEditor.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTR_ID`
`static java.lang.String`	`ATTR_NAME`
`static java.lang.String`	`ATTR_PARENT_REF` Optional attribute that references to the model that has a reference to the actual model (and was used to open it)
`static java.lang.String`	`ATTR_TYPE`
`static java.lang.String`	`ATTR_XMLNS` Serialization properties
`static java.lang.String`	`ATTR_XMLNS_XSI`
`static java.lang.String`	`ATTR_XSI_SCHEMALOCATION`
`protected java.lang.String`	`id`
`protected java.util.Map<ProcessNode,java.util.List<ProcessEdge>>`	`precEdgeCache` A cache for the incoming edges of a node
`protected java.util.Map<ProcessNode,java.util.List<ProcessNode>>`	`predecessorCache` A cache for the predecessors of a node
`protected ProcessUtils`	`processUtils` An instance of a sub-class of ProcessUtils
`static java.lang.String`	`PROP_AUTHOR` The author of this ProcessModel
`static java.lang.String`	`PROP_COMMENT` A comment for this ProcessModel
`static java.lang.String`	`PROP_CREATE_DATE` The creation date of the ProcessModel
`static java.lang.String`	`PROP_EDITOR` A field for the owner of this model (if applicable
`static java.lang.String`	`PROP_FOLDERALIAS` An optional property holding the source folder alias
`static java.lang.String`	`PROP_LASTCHECKIN` The last time this model was changed
`static java.lang.String`	`PROP_PROCESS_NAME` The name of the ProcessModel
`static java.lang.String`	`PROP_PROCESS_URI` The URI for this model (if applicable)
`static java.lang.String`	`PROP_SOURCE_VERSION` The source version of this ProcessModel (optional)
`static java.lang.String`	`TAG_EDGES`
`static java.lang.String`	`TAG_MODEL`
`static java.lang.String`	`TAG_NODES`
`static java.lang.String`	`TAG_PROPERTIES`
`protected java.util.LinkedList<ProcessNode>`	`topLevelNodesCache` A cache for the top level nodes
`static java.lang.String`	`VALUE_XMLNS`
`static java.lang.String`	`VALUE_XMLNS_XSI`
`static java.lang.String`	`VALUE_XSI_SCHEMALOCATION`
`protected java.util.List<ProcessNode>`	`visibleNodesCache` A cache for the currently visible nodes

Constructor Summary

Constructors
Constructor and Description

ProcessModel()
Creates a new ProcessModel.

ProcessModel(java.lang.String name)
Creates a new ProcessModel with a name.

Constructors
Constructor and Description
`ProcessModel()` Creates a new ProcessModel.
`ProcessModel(java.lang.String name)` Creates a new ProcessModel with a name.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEdge(ProcessEdge f)` Adds a process edge to the model.
`void`	`addListener(ProcessModelListener listener)` Adds a listener to this ProcessModel.
`void`	`addNode(ProcessNode node)` Adds a process node to the model.
`void`	`addObject(ProcessObject object)`
`void`	`addTransactionHandler(TransactionHandlerInterface h)` Adds a transaction handler.
`protected void`	`clearCaches()` Clears the caches after a model change.
`ProcessModel`	`clone()` Creates a deep-copy of this ProcessModel, including all edges and nodes, but NOT listeners AND only reference to transient properties.
`ProcessModel`	`clonePersistent()` Like clone, but does not copy transient properties.
`AttachedNode`	`getAttachedNode(ProcessNode parent)`
`AttachedNodeHandler`	`getAttachedNodeHandler()` Returns an (optional) AttachedNodeHandler.
`java.awt.Color`	`getBackgroundColor()`
`Cluster`	`getClusterForNode(ProcessNode node)` Returns the Cluster where the ProcessNode is contained, null if not in any Cluster.
`java.util.List<Cluster>`	`getClusters()` Returns the list of contained Clusters.
`ProcessEdge`	`getConnectingEdge(ProcessNode node1, ProcessNode node2)`
`java.util.List<java.lang.Class<? extends ProcessNode>>`	`getCreateableNodeClasses()`
`java.lang.String`	`getCreationDate()` Returns the creation date of this ProcessModel.
`abstract java.lang.String`	`getDescription()` Returns a single string describing the kind of model this ProcessModel supports.
`java.util.List<ProcessEdge>`	`getEdges()` Returns the list of process edges.
`java.lang.String`	`getId()` Returns the id of this ProcessModel
`java.util.List<ProcessEdge>`	`getIncomingEdges(java.lang.Class<? extends ProcessEdge> type, ProcessNode node)` Returns all incoming Edges of a certain type.
`java.util.List<ProcessNode>`	`getNeighbourNodes(java.lang.Class<? extends ProcessEdge> type, ProcessNode node)` Returns all nodes that are connected via exactly one edge to the given node
`ProcessNode`	`getNodeAt(java.awt.Point p)` Returns the ProcessNode of the model that lies on the given position
`ProcessNode`	`getNodeById(java.lang.String id)` Returns the ProcessNode of the model that belongs to a certain id.
`java.util.LinkedList<ProcessNode>`	`getNodeByName(java.lang.String name)` Returns the ProcessNode(s) of the model that have the given name.
`java.util.List<ProcessNode>`	`getNodes()` Returns the list of contained process nodes.
`java.util.List<ProcessNode>`	`getNodesByClass(java.lang.Class<?> c)` Returns a list of all contained nodes with a certain class.
`ProcessObject`	`getObjectById(java.lang.String id)`
`java.util.List<ProcessObject>`	`getObjects()` Returns all ProcessObjects (combination of Nodes and Edges) in this model.
`java.util.List<ProcessEdge>`	`getOutgoingEdges(java.lang.Class<? extends ProcessEdge> type, ProcessNode node)` Returns all outgoing edges of a certain type.
`java.util.List<ProcessNode>`	`getPrecedingNodes(java.lang.Class<? extends ProcessEdge> type, ProcessNode node)` Returns all nodes that lead to the given Node directly.
`java.util.List<ProcessEdge>`	`getPreceedingEdges(ProcessNode node)`
`java.util.List<ProcessNode>`	`getPredecessors(ProcessNode n)` Returns the list of predecessor nodes for a node n.
`java.lang.String`	`getProcessModelURI()` Returns the URI for this ProcessModel.
`java.lang.String`	`getProcessName()` Returns the name of the process model.
`java.lang.String`	`getProperty(java.lang.String key)` Returns a property.
`java.util.Set<java.lang.String>`	`getPropertyKeys()` Returns the set of keys of the properties.
`org.w3c.dom.Document`	`getSerialization()` Returns a serialization of the Process Model.
`java.awt.Dimension`	`getSize()` Returns the dimension of this model.
`java.util.List<ProcessNode>`	`getSucceedingNodes(java.lang.Class<? extends ProcessEdge> type, ProcessNode node)` Returns all nodes that follow the given Node directly.
`java.util.List<ProcessNode>`	`getSuccessors(ProcessNode n)` Returns the list of successor nodes for a node n.
`abstract java.util.List<java.lang.Class<? extends ProcessEdge>>`	`getSupportedEdgeClasses()` Returns the list of supported edge classes for this model.
`abstract java.util.List<java.lang.Class<? extends ProcessNode>>`	`getSupportedNodeClasses()` Returns the list of supported node classes for this model.
`java.util.LinkedList<ProcessNode>`	`getTopLevelNodes()` This method returns the top level nodes of this model (i.e. all that are not contained in a Cluster)
`java.lang.Object`	`getTransientProperty(java.lang.String key)` Returns a transient (non-serialized) property.
`java.util.Set<java.lang.String>`	`getTransientPropertyKeys()` Returns the currently registered transient property keys.
`ProcessUtils`	`getUtils()` Returns the corresponding ProcessUtils.
`java.util.List<ProcessNode>`	`getVisibleNodes()` This method returns a list of all currently vissible nodes, i.e.
`protected void`	`init()`
`boolean`	`isDirty()`
`boolean`	`isLayouted()` Returns false if all of the nodes of this ProcessModel are located at (0,0).
`boolean`	`isOnlineModel()` Checks whether this model has an URI on a server, so that it can be found online.
`void`	`markAsDirty(boolean dirty)`
`void`	`moveAfter(ProcessNode n, ProcessNode baseNode)` Moves the given ProcessNode n after the ProcessNode baseNode; i.e.
`void`	`moveToBack(ProcessNode n)` Moves the given ProcessNode to the start of the NodeList; i.e. it should be drawn first.
`void`	`moveToFront(ProcessNode n)` Moves the given ProcessNode to the end of the NodeList; i.e. it should be drawn last.
`void`	`propertyChanged(ProcessObject o, java.lang.String key, java.lang.String oldValue, java.lang.String newValue)`
`void`	`removeEdge(ProcessEdge f)` Removes a process edge from the model.
`void`	`removeListener(ProcessModelListener listener)` Removes a istener from this ProcessModel.
`void`	`removeNode(ProcessNode node)` Removes a ProcessNode from the ProcessModel (incl. edges).
`void`	`removeNode(ProcessNode node, boolean includeEdges)` Removes a ProcessNode from the ProcessModel (care of Edge handling required).
`void`	`removeObject(ProcessObject object)`
`void`	`removeObject(ProcessObject object, boolean includeEdges)`
`void`	`removeProperty(java.lang.String key)` Removes a property.
`void`	`removeTransactionHandler(TransactionHandlerInterface h)` Removes a transaction handler.
`void`	`removeTransientProperty(java.lang.String key)` Removes a transient (non-serialized) property.
`void`	`setBackgroundColor(java.awt.Color c)`
`void`	`setId(java.lang.String id)` Sets the id of this ProcessModel.
`void`	`setProcessModelURI(java.lang.String processModelURI)` Sets the URI for this ProcessModel.
`void`	`setProcessName(java.lang.String processName)` Sets the name for this process model.
`void`	`setProperty(java.lang.String key, java.lang.String value)` Sets a property.
`void`	`setTransientProperty(java.lang.String key, java.lang.Object value)` Sets a transient (non-serialized) property.
`void`	`setUtils(ProcessUtils utils)` Sets the ProcessUtils.
`void`	`startTransaction()` Starts a transaction on this model.
`void`	`stopTransaction()` Ends a transaction on this model.
`void`	`substitute(ProcessObject original, ProcessObject substituteBy)`
`void`	`substitute(ProcessObject original, ProcessObject substituteBy, boolean onlyUpdateEnvironment)`
`java.lang.String`	`toString()` Returns a short textual description of the process model.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ATTR_XMLNS
```
public static final java.lang.String ATTR_XMLNS
```
    Serialization properties
    
    See Also:
    
    Constant Field Values
  - VALUE_XMLNS
```
public static final java.lang.String VALUE_XMLNS
```
    See Also:
    
    Constant Field Values
  - ATTR_XMLNS_XSI
```
public static final java.lang.String ATTR_XMLNS_XSI
```
    See Also:
    
    Constant Field Values
  - VALUE_XMLNS_XSI
```
public static final java.lang.String VALUE_XMLNS_XSI
```
    See Also:
    
    Constant Field Values
  - ATTR_XSI_SCHEMALOCATION
```
public static final java.lang.String ATTR_XSI_SCHEMALOCATION
```
    See Also:
    
    Constant Field Values
  - VALUE_XSI_SCHEMALOCATION
```
public static final java.lang.String VALUE_XSI_SCHEMALOCATION
```
    See Also:
    
    Constant Field Values
  - TAG_MODEL
```
public static final java.lang.String TAG_MODEL
```
    See Also:
    
    Constant Field Values
  - TAG_NODES
```
public static final java.lang.String TAG_NODES
```
    See Also:
    
    Constant Field Values
  - TAG_EDGES
```
public static final java.lang.String TAG_EDGES
```
    See Also:
    
    Constant Field Values
  - TAG_PROPERTIES
```
public static final java.lang.String TAG_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - ATTR_NAME
```
public static final java.lang.String ATTR_NAME
```
    See Also:
    
    Constant Field Values
  - ATTR_TYPE
```
public static final java.lang.String ATTR_TYPE
```
    See Also:
    
    Constant Field Values
  - ATTR_ID
```
public static final java.lang.String ATTR_ID
```
    See Also:
    
    Constant Field Values
  - ATTR_PARENT_REF
```
public static final java.lang.String ATTR_PARENT_REF
```
    Optional attribute that references to the model that has a reference to the actual model (and was used to open it)
    
    See Also:
    
    Constant Field Values
  - processUtils
```
protected ProcessUtils processUtils
```
    An instance of a sub-class of ProcessUtils
  - predecessorCache
```
protected java.util.Map<ProcessNode,java.util.List<ProcessNode>> predecessorCache
```
    A cache for the predecessors of a node
  - topLevelNodesCache
```
protected java.util.LinkedList<ProcessNode> topLevelNodesCache
```
    A cache for the top level nodes
  - visibleNodesCache
```
protected java.util.List<ProcessNode> visibleNodesCache
```
    A cache for the currently visible nodes
  - precEdgeCache
```
protected java.util.Map<ProcessNode,java.util.List<ProcessEdge>> precEdgeCache
```
    A cache for the incoming edges of a node
  - id
```
protected java.lang.String id
```
  - PROP_PROCESS_NAME
```
public static final java.lang.String PROP_PROCESS_NAME
```
    The name of the ProcessModel
    
    See Also:
    
    Constant Field Values
  - PROP_PROCESS_URI
```
public static final java.lang.String PROP_PROCESS_URI
```
    The URI for this model (if applicable)
    
    See Also:
    
    Constant Field Values
  - PROP_EDITOR
```
public static final java.lang.String PROP_EDITOR
```
    A field for the owner of this model (if applicable
    
    See Also:
    
    Constant Field Values
  - PROP_CREATE_DATE
```
public static final java.lang.String PROP_CREATE_DATE
```
    The creation date of the ProcessModel
    
    See Also:
    
    Constant Field Values
  - PROP_AUTHOR
```
public static final java.lang.String PROP_AUTHOR
```
    The author of this ProcessModel
    
    See Also:
    
    Constant Field Values
  - PROP_COMMENT
```
public static final java.lang.String PROP_COMMENT
```
    A comment for this ProcessModel
    
    See Also:
    
    Constant Field Values
  - PROP_SOURCE_VERSION
```
public static final java.lang.String PROP_SOURCE_VERSION
```
    The source version of this ProcessModel (optional)
    
    See Also:
    
    Constant Field Values
  - PROP_FOLDERALIAS
```
public static final java.lang.String PROP_FOLDERALIAS
```
    An optional property holding the source folder alias
    
    See Also:
    
    Constant Field Values
  - PROP_LASTCHECKIN
```
public static final java.lang.String PROP_LASTCHECKIN
```
    The last time this model was changed
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProcessModel
```
public ProcessModel()
```
    Creates a new ProcessModel.
  - ProcessModel
```
public ProcessModel(java.lang.String name)
```
    Creates a new ProcessModel with a name.
    
    Parameters:
    
    name -
- Method Detail
  - init
```
protected void init()
```
  - markAsDirty
```
public void markAsDirty(boolean dirty)
```
  - isDirty
```
public boolean isDirty()
```
  - getDescription
```
public abstract java.lang.String getDescription()
```
    Returns a single string describing the kind of model this ProcessModel supports.
    
    Returns:
  - clearCaches
```
protected void clearCaches()
```
    Clears the caches after a model change.
  - clonePersistent
```
public ProcessModel clonePersistent()
                             throws java.lang.Exception
```
    Like clone, but does not copy transient properties. Uses Serializer-Deserializer pattern.
    
    Throws:
    
    java.lang.Exception
  - clone
```
public ProcessModel clone()
```
    Creates a deep-copy of this ProcessModel, including all edges and nodes, but NOT listeners AND only reference to transient properties.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
  - getNodeById
```
public ProcessNode getNodeById(java.lang.String id)
```
    Returns the ProcessNode of the model that belongs to a certain id.
    
    Parameters:
    
    id -
    
    Returns:
  - getNodeByName
```
public java.util.LinkedList<ProcessNode> getNodeByName(java.lang.String name)
```
    Returns the ProcessNode(s) of the model that have the given name. More than one node is potentially returned since multiple nodes can have the same name. Returns an empty List if no node was found
    
    Parameters:
    
    id -
    
    Returns:
  - getObjectById
```
public ProcessObject getObjectById(java.lang.String id)
```
  - getNodeAt
```
public ProcessNode getNodeAt(java.awt.Point p)
```
    Returns the ProcessNode of the model that lies on the given position
    
    Parameters:
    
    id -
    
    Returns:
    
    null if nothing was found at that location
  - getAttachedNodeHandler
```
public AttachedNodeHandler getAttachedNodeHandler()
```
    Returns an (optional) AttachedNodeHandler.
    
    Returns:
  - addListener
```
public void addListener(ProcessModelListener listener)
```
    Adds a listener to this ProcessModel.
    
    Parameters:
    
    listener -
  - removeListener
```
public void removeListener(ProcessModelListener listener)
```
    Removes a istener from this ProcessModel.
    
    Parameters:
    
    listener -
  - getProcessName
```
public java.lang.String getProcessName()
```
    Returns the name of the process model.
    
    Returns:
  - setProcessName
```
public void setProcessName(java.lang.String processName)
```
    Sets the name for this process model.
    
    Parameters:
    
    processName -
  - getId
```
public java.lang.String getId()
```
    Returns the id of this ProcessModel
    
    Returns:
  - setId
```
public void setId(java.lang.String id)
```
    Sets the id of this ProcessModel.
    
    Parameters:
    
    id -
  - getProcessModelURI
```
public java.lang.String getProcessModelURI()
```
    Returns the URI for this ProcessModel.
    Set after a model is loaded.
    
    Returns:
  - setProcessModelURI
```
public void setProcessModelURI(java.lang.String processModelURI)
```
    Sets the URI for this ProcessModel.
    
    Parameters:
    
    processModelURI -
  - getCreationDate
```
public java.lang.String getCreationDate()
```
    Returns the creation date of this ProcessModel.
    
    Returns:
  - addEdge
```
public void addEdge(ProcessEdge f)
```
    Adds a process edge to the model.
    
    Parameters:
    
    f -
  - removeEdge
```
public void removeEdge(ProcessEdge f)
```
    Removes a process edge from the model.
    
    Parameters:
    
    f -
  - getEdges
```
public java.util.List<ProcessEdge> getEdges()
```
    Returns the list of process edges.
    
    Returns:
  - addNode
```
public void addNode(ProcessNode node)
```
    Adds a process node to the model.
    
    Parameters:
    
    o -
  - removeNode
```
public void removeNode(ProcessNode node)
```
    Removes a ProcessNode from the ProcessModel (incl. edges).
    
    Parameters:
    
    o -
  - removeNode
```
public void removeNode(ProcessNode node,
                       boolean includeEdges)
```
    Removes a ProcessNode from the ProcessModel (care of Edge handling required).
    
    Parameters:
    
    node -
  - getNodes
```
public java.util.List<ProcessNode> getNodes()
```
    Returns the list of contained process nodes.
    
    Returns:
  - getNodesByClass
```
public java.util.List<ProcessNode> getNodesByClass(java.lang.Class<?> c)
```
    Returns a list of all contained nodes with a certain class.
    
    Parameters:
    
    c -
    
    Returns:
  - getClusters
```
public java.util.List<Cluster> getClusters()
```
    Returns the list of contained Clusters.
    
    Returns:
  - getObjects
```
public java.util.List<ProcessObject> getObjects()
```
    Returns all ProcessObjects (combination of Nodes and Edges) in this model.
    
    Returns:
  - getClusterForNode
```
public Cluster getClusterForNode(ProcessNode node)
```
    Returns the Cluster where the ProcessNode is contained, null if not in any Cluster.
    
    Parameters:
    
    node -
    
    Returns:
  - getSuccessors
```
public java.util.List<ProcessNode> getSuccessors(ProcessNode n)
```
    Returns the list of successor nodes for a node n.
    
    Parameters:
    
    n -
    
    Returns:
  - getPredecessors
```
public java.util.List<ProcessNode> getPredecessors(ProcessNode n)
```
    Returns the list of predecessor nodes for a node n.
    
    Parameters:
    
    n -
    
    Returns:
  - getSupportedNodeClasses
```
public abstract java.util.List<java.lang.Class<? extends ProcessNode>> getSupportedNodeClasses()
```
    Returns the list of supported node classes for this model. This method needs to be implemented.
    
    Returns:
  - getCreateableNodeClasses
```
public java.util.List<java.lang.Class<? extends ProcessNode>> getCreateableNodeClasses()
```
  - getSize
```
public java.awt.Dimension getSize()
```
    Returns the dimension of this model.
    
    Returns:
  - getSupportedEdgeClasses
```
public abstract java.util.List<java.lang.Class<? extends ProcessEdge>> getSupportedEdgeClasses()
```
    Returns the list of supported edge classes for this model. This method needs to be implemented.
    
    Returns:
  - getUtils
```
public ProcessUtils getUtils()
```
    Returns the corresponding ProcessUtils.
  - setUtils
```
public void setUtils(ProcessUtils utils)
```
    Sets the ProcessUtils.
    
    Parameters:
    
    utils -
  - moveAfter
```
public void moveAfter(ProcessNode n,
                      ProcessNode baseNode)
```
    Moves the given ProcessNode n after the ProcessNode baseNode; i.e. it is drawn later. If n is a Cluster, it is processed recursivly.
    
    Parameters:
    
    n -
    
    baseNode -
  - moveToBack
```
public void moveToBack(ProcessNode n)
```
    Moves the given ProcessNode to the start of the NodeList; i.e. it should be drawn first.
    
    Parameters:
    
    n -
  - moveToFront
```
public void moveToFront(ProcessNode n)
```
    Moves the given ProcessNode to the end of the NodeList; i.e. it should be drawn last.
    
    Parameters:
    
    n -
  - isLayouted
```
public boolean isLayouted()
```
    Returns false if all of the nodes of this ProcessModel are located at (0,0).
    
    Returns:
  - isOnlineModel
```
public boolean isOnlineModel()
```
    Checks whether this model has an URI on a server, so that it can be found online.
    
    Returns:
    
    True If the model has an URI to a server False if it is a local model
  - getIncomingEdges
```
public java.util.List<ProcessEdge> getIncomingEdges(java.lang.Class<? extends ProcessEdge> type,
                                                    ProcessNode node)
```
    Returns all incoming Edges of a certain type.
    
    Parameters:
    
    type -
    
    node -
    
    Returns:
  - getOutgoingEdges
```
public java.util.List<ProcessEdge> getOutgoingEdges(java.lang.Class<? extends ProcessEdge> type,
                                                    ProcessNode node)
```
    Returns all outgoing edges of a certain type.
    
    Parameters:
    
    type -
    
    node -
    
    Returns:
  - getSucceedingNodes
```
public java.util.List<ProcessNode> getSucceedingNodes(java.lang.Class<? extends ProcessEdge> type,
                                                      ProcessNode node)
```
    Returns all nodes that follow the given Node directly.
    
    Parameters:
    
    type - connecting edge need to be descendant of given type
    
    node -
    
    Returns:
  - getPrecedingNodes
```
public java.util.List<ProcessNode> getPrecedingNodes(java.lang.Class<? extends ProcessEdge> type,
                                                     ProcessNode node)
```
    Returns all nodes that lead to the given Node directly.
    
    Parameters:
    
    type - connecting edge need to be descendant of given type
    
    node -
    
    Returns:
  - getNeighbourNodes
```
public java.util.List<ProcessNode> getNeighbourNodes(java.lang.Class<? extends ProcessEdge> type,
                                                     ProcessNode node)
```
    Returns all nodes that are connected via exactly one edge to the given node
    
    Parameters:
    
    type - connecting edge need to be descendant of given type
    
    node -
    
    Returns:
  - toString
```
public java.lang.String toString()
```
    Returns a short textual description of the process model.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
  - getSerialization
```
public org.w3c.dom.Document getSerialization()
                                      throws java.lang.Exception
```
    Returns a serialization of the Process Model. ATTENTION: Not all properties are serialized; esp. userObject() from ProcessNode is not included! Sub-classses of ProcessNode and ProcessEdge might implement further serialization properties.
    
    Returns:
    
    A Document containing the process model serialized as XML.
    
    Throws:
    
    java.lang.Exception
  - setProperty
```
public void setProperty(java.lang.String key,
                        java.lang.String value)
```
    Sets a property.
    
    Parameters:
    
    key -
    
    value -
  - removeProperty
```
public void removeProperty(java.lang.String key)
```
    Removes a property.
    
    Parameters:
    
    key -
  - getProperty
```
public java.lang.String getProperty(java.lang.String key)
```
    Returns a property.
    
    Parameters:
    
    key -
    
    Returns:
  - getPropertyKeys
```
public java.util.Set<java.lang.String> getPropertyKeys()
```
    Returns the set of keys of the properties.
    
    Returns:
  - setTransientProperty
```
public void setTransientProperty(java.lang.String key,
                                 java.lang.Object value)
```
    Sets a transient (non-serialized) property.
    
    Parameters:
    
    key -
    
    value -
  - removeTransientProperty
```
public void removeTransientProperty(java.lang.String key)
```
    Removes a transient (non-serialized) property.
    
    Parameters:
    
    key -
  - getTransientProperty
```
public java.lang.Object getTransientProperty(java.lang.String key)
```
    Returns a transient (non-serialized) property.
    
    Parameters:
    
    key -
    
    Returns:
  - getTransientPropertyKeys
```
public java.util.Set<java.lang.String> getTransientPropertyKeys()
```
    Returns the currently registered transient property keys.
    
    Returns:
  - getBackgroundColor
```
public java.awt.Color getBackgroundColor()
```
    Returns:
  - setBackgroundColor
```
public void setBackgroundColor(java.awt.Color c)
```
  - addObject
```
public void addObject(ProcessObject object)
```
    Parameters:
    
    object -
    
    Throws:
    
    java.lang.Exception
  - removeObject
```
public void removeObject(ProcessObject object)
```
    Parameters:
    
    object -
  - removeObject
```
public void removeObject(ProcessObject object,
                         boolean includeEdges)
```
  - substitute
```
public void substitute(ProcessObject original,
                       ProcessObject substituteBy,
                       boolean onlyUpdateEnvironment)
```
  - substitute
```
public void substitute(ProcessObject original,
                       ProcessObject substituteBy)
```
  - getConnectingEdge
```
public ProcessEdge getConnectingEdge(ProcessNode node1,
                                     ProcessNode node2)
```
  - getAttachedNode
```
public AttachedNode getAttachedNode(ProcessNode parent)
```
  - getTopLevelNodes
```
public java.util.LinkedList<ProcessNode> getTopLevelNodes()
```
    This method returns the top level nodes of this model (i.e. all that are not contained in a Cluster)
  - getVisibleNodes
```
public java.util.List<ProcessNode> getVisibleNodes()
```
    This method returns a list of all currently vissible nodes, i.e. excluding all nodes that are inside collapsed clusters (recursivly).
  - getPreceedingEdges
```
public java.util.List<ProcessEdge> getPreceedingEdges(ProcessNode node)
```
  - startTransaction
```
public void startTransaction()
```
    Starts a transaction on this model.
  - stopTransaction
```
public void stopTransaction()
```
    Ends a transaction on this model.
  - addTransactionHandler
```
public void addTransactionHandler(TransactionHandlerInterface h)
```
    Adds a transaction handler. A transaction handler is called each time a transaction is started or stopped.
    
    Parameters:
    
    h -
  - removeTransactionHandler
```
public void removeTransactionHandler(TransactionHandlerInterface h)
```
    Removes a transaction handler.
    
    Parameters:
    
    h -
  - propertyChanged
```
public void propertyChanged(ProcessObject o,
                            java.lang.String key,
                            java.lang.String oldValue,
                            java.lang.String newValue)
```
    Specified by:
    
    propertyChanged in interface ProcessObjectListener

Class ProcessModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTR_XMLNS

VALUE_XMLNS

ATTR_XMLNS_XSI

VALUE_XMLNS_XSI

ATTR_XSI_SCHEMALOCATION

VALUE_XSI_SCHEMALOCATION

TAG_MODEL

TAG_NODES

TAG_EDGES

TAG_PROPERTIES

ATTR_NAME

ATTR_TYPE

ATTR_ID

ATTR_PARENT_REF

processUtils

predecessorCache

topLevelNodesCache

visibleNodesCache

precEdgeCache

id

PROP_PROCESS_NAME

PROP_PROCESS_URI

PROP_EDITOR

PROP_CREATE_DATE

PROP_AUTHOR

PROP_COMMENT

PROP_SOURCE_VERSION

PROP_FOLDERALIAS

PROP_LASTCHECKIN

Constructor Detail

ProcessModel

ProcessModel

Method Detail

init

markAsDirty

isDirty

getDescription

clearCaches

clonePersistent

clone

getNodeById

getNodeByName

getObjectById

getNodeAt

getAttachedNodeHandler

addListener

removeListener

getProcessName

setProcessName

getId

setId

getProcessModelURI

setProcessModelURI

getCreationDate

addEdge

removeEdge

getEdges

addNode

removeNode

removeNode

getNodes

getNodesByClass

getClusters

getObjects

getClusterForNode

getSuccessors

getPredecessors

getSupportedNodeClasses

getCreateableNodeClasses

getSize

getSupportedEdgeClasses

getUtils

setUtils

moveAfter