org.girod.jgraphml.model

Class AbstractGraphMLNode

java.lang.Object

org.girod.jgraphml.model.AbstractIDElement

org.girod.jgraphml.model.AbstractGraphMLNode

All Implemented Interfaces:

java.lang.Cloneable, IDElement, IGraphMLNode, Labeled, ShapeType

Direct Known Subclasses:

GraphMLGroupNode, GraphMLNode

public abstract class AbstractGraphMLNode
extends AbstractIDElement
implements IGraphMLNode, ShapeType, java.lang.Cloneable

An abstract graph node.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractGraphMLDiagram	diagram The diagram.

Fields inherited from class org.girod.jgraphml.model.AbstractIDElement

id

Fields inherited from interface org.girod.jgraphml.model.ShapeType

DIAMOND, ELLIPSE, FATARROW, FATARROW2, HEXAGON, OCTAGON, PARALLELOGRAM, PARALLELOGRAM2, RECTANGLE, RECTANGLE3D, ROUNDRECTANGLE, TRIANGLE, TRIANGLE2

Constructor Summary

Constructors

Constructor and Description
AbstractGraphMLNode(AbstractGraphMLDiagram diagram, java.lang.String id) Constructor.

Method Summary

Modifier and Type	Method and Description
GraphMLEdge	addEdgeFrom(IGraphMLNode source) Add an edge from another node to this one.
GraphMLEdge	addEdgeTo(IGraphMLNode target) Add an edge from this node to another one.
boolean	addFromEdge(GraphMLEdge edge) Add an edge originating from another node.
boolean	addToEdge(GraphMLEdge edge) Add an edge originating from this node.
AbstractGraphMLNode	clone() Clone the node.
void	computeSize(boolean recurse) Compute the size of the node.
AbstractGraphMLDiagram	getDiagram() Return the diagram.
java.util.Map<java.lang.String,java.util.List<GraphMLEdge>>	getFromEdges() Return the Map of edges originating from other nodes.
NodeParent	getParent() Return the node parent.
java.util.Map<java.lang.String,java.util.List<GraphMLEdge>>	getToEdges() Return the Map of edges originating from this node.
void	repatriate(AbstractGraphMLDiagram diagram) Repatriate the node to another diagram.
void	repatriate(AbstractGraphMLDiagram diagram, boolean detach) Repatriate the node to another diagram.
boolean	setFromPortConstraint(short side) Set port constraints on all edges originating from this node.
boolean	setFromPortConstraint(java.lang.String side) Set port constraints on all edges originating from this node.
void	setId(java.lang.String id) Set a new id for the node.
void	setParent(NodeParent parent) Set the node parent.
boolean	setToPortConstraint(short side) Set port constraints on all edges originating from another node.
boolean	setToPortConstraint(java.lang.String side) Set port constraints on all edges originating from this node.

Methods inherited from class org.girod.jgraphml.model.AbstractIDElement

getDescription, getID, getURL, getURLAsString, hasURL, setDescription, setURL, setURL

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.girod.jgraphml.model.IGraphMLNode

computeSize, computeSize, getOpenedShapeNode, getRealizedShapeNode, setDefaultGeometry, setLabel, updateLabel

Methods inherited from interface org.girod.jgraphml.model.IDElement

getDescription, getID, getURL, getURLAsString, hasDescription, hasURL, isTemplate, setDescription, setURL, setURL

Methods inherited from interface org.girod.jgraphml.model.ShapeType

hasBorderColor, hasFillColor, setAutosized, setBorderColor, setBorderStyle, setDropShadow, setFillColor, setFillColor, setGeometry, setHasBorderColor, setHasFillColor, setHeightPadding, setLabel, setLabel, setType, setWidthPadding

Field Detail

diagram

protected AbstractGraphMLDiagram diagram

The diagram.

Constructor Detail

AbstractGraphMLNode

public AbstractGraphMLNode(AbstractGraphMLDiagram diagram,
                           java.lang.String id)

Constructor.

Parameters:

diagram - the diagram

id - the node id

Method Detail

setId

public void setId(java.lang.String id)

Set a new id for the node.

Specified by:

setId in interface IGraphMLNode

Parameters:

id - the node

getDiagram

public AbstractGraphMLDiagram getDiagram()

Return the diagram.

Specified by:

getDiagram in interface IGraphMLNode

Returns:

the diagram

setParent

public void setParent(NodeParent parent)

Set the node parent.

Specified by:

setParent in interface IGraphMLNode

Parameters:

parent - the parent

getParent

public NodeParent getParent()

Return the node parent.

Specified by:

getParent in interface IGraphMLNode

Returns:

the parent

repatriate

public void repatriate(AbstractGraphMLDiagram diagram,
                       boolean detach)

Repatriate the node to another diagram.

Specified by:

repatriate in interface IGraphMLNode

Parameters:

diagram - the new diagram

detach - detach the node from its current diagram

repatriate

public void repatriate(AbstractGraphMLDiagram diagram)

Repatriate the node to another diagram.

Specified by:

repatriate in interface IGraphMLNode

Parameters:

diagram - the new diagram

computeSize

public void computeSize(boolean recurse)

Compute the size of the node.

Specified by:

computeSize in interface IGraphMLNode

Parameters:

recurse - recurse on children nodes

clone

public AbstractGraphMLNode clone()

Description copied from interface: IGraphMLNode

Clone the node.

Specified by:

clone in interface IGraphMLNode

Overrides:

clone in class AbstractIDElement

Returns:

the cloned node

getFromEdges

public java.util.Map<java.lang.String,java.util.List<GraphMLEdge>> getFromEdges()

Return the Map of edges originating from other nodes.

Specified by:

getFromEdges in interface IGraphMLNode

Returns:

the edges sorted by their source node id

getToEdges

public java.util.Map<java.lang.String,java.util.List<GraphMLEdge>> getToEdges()

Return the Map of edges originating from this node.

Specified by:

getToEdges in interface IGraphMLNode

Returns:

the edges sorted by their target node id

setFromPortConstraint

public boolean setFromPortConstraint(short side)

Set port constraints on all edges originating from this node.

Parameters:

side - the side constraint

Returns:

true if the constraint could be set or unset

setFromPortConstraint

public boolean setFromPortConstraint(java.lang.String side)

Set port constraints on all edges originating from this node.

Parameters:

side - the side constraint

Returns:

true if the constraint could be set or unset

setToPortConstraint

public boolean setToPortConstraint(short side)

Set port constraints on all edges originating from another node.

Parameters:

side - the side constraint

Returns:

true if the constraint could be set or unset

setToPortConstraint

public boolean setToPortConstraint(java.lang.String side)

Set port constraints on all edges originating from this node.

Parameters:

side - the side constraint

Returns:

true if the constraint could be set or unset

addFromEdge

public boolean addFromEdge(GraphMLEdge edge)

Add an edge originating from another node.

Specified by:

addFromEdge in interface IGraphMLNode

Parameters:

edge - the edge

Returns:

true if it as possible to add the edge (ie the edge source exists)

addEdgeTo

public GraphMLEdge addEdgeTo(IGraphMLNode target)

Add an edge from this node to another one.

Specified by:

addEdgeTo in interface IGraphMLNode

Parameters:

target - the target node

Returns:

the edge

addEdgeFrom

public GraphMLEdge addEdgeFrom(IGraphMLNode source)

Add an edge from another node to this one.

Specified by:

addEdgeFrom in interface IGraphMLNode

Parameters:

source - the source node

Returns:

the edge

addToEdge

public boolean addToEdge(GraphMLEdge edge)

Add an edge originating from this node.

Specified by:

addToEdge in interface IGraphMLNode

Parameters:

edge - the edge

Returns:

true if it as possible to add the edge (ie the edge target exists)