net.frapu.code.visualization

Class ProcessNode

java.lang.Object

net.frapu.code.visualization.SerializableProcessObject

net.frapu.code.visualization.ProcessObject

net.frapu.code.visualization.ProcessNode

All Implemented Interfaces:

java.lang.Cloneable, Dragable

Direct Known Subclasses:

Action, Actor, BarChart, BaseElement, BusinessObject, CaseFileItem, Clock, Cluster, Comment, Comment, Comment, Comment, Connector, Criterion, DataObject, DomainClass, DomainClassReference, DummyNode, EdgeDocker, Event, EventListener, FlowObject, Function, Milestone, Module, OntologyNode, OrgChartElement, OrgUnit, PieChart, Place, Process, ProcessGroup, ProcessOwner, ProcessPath, Rule, Service, Stop, System, Task, TimeBar, ToolDocker, ToolErrorConnector, Transition, UMLClass, UMLClassReference

public abstract class ProcessNode
extends ProcessObject
implements Dragable

This class provides an abstract representation of a process node.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_ANNOTATION
static java.lang.String	PROP_BACKGROUND The background color (see java.awt.Color) for values
static java.lang.String	PROP_HEIGHT
static java.lang.String	PROP_LABEL
static java.lang.String	PROP_MODULEID
static java.lang.String	PROP_REF Optional property that might be used to reference from one node to one or more others
static java.lang.String	PROP_SHADOW
static java.lang.String	PROP_STEREOTYPE
static java.lang.String	PROP_TEXT
static java.lang.String	PROP_WIDTH
static java.lang.String	PROP_XPOS
static java.lang.String	PROP_YPOS
static java.lang.String	TAG_NODE
protected java.lang.Object	userObject Stores a user definable Object that will not be serialized by default

Fields inherited from class net.frapu.code.visualization.ProcessObject

contexts, FALSE, PROP_CLASS_TYPE, PROP_ID, TRUE

Constructor Summary

Constructors

Constructor and Description
ProcessNode()

Method Summary

Modifier and Type	Method and Description
void	addConnectionPoint(int x, int y) Adds a relative(!)
void	checkDefaultConnectionPoints()
ProcessNode	clone()
boolean	connectionPointContained(java.awt.Point connectionPoint)
boolean	contains(java.awt.Point p) Do not use getOutlineShape().contains() to check whether a Point is contained.
boolean	containsDeepInside(java.awt.Point p) This methods returns true if the given Point and all 8 directly surrounding points are contained in this node.
ProcessNode	copy() Deprecated.
java.awt.Color	getBackground()
static java.awt.Color	getBackground(java.lang.String colorPropertyValue)
java.awt.Rectangle	getBoundingBox() Returns the bounding box for this ProcessNode.
java.awt.Rectangle	getBounds()
java.awt.Point	getConnectionPoint(int x, int y)
java.awt.Point	getConnectionPoint(java.awt.Point target) Returns the nearest absolute(!)
java.awt.Point	getConnectionPoint(java.util.Set<java.awt.Point> defaultConnectionPoints, java.awt.Point targetPos) Finds the best Connection points respecting all possible connection Point of another node
java.util.Set<java.awt.Point>	getDefaultConnectionPoints() Returns the default connection points for this node.
java.lang.String	getName() Returns the Name of this ProcessObject
protected abstract java.awt.Shape	getOutlineShape() Returns the external shape of the given process node.
java.util.Set<Cluster>	getParentClusters()
java.awt.Point	getPos() Returns the center position of this ProcessNode.
java.awt.Point	getSelectionOffset()
java.awt.Dimension	getSize() Returns the size of this ProcessNode.
java.lang.String	getStereotype()
java.lang.String	getText()
java.awt.Point	getTopLeftPos() Returns the top left position of this ProcessNode.
java.lang.Object	getUserObject() Sets the user object for the process node.
java.util.List<java.lang.Class<? extends ProcessNode>>	getVariants() Returns the list of variants for this node, e.g. the node types that can be used to refactor this node.
protected java.lang.String	getXmlTag()
protected void	handleCloning(java.util.Map<java.lang.String,java.lang.String> localIdMap) hook so new classes can take special actions after cloning
boolean	isCluster() Returns if this node is an instance of a subclass of Cluster
boolean	isShadowEnabled()
boolean	isVisible() Returns if this ProcessNode should be rendered by the ProcessEditor or not.
static ProcessNode	newInstanceFromSerialization(org.w3c.dom.Node XMLnode)
void	paint(java.awt.Graphics g) Draws the flow object.
protected void	paintHighlight(java.awt.Graphics g) Paints the highlight around the flow object.
protected abstract void	paintInternal(java.awt.Graphics g) Paints the flow object on the given graphics.
protected void	paintSelection(java.awt.Graphics g) Paints the selection around the node (if selected).
void	removeAllConnectionPoints()
void	setBackground(java.awt.Color c)
void	setPos(int x, int y) Sets the center position of this ProcessNode.
void	setPos(java.awt.Point p) Sets the center position of this ProcessNode.
void	setProperty(java.lang.String key, java.lang.String value) Sets a property.
void	setShadowEnabled(boolean shadow)
void	setSize(java.awt.Dimension d)
void	setSize(int w, int h)
void	setStereotype(java.lang.String stereotype)
void	setText(java.lang.String text)
void	setUserObject(java.lang.Object userObject) Returns the user object for the process node.
void	setVisible(boolean visible) Defines whether this ProcessNode is visible or not (this selection is not serialized).
java.lang.String	toString()
void	updateReferences(java.util.List<Reference> references) Might be implemented by sub classes.

Methods inherited from class net.frapu.code.visualization.ProcessObject

addContext, addListener, equals, getAlpha, getContexts, getId, getPropertyEditor, isHighlighted, isSelected, removeContext, removeListener, setAlpha, setHighlighted, setId, setPropertyEditor, setSelected

Methods inherited from class net.frapu.code.visualization.SerializableProcessObject

getProperty, getPropertyKeys, getSerialization, removeProperty

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NODE

public static final java.lang.String TAG_NODE

See Also:

Constant Field Values

PROP_TEXT

public static final java.lang.String PROP_TEXT

See Also:

Constant Field Values

PROP_LABEL

public static final java.lang.String PROP_LABEL

See Also:

Constant Field Values

PROP_STEREOTYPE

public static final java.lang.String PROP_STEREOTYPE

See Also:

Constant Field Values

PROP_XPOS

public static final java.lang.String PROP_XPOS

See Also:

Constant Field Values

PROP_YPOS

public static final java.lang.String PROP_YPOS

See Also:

Constant Field Values

PROP_WIDTH

public static final java.lang.String PROP_WIDTH

See Also:

Constant Field Values

PROP_HEIGHT

public static final java.lang.String PROP_HEIGHT

See Also:

Constant Field Values

PROP_SHADOW

public static final java.lang.String PROP_SHADOW

See Also:

Constant Field Values

PROP_REF

public static final java.lang.String PROP_REF

Optional property that might be used to reference from one node to one or more others

See Also:

Constant Field Values

PROP_BACKGROUND

public static final java.lang.String PROP_BACKGROUND

The background color (see java.awt.Color) for values

See Also:

Constant Field Values

PROP_MODULEID

public static final java.lang.String PROP_MODULEID

See Also:

Constant Field Values

PROP_ANNOTATION

public static final java.lang.String PROP_ANNOTATION

See Also:

Constant Field Values

userObject

protected java.lang.Object userObject

Stores a user definable Object that will not be serialized by default

Constructor Detail

ProcessNode

public ProcessNode()

Method Detail

newInstanceFromSerialization

public static ProcessNode newInstanceFromSerialization(org.w3c.dom.Node XMLnode)
                                                throws java.lang.ClassNotFoundException,
                                                       java.lang.InstantiationException,
                                                       java.lang.IllegalAccessException,
                                                       java.lang.Exception

Throws:

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.Exception

clone

public ProcessNode clone()

Overrides:

clone in class ProcessObject

copy

@Deprecated
public ProcessNode copy()

Deprecated.

Creates a deep copy of this ProcessNode (inkl. Properties without id!).

paint

public void paint(java.awt.Graphics g)

Draws the flow object.

Parameters:

g -

paintInternal

protected abstract void paintInternal(java.awt.Graphics g)

Paints the flow object on the given graphics. Needs to be implemented by a subclass.

Parameters:

g -

getOutlineShape

protected abstract java.awt.Shape getOutlineShape()

Returns the external shape of the given process node. The shape is already scaled and moved to the corresponding position!

Returns:

paintSelection

protected void paintSelection(java.awt.Graphics g)

Paints the selection around the node (if selected). Might be implemented by a subclass.

Parameters:

g -

paintHighlight

protected void paintHighlight(java.awt.Graphics g)

Paints the highlight around the flow object.

Parameters:

g -

getConnectionPoint

public java.awt.Point getConnectionPoint(int x,
                                         int y)

getSelectionOffset

public java.awt.Point getSelectionOffset()

getConnectionPoint

public java.awt.Point getConnectionPoint(java.awt.Point target)

Returns the nearest absolute(!) connection point for a line from the flow object to (toX, toY)

Parameters:

toX -

toY -

getConnectionPoint

public java.awt.Point getConnectionPoint(java.util.Set<java.awt.Point> defaultConnectionPoints,
                                         java.awt.Point targetPos)

Finds the best Connection points respecting all possible connection Point of another node

Parameters:

defaultConnectionPoints -

Returns:

getDefaultConnectionPoints

public java.util.Set<java.awt.Point> getDefaultConnectionPoints()

Returns the default connection points for this node. Can be overridden by sub-classes to implement specific behavior. The default connection points are only used if no additional connection points have been specified!

Returns:

contains

public boolean contains(java.awt.Point p)

Do not use getOutlineShape().contains() to check whether a Point is contained. Use this method insead. The reason is that points that are located exactly on the outer left or lower line are not considred to be contatined, yet this is import for e.g. connection points. This methods also returns true if the point lies on a delimeter line.

Parameters:

p - as absolute value

Returns:

containsDeepInside

public boolean containsDeepInside(java.awt.Point p)

This methods returns true if the given Point and all 8 directly surrounding points are contained in this node. Thus it does not - in contrast to contains() - lie on the delimeter of this node

Parameters:

p - as absolute value

Returns:

connectionPointContained

public boolean connectionPointContained(java.awt.Point connectionPoint)

checkDefaultConnectionPoints

public final void checkDefaultConnectionPoints()

addConnectionPoint

public void addConnectionPoint(int x,
                               int y)

Adds a relative(!) connection point for the flow object.

Parameters:

x -

y -

removeAllConnectionPoints

public void removeAllConnectionPoints()

getSize

public java.awt.Dimension getSize()

Returns the size of this ProcessNode. Also consider getBoundingBox().

Returns:

getBoundingBox

public java.awt.Rectangle getBoundingBox()

Returns the bounding box for this ProcessNode. Default is the same as getOutlineShape. Might be overwritten by subclasses.

Returns:

setSize

public void setSize(int w,
                    int h)

setSize

public void setSize(java.awt.Dimension d)

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)

getStereotype

public java.lang.String getStereotype()

setStereotype

public void setStereotype(java.lang.String stereotype)

setPos

public void setPos(java.awt.Point p)

Sets the center position of this ProcessNode.

Specified by:

setPos in interface Dragable

Parameters:

p -

setPos

public void setPos(int x,
                   int y)

Sets the center position of this ProcessNode.

Parameters:

x -

y -

getPos

public java.awt.Point getPos()

Returns the center position of this ProcessNode.

Specified by:

getPos in interface Dragable

Returns:

getTopLeftPos

public java.awt.Point getTopLeftPos()

Returns the top left position of this ProcessNode.

Returns:

setShadowEnabled

public void setShadowEnabled(boolean shadow)

isShadowEnabled

public boolean isShadowEnabled()

setBackground

public void setBackground(java.awt.Color c)

getBackground

public java.awt.Color getBackground()

getBackground

public static java.awt.Color getBackground(java.lang.String colorPropertyValue)

getBounds

public java.awt.Rectangle getBounds()

isVisible

public boolean isVisible()

Returns if this ProcessNode should be rendered by the ProcessEditor or not.

Returns:

setVisible

public void setVisible(boolean visible)

Defines whether this ProcessNode is visible or not (this selection is not serialized).

Parameters:

visible -

getUserObject

public java.lang.Object getUserObject()

Sets the user object for the process node. This object will not (yet) be serialized.

Returns:

getXmlTag

protected java.lang.String getXmlTag()

Specified by:

getXmlTag in class SerializableProcessObject

setUserObject

public void setUserObject(java.lang.Object userObject)

Returns the user object for the process node.

Parameters:

userObject -

getVariants

public java.util.List<java.lang.Class<? extends ProcessNode>> getVariants()

Returns the list of variants for this node, e.g. the node types that can be used to refactor this node.

Returns:

isCluster

public boolean isCluster()

Returns if this node is an instance of a subclass of Cluster

Returns:

getName

public java.lang.String getName()

Description copied from class: ProcessObject

Returns the Name of this ProcessObject

Overrides:

getName in class ProcessObject

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

handleCloning

protected void handleCloning(java.util.Map<java.lang.String,java.lang.String> localIdMap)

hook so new classes can take special actions after cloning

Parameters:

localIdMap -

getParentClusters

public java.util.Set<Cluster> getParentClusters()

updateReferences

public void updateReferences(java.util.List<Reference> references)

Might be implemented by sub classes. Is called each time the references are updated. This method should change the properties of this node if applicable.

Parameters:

references -

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Description copied from class: ProcessObject

Sets a property.

Overrides:

setProperty in class ProcessObject