org.ogema.apps.graphgenerator.generators

Class GraphGenerator

java.lang.Object

org.ogema.apps.graphgenerator.generators.GraphGenerator

Direct Known Subclasses:

GraphwizGenerator, VisJsGenerator

public abstract class GraphGenerator
extends Object

Interface for a class that supports writing the desired part of the resource graph into a string. Different GraphGenerators may support different graph languages.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.ogema.core.logging.OgemaLogger	logger
static String	PATH_SEP

Constructor Summary

Constructors

Constructor and Description
GraphGenerator(org.ogema.core.logging.OgemaLogger logger)

Method Summary

Modifier and Type	Method and Description
void	addEdge(org.ogema.core.model.Resource start, org.ogema.core.model.Resource end) Adds a new, directed edge to be graph.
abstract void	addEdge(org.ogema.core.model.Resource start, org.ogema.core.model.Resource end, EdgeStyle style) Adds a new, directed edge to be graph.
abstract void	addGroup(Collection<org.ogema.core.model.Resource> resources, String name) Creates a group of resources.
abstract void	addNode(org.ogema.core.model.Resource node) Adds a new node to the graph.
abstract void	addNode(org.ogema.core.model.Resource node, NodeStyle style) Adds a new node to the graph.
abstract Object	finish() Finalize the graph.
Object	generateAllResourcesGraph(org.ogema.core.resourcemanager.ResourceAccess resAcc)
Object	generateConnectionsGraph(org.ogema.core.resourcemanager.ResourceAccess resAcc)
<T extends org.ogema.core.model.Resource> Object	generateGraph(org.ogema.core.resourcemanager.ResourceAccess resAcc, Class<T> clazz)
Object	generateResourcesGraph(Class<? extends org.ogema.core.model.Resource> topLevelType, org.ogema.core.resourcemanager.ResourceAccess resAcc)
abstract String	getGraph() Gets the constructed graph.
protected String	getSimpleValue(org.ogema.core.model.ValueResource resource)
abstract void	init() Initialize collecting nodes and edges.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEP

public static final String PATH_SEP

See Also:

Constant Field Values

logger

protected org.ogema.core.logging.OgemaLogger logger

Constructor Detail

GraphGenerator

public GraphGenerator(org.ogema.core.logging.OgemaLogger logger)

Method Detail

init

public abstract void init()

Initialize collecting nodes and edges. Should be called before the first node or edge is being added.

addNode

public abstract void addNode(org.ogema.core.model.Resource node)

Adds a new node to the graph.

Parameters:

node - Resource that is to be represented as a node.

addNode

public abstract void addNode(org.ogema.core.model.Resource node,
                             NodeStyle style)

Adds a new node to the graph.

Parameters:

node - Resource that is to be represented as a node.

style - Display style for this node.

addEdge

public void addEdge(org.ogema.core.model.Resource start,
                    org.ogema.core.model.Resource end)

Adds a new, directed edge to be graph. Same as invoking addEdge(Resource, Resource, EdgeStyle) with style = null.

Parameters:

start - Start node of the edge.

end - End node of the edge.

addEdge

public abstract void addEdge(org.ogema.core.model.Resource start,
                             org.ogema.core.model.Resource end,
                             EdgeStyle style)

Adds a new, directed edge to be graph.

Parameters:

start - Start node of the edge.

end - End node of the edge.

style - draw style used to display the edge.

addGroup

public abstract void addGroup(Collection<org.ogema.core.model.Resource> resources,
                              String name)

Creates a group of resources.

Parameters:

resources - Set of resources to add to the group.

name - Name of the group.

finish

public abstract Object finish()

Finalize the graph. Should be called after the last or edge has been added.

getGraph

public abstract String getGraph()

Gets the constructed graph. Should be called only after finish() has been invoked.

Returns:

The graph as a string in the graph language this generator represents or is configured to.

generateAllResourcesGraph

public Object generateAllResourcesGraph(org.ogema.core.resourcemanager.ResourceAccess resAcc)

generateResourcesGraph

public Object generateResourcesGraph(Class<? extends org.ogema.core.model.Resource> topLevelType,
                                     org.ogema.core.resourcemanager.ResourceAccess resAcc)

generateGraph

public <T extends org.ogema.core.model.Resource> Object generateGraph(org.ogema.core.resourcemanager.ResourceAccess resAcc,
                                                                      Class<T> clazz)

generateConnectionsGraph

public Object generateConnectionsGraph(org.ogema.core.resourcemanager.ResourceAccess resAcc)

getSimpleValue

protected String getSimpleValue(org.ogema.core.model.ValueResource resource)