org.girod.jgraphml.model

Interface IGraphMLNode

All Superinterfaces:

java.lang.Cloneable, IDElement

All Known Implementing Classes:

AbstractGraphMLNode, GraphMLGroupNode, GraphMLGroupNodeTemplate, GraphMLNode, GraphMLNodeTemplate

public interface IGraphMLNode
extends IDElement, java.lang.Cloneable

A node interface.

Since:

1.2.3

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.
IGraphMLNode	clone() Clone the node.
void	computeSize(boolean recurse) Compute the size of the node.
void	computeSize(float groupNodePadding, boolean recurse) Compute the size of the node.
void	computeSize(float groupNodePadding, boolean realizedState, boolean recurse) Compute the size of the node.
AbstractGraphMLDiagram	getDiagram() Return the node diagram.
java.util.Map<java.lang.String,java.util.List<GraphMLEdge>>	getFromEdges() Return the Map of edges originating from other nodes.
ShapeNode	getOpenedShapeNode() Return the opened shape node.
NodeParent	getParent() Return the node parent.
ShapeNode	getRealizedShapeNode() Return the current realized shape node.
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.
void	setDefaultGeometry() Set the default geometry.
void	setId(java.lang.String id) Set a new id for the node.
NodeLabel	setLabel(java.lang.String text) Set the node label.
void	setParent(NodeParent parent) Set the node parent.
void	updateLabel() Called when the label is updated.

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

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

Method Detail

clone

IGraphMLNode clone()

Clone the node.

Returns:

the cloned node

setId

void setId(java.lang.String id)

Set a new id for the node.

Parameters:

id - the node

setLabel

NodeLabel setLabel(java.lang.String text)

Set the node label.

Parameters:

text - the label text

Returns:

the node label

getDiagram

AbstractGraphMLDiagram getDiagram()

Return the node diagram.

Returns:

the diagram

setParent

void setParent(NodeParent parent)

Set the node parent.

Parameters:

parent - the parent

getParent

NodeParent getParent()

Return the node parent.

Returns:

the parent

repatriate

void repatriate(AbstractGraphMLDiagram diagram,
                boolean detach)

Repatriate the node to another diagram.

Parameters:

diagram - the new diagram

detach - detach the node from its current diagram

repatriate

void repatriate(AbstractGraphMLDiagram diagram)

Repatriate the node to another diagram.

Parameters:

diagram - the new diagram

computeSize

void computeSize(boolean recurse)

Compute the size of the node.

Parameters:

recurse - recurse on children nodes

computeSize

void computeSize(float groupNodePadding,
                 boolean realizedState,
                 boolean recurse)

Compute the size of the node.

Parameters:

groupNodePadding - the padding between nodes used for computing group node sizes

realizedState - true for the state for which to compute the size

recurse - recurse on children nodes

computeSize

void computeSize(float groupNodePadding,
                 boolean recurse)

Compute the size of the node.

Parameters:

groupNodePadding - the padding between nodes used for computing group node sizes

recurse - recurse on children nodes

getOpenedShapeNode

ShapeNode getOpenedShapeNode()

Return the opened shape node.

Returns:

the opened shape node

getRealizedShapeNode

ShapeNode getRealizedShapeNode()

Return the current realized shape node.

Returns:

the current realized shape node

updateLabel

void updateLabel()

Called when the label is updated.

setDefaultGeometry

void setDefaultGeometry()

Set the default geometry.

getFromEdges

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

Return the Map of edges originating from other nodes.

Returns:

the edges sorted by their source node id

getToEdges

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

Return the Map of edges originating from this node.

Returns:

the edges sorted by their target node id

addFromEdge

boolean addFromEdge(GraphMLEdge edge)

Add an edge originating from another node.

Parameters:

edge - the edge

Returns:

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

addEdgeTo

GraphMLEdge addEdgeTo(IGraphMLNode target)

Add an edge from this node to another one.

Parameters:

target - the target node

Returns:

the edge

addEdgeFrom

GraphMLEdge addEdgeFrom(IGraphMLNode source)

Add an edge from another node to this one.

Parameters:

source - the source node

Returns:

the edge

addToEdge

boolean addToEdge(GraphMLEdge edge)

Add an edge originating from this node.

Parameters:

edge - the edge

Returns:

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