prajna.structure

Class GraphSpec

java.lang.Object

prajna.structure.DataStructureSpec

prajna.structure.GraphSpec

All Implemented Interfaces:

Xmlizable

public class GraphSpec
extends DataStructureSpec

The GraphSpec describes the components of a Graph. It includes a list of node and edge classes, as well as whether the graph is directed or not.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
GraphSpec(org.w3c.dom.Element elem) Construct a graph specification from an XML element
GraphSpec(java.lang.String specName) Construct an empty graph specification with the given name

Method Summary

Methods

Modifier and Type	Method and Description
void	addEdgeTemplate(java.lang.String templateName) Add the template by name to the set of templates used for edges in this graph specification
void	addNodeTemplate(java.lang.String templateName) Add the template by name to the set of templates used for nodes in this graph specification
java.lang.String	getDestinationField() Get the field used to indicate the destination node for an edge
java.util.HashSet<java.lang.String>	getEdgeTemplateNames() Get the names of the edge templates for this graph spec.
java.util.Set<DataTemplate>	getEdgeTemplates() Get the edge templates for this graph specification
java.lang.String	getName() Get the name for the particular data structure
java.lang.String	getOriginField() Get the field used to indicate the origin node for an edge
java.util.HashSet<java.lang.String>	getTemplateNames() Get the names of the templates identified for this GraphSpec.
boolean	isDirected() Determine whether the graph should be a directed graph or an undirected graph
void	loadFromXml(org.w3c.dom.Element elem) Load the Graph Specification from an XML element.
void	storeTemplates(java.util.HashMap<java.lang.String,DataTemplate> dataTemplates) This method identifies the templates which this particular data structure needs, and stores them.
org.w3c.dom.Element	toXml(org.w3c.dom.Document doc) Convert this specification into XML format.

Methods inherited from class prajna.structure.DataStructureSpec

getTemplates

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphSpec

public GraphSpec(org.w3c.dom.Element elem)

Construct a graph specification from an XML element

Parameters:

elem - the element containing the graph specification

GraphSpec

public GraphSpec(java.lang.String specName)

Construct an empty graph specification with the given name

Parameters:

specName - the name of the graph specification

Method Detail

addEdgeTemplate

public void addEdgeTemplate(java.lang.String templateName)

Add the template by name to the set of templates used for edges in this graph specification

Parameters:

templateName - the template name

addNodeTemplate

public void addNodeTemplate(java.lang.String templateName)

Add the template by name to the set of templates used for nodes in this graph specification

Parameters:

templateName - the template name

getDestinationField

public java.lang.String getDestinationField()

Get the field used to indicate the destination node for an edge

Returns:

the field used to indicate the destination node for an edge

getEdgeTemplateNames

public java.util.HashSet<java.lang.String> getEdgeTemplateNames()

Get the names of the edge templates for this graph spec.

Returns:

the edge template names

getEdgeTemplates

public java.util.Set<DataTemplate> getEdgeTemplates()

Get the edge templates for this graph specification

Returns:

the set of templates

getName

public java.lang.String getName()

Get the name for the particular data structure

Specified by:

getName in class DataStructureSpec

Returns:

the data structure's name

getOriginField

public java.lang.String getOriginField()

Get the field used to indicate the origin node for an edge

Returns:

the field used to indicate the origin node for an edge

getTemplateNames

public java.util.HashSet<java.lang.String> getTemplateNames()

Get the names of the templates identified for this GraphSpec. For a GraphSpec, this is the list of template names for the nodes of the graph. For the edges of the graph, use getEdgeTemplateNames().

Specified by:

getTemplateNames in class DataStructureSpec

Returns:

the names of the graph node templates

isDirected

public boolean isDirected()

Determine whether the graph should be a directed graph or an undirected graph

Returns:

true, if the graph should be directed, false otherwise

loadFromXml

public void loadFromXml(org.w3c.dom.Element elem)

Load the Graph Specification from an XML element. This method retrieves the name, node and edge classes from the XML element. The node classes are specified by the attribute nodeClass, and may be a space-separated sequence of template names. The edge classes similarly are specified by the attribute edgeClass. The directed attribute specifies whether the graph is directed or not; if not set, the default is false, meaning an undirected graph.

Parameters:

elem - the element to parse

storeTemplates

public void storeTemplates(java.util.HashMap<java.lang.String,DataTemplate> dataTemplates)

This method identifies the templates which this particular data structure needs, and stores them.

Overrides:

storeTemplates in class DataStructureSpec

Parameters:

dataTemplates - a map of the data templates, with the template names as the keys

toXml

public org.w3c.dom.Element toXml(org.w3c.dom.Document doc)

Convert this specification into XML format.

Parameters:

doc - the document to use to create the elements

Returns:

an element containing the XML for the graph specification.