org.girod.jgraphml.model

Interface NodeParent

All Known Implementing Classes:

AbstractGraphMLDiagram, GraphMLDiagram, GraphMLGroupNode, GraphMLGroupNodeTemplate

public interface NodeParent

A node parent interface.

Method Summary

Modifier and Type	Method and Description
boolean	addChild(IGraphMLNode node) Adds a child node to the parent.
GraphMLGroupNode	addGroupNode() Adds a child group node to the parent.
GraphMLGroupNode	addGroupNode(java.lang.String id) Add a group node with a specified id.
GraphMLGroupNode	addGroupNodeFromTemplate(java.lang.String id) Adds a child group node to the parent.
GraphMLGroupNode	addGroupNodeFromTemplateWithLabel(java.lang.String id, java.lang.String text) Adds a child group node to the parent, using a template, and with a specified label.
GraphMLGroupNode	addGroupNodeWithLabel(java.lang.String text) Adds a group node to the parent, and with a specified label.
GraphMLNode	addNode() Adds a child node to the parent.
GraphMLNode	addNode(java.lang.String id) Add a node with a specified id.
GraphMLNode	addNodeFromTemplate(java.lang.String id) Adds a child node to the parent, using a template.
GraphMLNode	addNodeFromTemplateWithLabel(java.lang.String id, java.lang.String text) Adds a child node to the parent, using a template, and with a specified label.
GraphMLNode	addNodeWithLabel(java.lang.String text) Adds a child node to the parent, and with a specified label.
int	countGroupNodes() Return the number of group nodes.
int	countNodes() Return the number of children nodes.
java.util.SortedMap<java.lang.String,IGraphMLNode>	getChildren() Return the children nodes.
AbstractGraphMLDiagram	getDiagram() Return the diagram.
java.util.SortedMap<java.lang.String,GraphMLGroupNode>	getGroupNodes() Return the children group nodes.
boolean	hasGroupNodes() Return true if there are group nodes.

Method Detail

addNode

GraphMLNode addNode()

Adds a child node to the parent.

Returns:

the node

addNodeFromTemplate

GraphMLNode addNodeFromTemplate(java.lang.String id)

Adds a child node to the parent, using a template.

Parameters:

id - the template id

Returns:

the group node

addNodeFromTemplateWithLabel

GraphMLNode addNodeFromTemplateWithLabel(java.lang.String id,
                                         java.lang.String text)

Adds a child node to the parent, using a template, and with a specified label.

Parameters:

id - the template id

text - the node label

Returns:

the node

addNodeWithLabel

GraphMLNode addNodeWithLabel(java.lang.String text)

Adds a child node to the parent, and with a specified label.

Parameters:

text - the node label

Returns:

the node

addNode

GraphMLNode addNode(java.lang.String id)

Add a node with a specified id.

Parameters:

id - the node id

Returns:

the node

addGroupNode

GraphMLGroupNode addGroupNode()

Adds a child group node to the parent.

Returns:

the group node

addGroupNodeWithLabel

GraphMLGroupNode addGroupNodeWithLabel(java.lang.String text)

Adds a group node to the parent, and with a specified label.

Parameters:

text - the group node label

Returns:

the group node

addGroupNodeFromTemplate

GraphMLGroupNode addGroupNodeFromTemplate(java.lang.String id)

Adds a child group node to the parent.

Parameters:

id - thr template id

Returns:

the group node

addGroupNodeFromTemplateWithLabel

GraphMLGroupNode addGroupNodeFromTemplateWithLabel(java.lang.String id,
                                                   java.lang.String text)

Adds a child group node to the parent, using a template, and with a specified label.

Parameters:

id - the template id

text - the node label

Returns:

the group node

addGroupNode

GraphMLGroupNode addGroupNode(java.lang.String id)

Add a group node with a specified id.

Parameters:

id - the group node id

Returns:

the node

addChild

boolean addChild(IGraphMLNode node)

Adds a child node to the parent.

Parameters:

node - the node to add

Returns:

true if the add is successful, and false otherwise

getChildren

java.util.SortedMap<java.lang.String,IGraphMLNode> getChildren()

Return the children nodes.

Returns:

the nodes

getGroupNodes

java.util.SortedMap<java.lang.String,GraphMLGroupNode> getGroupNodes()

Return the children group nodes.

Returns:

the nodes

countNodes

int countNodes()

Return the number of children nodes.

Returns:

the number of nodes

countGroupNodes

int countGroupNodes()

Return the number of group nodes.

Returns:

the number of group nodes

hasGroupNodes

boolean hasGroupNodes()

Return true if there are group nodes.

Returns:

true if there are group nodes

getDiagram

AbstractGraphMLDiagram getDiagram()

Return the diagram.

Returns:

the diagram