prajna.structure

Class DataStructureSpec

java.lang.Object

prajna.structure.DataStructureSpec

All Implemented Interfaces:

Xmlizable

Direct Known Subclasses:

DatasetSpec, GraphSpec, GridSpec, TreeSpec

public abstract class DataStructureSpec
extends java.lang.Object
implements Xmlizable

The DataStructureSpec class describes the components of the data structure classes. This includes the specification of the data fields used by each particular data structure, as well as a name for the individual data structure.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
DataStructureSpec()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.String	getName() Get the name for the particular data structure
abstract java.util.Set<java.lang.String>	getTemplateNames() Get the names of the templates for this data structure specification
java.util.Set<DataTemplate>	getTemplates() Get the templates for this data structure specification
void	storeTemplates(java.util.HashMap<java.lang.String,DataTemplate> dataTemplates) This method identifies the templates which this particular data structure needs, and stores them.

Methods inherited from class java.lang.Object

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

Methods inherited from interface prajna.data.Xmlizable

loadFromXml, toXml

Constructor Detail

DataStructureSpec

public DataStructureSpec()

Method Detail

getName

public abstract java.lang.String getName()

Get the name for the particular data structure

Returns:

the data structure's name

getTemplateNames

public abstract java.util.Set<java.lang.String> getTemplateNames()

Get the names of the templates for this data structure specification

Returns:

the set of data template names

getTemplates

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

Get the templates for this data structure specification

Returns:

the set of templates

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.

Parameters:

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