org.girod.jgraphml

Class GraphMLFactory

java.lang.Object

org.girod.jgraphml.GraphMLFactory

public class GraphMLFactory
extends java.lang.Object

The factory allows to create, parse or serialize a graphml diagram.

Method Summary

Modifier and Type	Method and Description
GraphMLEdgeTemplate	createGraphMLEdgeTemplate(java.lang.String id) Create an edge template.
GraphMLGroupNodeTemplate	createGraphMLGroupNodeTemplate(java.lang.String id) Create a group node template.
GraphMLNodeTemplate	createGraphMLNodeTemplate(java.lang.String id) Create a node template.
GraphMLEdgeTemplate	getGraphMLEdgeTemplate(java.lang.String id) Return the edge template for a specified id.
GraphMLGroupNodeTemplate	getGraphMLGroupNodeTemplate(java.lang.String id) Return the group node template for a specified id.
GraphMLNodeTemplate	getGraphMLNodeTemplate(java.lang.String id) Return the node template for a specified id.
static GraphMLFactory	getInstance() Return the unique instance.
java.util.Map<java.lang.String,IGraphMLTemplate>	getTemplates() Return the templates
boolean	hasEdgeTemplate(java.lang.String id) Return true if there is a GraphMLEdgeTemplate for a specified id.
boolean	hasGroupNodeTemplate(java.lang.String id) Return true if there is a GraphMLGroupNodeTemplate for a specified id.
boolean	hasNodeTemplate(java.lang.String id) Return true if there is a GraphMLNodeTemplate for a specified id.
GraphMLDiagram	newDiagram() Creates a new diagram.
GraphMLDiagram	newDiagram(DiagramDefaults defaults) Creates a new diagram, with custom defaults.
GraphMLDiagram	openDiagram(java.io.File file) Open a graphml diagram.
GraphMLDiagram	openDiagram(java.io.File file, DiagramDefaults defaults) Open a graphml diagram.
GraphMLDiagram	openDiagram(java.net.URL url) Open a graphml diagram.
GraphMLDiagram	openDiagram(java.net.URL url, DiagramDefaults defaults) Open a graphml diagram.
void	resetTemplates() Reset the templates.
void	saveDiagram(GraphMLDiagram diagram, java.io.File file) Save a diagram.
void	saveDiagram(GraphMLDiagram diagram, java.net.URL url) Save a diagram.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static GraphMLFactory getInstance()

Return the unique instance.

Returns:

the instance

hasNodeTemplate

public boolean hasNodeTemplate(java.lang.String id)

Return true if there is a GraphMLNodeTemplate for a specified id.

Parameters:

id - the id

Returns:

true if there is a GraphMLNodeTemplate for the specified id

hasGroupNodeTemplate

public boolean hasGroupNodeTemplate(java.lang.String id)

Return true if there is a GraphMLGroupNodeTemplate for a specified id.

Parameters:

id - the id

Returns:

true if there is a GraphMLGroupNodeTemplate for the specified id

hasEdgeTemplate

public boolean hasEdgeTemplate(java.lang.String id)

Return true if there is a GraphMLEdgeTemplate for a specified id.

Parameters:

id - the id

Returns:

true if there is a GraphMLEdgeTemplate for the specified id

createGraphMLNodeTemplate

public GraphMLNodeTemplate createGraphMLNodeTemplate(java.lang.String id)
                                              throws TemplateAccessException

Create a node template.

Parameters:

id - the template id

Returns:

the node template

Throws:

TemplateAccessException

getGraphMLNodeTemplate

public GraphMLNodeTemplate getGraphMLNodeTemplate(java.lang.String id)
                                           throws TemplateAccessException

Return the node template for a specified id.

Parameters:

id - the template id

Returns:

the node template

Throws:

TemplateAccessException

createGraphMLGroupNodeTemplate

public GraphMLGroupNodeTemplate createGraphMLGroupNodeTemplate(java.lang.String id)
                                                        throws TemplateAccessException

Create a group node template.

Parameters:

id - the template id

Returns:

the group node template

Throws:

TemplateAccessException

getGraphMLGroupNodeTemplate

public GraphMLGroupNodeTemplate getGraphMLGroupNodeTemplate(java.lang.String id)
                                                     throws TemplateAccessException

Return the group node template for a specified id.

Parameters:

id - the template id

Returns:

the group node template

Throws:

TemplateAccessException

createGraphMLEdgeTemplate

public GraphMLEdgeTemplate createGraphMLEdgeTemplate(java.lang.String id)
                                              throws TemplateAccessException

Create an edge template.

Parameters:

id - the template id

Returns:

the edge template

Throws:

TemplateAccessException

getGraphMLEdgeTemplate

public GraphMLEdgeTemplate getGraphMLEdgeTemplate(java.lang.String id)
                                           throws TemplateAccessException

Return the edge template for a specified id.

Parameters:

id - the template id

Returns:

the edge template

Throws:

TemplateAccessException

resetTemplates

public void resetTemplates()

Reset the templates.

getTemplates

public java.util.Map<java.lang.String,IGraphMLTemplate> getTemplates()

Return the templates

Returns:

the templates

newDiagram

public GraphMLDiagram newDiagram()

Creates a new diagram.

Returns:

the diagram

newDiagram

public GraphMLDiagram newDiagram(DiagramDefaults defaults)

Creates a new diagram, with custom defaults.

Parameters:

defaults - the diagram defaults

Returns:

the diagram

openDiagram

public GraphMLDiagram openDiagram(java.net.URL url)
                           throws java.io.IOException

Open a graphml diagram.

Parameters:

url - the diagram url

Returns:

the diagram

Throws:

java.io.IOException

openDiagram

public GraphMLDiagram openDiagram(java.net.URL url,
                                  DiagramDefaults defaults)
                           throws java.io.IOException

Open a graphml diagram.

Parameters:

url - the diagram url

defaults - the DiagramDefaults to use

Returns:

the diagram

Throws:

java.io.IOException

openDiagram

public GraphMLDiagram openDiagram(java.io.File file)
                           throws java.io.IOException

Open a graphml diagram.

Parameters:

file - the diagram file

Returns:

the diagram

Throws:

java.io.IOException

openDiagram

public GraphMLDiagram openDiagram(java.io.File file,
                                  DiagramDefaults defaults)
                           throws java.io.IOException

Open a graphml diagram.

Parameters:

file - the diagram file

defaults - the DiagramDefaults to use

Returns:

the diagram

Throws:

java.io.IOException

saveDiagram

public void saveDiagram(GraphMLDiagram diagram,
                        java.net.URL url)
                 throws java.io.IOException

Save a diagram.

Parameters:

diagram - the diagram

url - the URL

Throws:

java.io.IOException

saveDiagram

public void saveDiagram(GraphMLDiagram diagram,
                        java.io.File file)
                 throws java.io.IOException

Save a diagram.

Parameters:

diagram - the diagram

file - the file

Throws:

java.io.IOException