prajna.structure

Class TreeSpec

java.lang.Object

prajna.structure.DataStructureSpec

prajna.structure.TreeSpec

All Implemented Interfaces:

Xmlizable

public class TreeSpec
extends DataStructureSpec

Describes the components of a tree. It includes a list of data template classes for the tree nodes. In addition, the TreeSpec contains two ways of creating the tree structure: splitFields or a parentField. The parentField identifies the field within the data template(s) which refer to a parent node. the splitField values are a sequence of fields which separate the tree into different branches at each level according to the value of that field.

Author:

Edward Swing

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addTemplate(java.lang.String templateName) Add the template by name to the set of templates used for tree nodes in this tree specification
java.lang.String	getName() Get the name for the particular data structure
java.lang.String	getParentField() Get the parentField for this tree
java.util.List<java.lang.String>	getSplitFields() Get the sequence of splitFields for this tree.
java.util.HashSet<java.lang.String>	getTemplateNames() Get the names of the templates identified for this specification.
void	loadFromXml(org.w3c.dom.Element elem) Load the Tree Specification from an XML element.
org.w3c.dom.Element	toXml(org.w3c.dom.Document doc) Convert this specification into XML format.

Methods inherited from class prajna.structure.DataStructureSpec

getTemplates, storeTemplates

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeSpec

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

Construct a tree specification from an XML element

Parameters:

elem - the element containing the tree specification

TreeSpec

public TreeSpec(java.lang.String specName)

Construct an empty graph specification with the given name

Parameters:

specName - the name of the graph specification

Method Detail

addTemplate

public void addTemplate(java.lang.String templateName)

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

Parameters:

templateName - the template name

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

getParentField

public java.lang.String getParentField()

Get the parentField for this tree

Returns:

the parentField

getSplitFields

public java.util.List<java.lang.String> getSplitFields()

Get the sequence of splitFields for this tree.

Returns:

the tree's splitFields

getTemplateNames

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

Get the names of the templates identified for this specification. This is the list of templates used to create the nodes within the tree.

Specified by:

getTemplateNames in class DataStructureSpec

Returns:

the names of the item templates

loadFromXml

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

Load the Tree Specification from an XML element. This method retrieves the name and item class names from the XML element. The cell classes are specified by the attribute treeNodeClass, and may be a space-separated sequence of template names. The splitFields attribute specifies a comma-separated sequence of fields which split the tree at subsequent levels. The parentField attribute identifies which field within the node templates should be used to identify parent nodes. The splitFields and parentField should be component fields of the treeNodeClass templates. A TreeSpec should specify either splitFields or a parentField, not both.

Parameters:

elem - the element to parse

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.