prajna.structure

Class AbstractDataAccessor<N,E>

java.lang.Object

prajna.structure.AbstractDataAccessor<N,E>

Type Parameters:

N - The node class for this DataAccessor

E - The edge class for this DataAccessor

All Implemented Interfaces:

DataAccessor<N,E>

Direct Known Subclasses:

RecordAccessor

public abstract class AbstractDataAccessor<N,E>
extends java.lang.Object
implements DataAccessor<N,E>

Abstract implementation of a DataAccessor, providing a number of utility method implementations.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
AbstractDataAccessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addStructure(DataStructureSpec spec) Add a data structure specification to this accessor
protected void	addTemplate(DataTemplate template) Add a data template to this accessor.
java.util.Set<java.lang.String>	getDatasetNames() Get the names of the available datasets from this accessor.
java.util.Set<java.lang.String>	getGraphNames() Get the names of the available graphs from this accessor.
java.util.Set<java.lang.String>	getGridNames() Get the names of the available grids from this accessor.
DataStructureSpec	getSpec(java.lang.String name) Gets the named data structure specification.
DataStructureType	getStructureType(java.lang.String dataName) Get the data type for the specified dataName
DataTemplate	getTemplate(java.lang.String name) Gets the named DataTemplate.
java.util.Set<java.lang.String>	getTemplateNames() Get the names of all templates known by this accessor.
java.util.Set<java.lang.String>	getTreeNames() Get the names of the available trees from this accessor.
void	setConfig(java.io.InputStream inStream) Set the accessor data configuration information from an input stream.
void	setConfigFile(java.lang.String configFile) Set the configuration from a local file.
void	setConfigFile(java.net.URL configUrl) Set the configuration from a URL.
abstract void	setQuery(java.lang.String query) Set the query string used to retrieve records.

Methods inherited from class java.lang.Object

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

Methods inherited from interface prajna.structure.DataAccessor

extendGraph, extendTree, getDataset, getGraph, getGrid, getTree, setInitParameters

Constructor Detail

AbstractDataAccessor

public AbstractDataAccessor()

Method Detail

addStructure

protected void addStructure(DataStructureSpec spec)

Add a data structure specification to this accessor

Parameters:

spec - the new data structure specification

addTemplate

protected void addTemplate(DataTemplate template)

Add a data template to this accessor. If there is not a template with the same name, this method will add the template to this accessor's list of templates.

Parameters:

template - the template to add

getDatasetNames

public java.util.Set<java.lang.String> getDatasetNames()

Get the names of the available datasets from this accessor.

Specified by:

getDatasetNames in interface DataAccessor<N,E>

Returns:

the set of dataset names

getGraphNames

public java.util.Set<java.lang.String> getGraphNames()

Get the names of the available graphs from this accessor.

Specified by:

getGraphNames in interface DataAccessor<N,E>

Returns:

the set of graph names

getGridNames

public java.util.Set<java.lang.String> getGridNames()

Get the names of the available grids from this accessor.

Specified by:

getGridNames in interface DataAccessor<N,E>

Returns:

the set of grid names

getSpec

public DataStructureSpec getSpec(java.lang.String name)

Gets the named data structure specification. The data structure specification indicates what type of data structure corresponds to a particular name, and which data templates are used to construct it.

Parameters:

name - the name of the data structure specification

Returns:

the data structure specification

getStructureType

public DataStructureType getStructureType(java.lang.String dataName)

Get the data type for the specified dataName

Specified by:

getStructureType in interface DataAccessor<N,E>

Parameters:

dataName - the name of the data structure

Returns:

the data type

getTemplate

public DataTemplate getTemplate(java.lang.String name)

Gets the named DataTemplate. The DataTemplate objects correspond to the structures used to convert a particular data object into the objects provided by this DataAccessor

Parameters:

name - the name of the data template

Returns:

the data template

getTemplateNames

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

Get the names of all templates known by this accessor. The templates correspond to mappings of the underlying data.

Returns:

the set of all template names

getTreeNames

public java.util.Set<java.lang.String> getTreeNames()

Get the names of the available trees from this accessor.

Specified by:

getTreeNames in interface DataAccessor<N,E>

Returns:

the set of tree names

setConfig

public void setConfig(java.io.InputStream inStream)

Set the accessor data configuration information from an input stream. The input stream should contain any required initialization parameters. This method should initialize the data accessor if necessary. This implementation uses an XML-based configuration file. This method invokes setInitParameters after loading all template and data structure specifications.

Specified by:

setConfig in interface DataAccessor<N,E>

Parameters:

inStream - Input stream which is the source of the configuration information

setConfigFile

public void setConfigFile(java.lang.String configFile)
                   throws java.io.FileNotFoundException

Set the configuration from a local file. This convenience method simply opens a FileInputStream and calls setConfig(InputStream)

Parameters:

configFile - The path to the configuration file

Throws:

java.io.FileNotFoundException - if the file is not found

setConfigFile

public void setConfigFile(java.net.URL configUrl)
                   throws java.io.IOException

Set the configuration from a URL. This convenience method simply opens an input stream to the URL, and calls setConfig(InputStream)

Parameters:

configUrl - the configuration file as a URL

Throws:

java.io.IOException - if there is a problem opening or reading from the URL

setQuery

public abstract void setQuery(java.lang.String query)

Set the query string used to retrieve records. This method should transform the query string into a format which the accessor can parse. The query string should support a query of the form field=value. The accessor may support other queries, but this is specific to the implementation. The variety of queries supported may be enhanced in the near future. The accessor should also be able to handle queries that have already been translated into the accessor's native query syntax.

Parameters:

query - the query string