org.girod.jgraphml.model

Class GraphMLDiagram

java.lang.Object

edu.uci.ics.jung.graph.AbstractGraph<IGraphMLNode,GraphMLEdge>

org.girod.jgraphml.model.AbstractGraphMLDiagram

org.girod.jgraphml.model.GraphMLDiagram

All Implemented Interfaces:

Graph<IGraphMLNode,GraphMLEdge>, Hypergraph<IGraphMLNode,GraphMLEdge>, java.io.Serializable, java.lang.Cloneable, GraphDiagram, NodeParent

public class GraphMLDiagram
extends AbstractGraphMLDiagram
implements GraphDiagram, java.lang.Cloneable

A graphml diagram.

See Also:

Serialized Form

Field Summary

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

children, defaultEdgeType, defaults, edges, groupNodes, nodes

Constructor Summary

Constructors

Constructor and Description
GraphMLDiagram()
GraphMLDiagram(DiagramDefaults defaults) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addChild(IGraphMLNode node) Adds a child node to this graph.
DiagramResource	addDiagramResource(DiagramResource resource) Add an diagram resource.
boolean	addEdge(GraphMLEdge edge, IGraphMLNode source, IGraphMLNode target) Add an edge from a source to a target.
GraphMLEdge	addEdge(IGraphMLNode source, IGraphMLNode target) Add an edge from a source to a target.
GraphMLEdge	addEdgeFromTemplate(IGraphMLNode source, IGraphMLNode target, java.lang.String id) Add an edge from a source to a target, using a template.
GraphMLEdge	addEdgeWithLabel(IGraphMLNode source, IGraphMLNode target, java.lang.String text) Add an edge from a source to a target, with a specified text.
GraphMLGroupNode	addGroupNode() Add a group node with an id specified automatically.
GraphMLGroupNode	addGroupNodeFromTemplate(java.lang.String id) Add a group node, using a template.
GraphMLGroupNode	addGroupNodeFromTemplateWithLabel(java.lang.String id, java.lang.String text) Adds a child node to the parent, using a template, and with a specified label.
GraphMLGroupNode	addGroupNodeWithLabel(java.lang.String text) Add a group node with an id specified automatically, and with a specified label.
IconResource	addIconResource() Add an icon resource.
IconResourceData	addIconResourceData() Add an icon resource data.
void	addKey(DiagramKey key) Add a key.
GraphMLNode	addNode() Add a node with an id specified automatically.
GraphMLNode	addNodeFromTemplate(java.lang.String id) Add a node, using a template.
GraphMLNode	addNodeFromTemplateWithLabel(java.lang.String id, java.lang.String text) Add a node with an id specified automatically.
GraphMLNode	addNodeWithLabel(java.lang.String text) Add a node with an id specified automatically, and with a specified label.
void	clearDiagramResources() Clear the diagram resources.
GraphMLDiagram	clone()
void	computeSize() Compute the size of the nodes.
void	computeSize(float groupNodePadding) Compute the size of the nodes.
DiagramResource	getDiagramResource(int id) Return the diagram resource of a specified ID.
java.util.Map<java.lang.Integer,DiagramResource>	getDiagramResources() Return the diagram resources.
java.lang.String	getID() Return null.
java.util.Map<KeyType,DiagramKey>	getKeys() Return the keys by key type.
java.util.Map<java.lang.String,DiagramKey>	getKeysById() Return the keys by ID.
NodeParent	getNodeParent() Return this.
java.lang.String	getTitle() Return the diagram title.
java.net.URL	getURL() Return the diagram URL.
boolean	hasDiagramResource(int id) Return true if there is a diagram resource for a specified ID.
void	setTitle(java.lang.String title) Set the diagram title.
void	setURL(java.net.URL url) Set the diagram URL.

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

addEdgeWithEndpoints, addGroupNode, addNode, addNode, addNode, addVertex, addVertex, containsEdge, containsVertex, countEdges, countGroupNodes, countNodes, detachNode, getChildren, getDefaultEdgeType, getDefaults, getDest, getDiagram, getEdgeCount, getEdgeCount, getEdges, getEdges, getEdgesView, getEdgeType, getEndpoints, getGroupNodes, getIncidentEdges, getInEdges, getNeighbors, getNodes, getOutEdges, getPredecessors, getSource, getSuccessors, getUnusedNodeID, getVertexCount, getVerticesView, hasGroupNodes, isDest, isSource, removeEdge, removeVertex, setDefaultEdgeType, setDefaults

Methods inherited from class edu.uci.ics.jung.graph.AbstractGraph

addEdge, addEdgeWithEndPoints, addEdgeWithVertices, addEdgeWithVertices, degree, findEdge, findEdgeSet, getIncidentCount, getIncidentVertices, getNeighborCount, getOpposite, getPredecessorCount, getSuccessorCount, getValidatedEndpoints, inDegree, isIncident, isNeighbor, isPredecessor, isSuccessor, outDegree

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphMLDiagram

public GraphMLDiagram()

GraphMLDiagram

public GraphMLDiagram(DiagramDefaults defaults)

Constructor.

Parameters:

defaults - the diagram defaults.

Method Detail

clone

public GraphMLDiagram clone()

Overrides:

clone in class AbstractGraphMLDiagram

getNodeParent

public NodeParent getNodeParent()

Return this.

Specified by:

getNodeParent in interface GraphDiagram

Returns:

this

getID

public java.lang.String getID()

Return null.

Specified by:

getID in interface GraphDiagram

Returns:

null

setURL

public void setURL(java.net.URL url)

Set the diagram URL.

Parameters:

url - the URL

getURL

public java.net.URL getURL()

Return the diagram URL.

Returns:

the URL

setTitle

public void setTitle(java.lang.String title)

Set the diagram title.

Parameters:

title - the title

getTitle

public java.lang.String getTitle()

Return the diagram title.

Returns:

the title

addKey

public void addKey(DiagramKey key)

Add a key.

Parameters:

key - the key

getKeys

public java.util.Map<KeyType,DiagramKey> getKeys()

Return the keys by key type.

Returns:

the keys

getKeysById

public java.util.Map<java.lang.String,DiagramKey> getKeysById()

Return the keys by ID.

Returns:

the keys

addNode

public GraphMLNode addNode()

Add a node with an id specified automatically.

Specified by:

addNode in interface NodeParent

Overrides:

addNode in class AbstractGraphMLDiagram

Returns:

the node

addNodeWithLabel

public GraphMLNode addNodeWithLabel(java.lang.String text)

Add a node with an id specified automatically, and with a specified label.

Specified by:

addNodeWithLabel in interface NodeParent

Parameters:

text - the node label

Returns:

the node

addNodeFromTemplate

public GraphMLNode addNodeFromTemplate(java.lang.String id)
                                throws TemplateAccessException

Add a node, using a template.

Specified by:

addNodeFromTemplate in interface NodeParent

Overrides:

addNodeFromTemplate in class AbstractGraphMLDiagram

Parameters:

id - the template id

Returns:

the node

Throws:

TemplateAccessException

addNodeFromTemplateWithLabel

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

Add a node with an id specified automatically.

Specified by:

addNodeFromTemplateWithLabel in interface NodeParent

Parameters:

id - the template id

text - the node label

Returns:

the node

addGroupNodeWithLabel

public GraphMLGroupNode addGroupNodeWithLabel(java.lang.String text)

Add a group node with an id specified automatically, and with a specified label.

Specified by:

addGroupNodeWithLabel in interface NodeParent

Parameters:

text - the group node label

Returns:

the group node

addGroupNode

public GraphMLGroupNode addGroupNode()

Add a group node with an id specified automatically.

Specified by:

addGroupNode in interface NodeParent

Overrides:

addGroupNode in class AbstractGraphMLDiagram

Returns:

the group node

addGroupNodeFromTemplate

public GraphMLGroupNode addGroupNodeFromTemplate(java.lang.String id)
                                          throws TemplateAccessException

Add a group node, using a template.

Specified by:

addGroupNodeFromTemplate in interface NodeParent

Overrides:

addGroupNodeFromTemplate in class AbstractGraphMLDiagram

Parameters:

id - the template id

Returns:

the group node

Throws:

TemplateAccessException

addGroupNodeFromTemplateWithLabel

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

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

Specified by:

addGroupNodeFromTemplateWithLabel in interface NodeParent

Parameters:

id - the template id

text - the node label

Returns:

the group node

addChild

public boolean addChild(IGraphMLNode node)

Adds a child node to this graph.

Specified by:

addChild in interface NodeParent

Overrides:

addChild in class AbstractGraphMLDiagram

Parameters:

node - the node to add

Returns:

true if the add is successful, and false otherwise

Throws:

java.lang.IllegalArgumentException - if node is null

addEdge

public boolean addEdge(GraphMLEdge edge,
                       IGraphMLNode source,
                       IGraphMLNode target)

Add an edge from a source to a target.

Specified by:

addEdge in interface Graph<IGraphMLNode,GraphMLEdge>

Overrides:

addEdge in class AbstractGraphMLDiagram

Parameters:

edge - the edge

source - the edge source

target - the edge target

Returns:

true if the edge could be added

See Also:

Graph.addEdge(Object, Object, Object, EdgeType)

addEdge

public GraphMLEdge addEdge(IGraphMLNode source,
                           IGraphMLNode target)

Add an edge from a source to a target.

Overrides:

addEdge in class AbstractGraphMLDiagram

Parameters:

source - the edge source

target - the edge target

Returns:

true if the edge could be added

addEdgeWithLabel

public GraphMLEdge addEdgeWithLabel(IGraphMLNode source,
                                    IGraphMLNode target,
                                    java.lang.String text)

Add an edge from a source to a target, with a specified text.

Parameters:

source - the edge source

target - the edge target

Returns:

true if the edge could be added

addEdgeFromTemplate

public GraphMLEdge addEdgeFromTemplate(IGraphMLNode source,
                                       IGraphMLNode target,
                                       java.lang.String id)
                                throws TemplateAccessException

Add an edge from a source to a target, using a template.

Overrides:

addEdgeFromTemplate in class AbstractGraphMLDiagram

Parameters:

source - the edge source

target - the edge target

id - the template id

Returns:

the edge

Throws:

TemplateAccessException

addIconResource

public IconResource addIconResource()

Add an icon resource.

Returns:

the icon resource

addIconResourceData

public IconResourceData addIconResourceData()

Add an icon resource data.

Returns:

the icon resource data

addDiagramResource

public DiagramResource addDiagramResource(DiagramResource resource)

Add an diagram resource.

Parameters:

resource - the diagram resource

Returns:

the diagram resource

getDiagramResources

public java.util.Map<java.lang.Integer,DiagramResource> getDiagramResources()

Return the diagram resources.

Returns:

the diagram resources

getDiagramResource

public DiagramResource getDiagramResource(int id)

Return the diagram resource of a specified ID.

Parameters:

id - the resource ID

Returns:

the diagram resources

hasDiagramResource

public boolean hasDiagramResource(int id)

Return true if there is a diagram resource for a specified ID.

Parameters:

id - the resource ID

Returns:

true if there is a diagram resource for the specified ID

clearDiagramResources

public void clearDiagramResources()

Clear the diagram resources.

computeSize

public void computeSize()

Compute the size of the nodes.

computeSize

public void computeSize(float groupNodePadding)

Compute the size of the nodes.

Parameters:

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