prajna.structure

Class DatasetSpec

java.lang.Object

prajna.structure.DataStructureSpec

prajna.structure.DatasetSpec

All Implemented Interfaces:

Xmlizable

public class DatasetSpec
extends DataStructureSpec

Describes the components of a dataset. It includes a list of data template classes.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
DatasetSpec(org.w3c.dom.Element elem) Construct a dataset specification from an XML element
DatasetSpec(java.lang.String specName) Construct a DatasetSpec with no templates

Method Summary

Methods

Modifier and Type	Method and Description
void	addTemplate(java.lang.String templateName) Add the named template, which should correspond to a DataTemplate, to this dataset
java.lang.String	getName() Get the name for the particular data structure
java.util.HashSet<java.lang.String>	getTemplateNames() Get the names of the templates identified for this DatasetSpec.
void	loadFromXml(org.w3c.dom.Element elem) Load the Dataset 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

DatasetSpec

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

Construct a dataset specification from an XML element

Parameters:

elem - the element containing the dataset specification

DatasetSpec

public DatasetSpec(java.lang.String specName)

Construct a DatasetSpec with no templates

Parameters:

specName - the name of the dataset specification

Method Detail

addTemplate

public void addTemplate(java.lang.String templateName)

Add the named template, which should correspond to a DataTemplate, to this dataset

Parameters:

templateName - the name of a DataTemplate

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

getTemplateNames

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

Get the names of the templates identified for this DatasetSpec. This is the list of templates used to create the contents of the dataset

Specified by:

getTemplateNames in class DataStructureSpec

Returns:

the names of the item templates

loadFromXml

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

Load the Dataset Specification from an XML element. This method retrieves the name and item class names from the XML element. The item classes are specified by the attribute itemClass, and may be a space-separated sequence of template names.

Parameters:

elem - the element to parse

toXml

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

Convert this specification into XML format. Currently unimplemented

Parameters:

doc - the document to use to create the elements

Returns:

an element containing the XML for the graph specification.