prajna.structure.accessor

Class StructureReader

java.lang.Object

prajna.structure.AbstractDataAccessor<DataRecord,DataRecord>

prajna.structure.accessor.RecordAccessor

prajna.structure.accessor.StructureReader

All Implemented Interfaces:

DataAccessor<DataRecord,DataRecord>

public class StructureReader
extends RecordAccessor

Accessor which loads XML data files. The StructureReader reads the XML format data that is written by the StructureWriter class.

Author:

Edward Swing

See Also:

StructureXmlWriter

Constructor Summary

Constructors

Constructor and Description
StructureReader()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<DataRecord>	getDataset(java.lang.String datasetName) Get the named dataset.
Graph<DataRecord,DataRecord>	getGraph(java.lang.String graphName) Get the named graph.
Grid<DataRecord>	getGrid(java.lang.String gridName) Get the named grid.
Tree<DataRecord>	getTree(java.lang.String treeName) Get the named tree.
void	loadDataFile(java.lang.String dataFile) Set the configuration from a local file.
void	loadDataFile(java.net.URL dataUrl) Set the configuration from a URL.
protected java.util.Set<DataRecord>	retrieveRecords(DataTemplate template) Retrieve a set of data records for a particular DataTemplate.
void	setInitParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Set the initialization parameters.
void	setQuery(java.lang.String query) Set the query string used to retrieve records.

Methods inherited from class prajna.structure.accessor.RecordAccessor

addFieldHandler, addToGraph, addToTree, createReferenceNode, extendGraph, extendTree, getFieldHandler, getMaxRecords, getReasoner, getStructureReasoners, setMaxRecords, setReasoner, setReasoner

Methods inherited from class prajna.structure.AbstractDataAccessor

addStructure, addTemplate, getDatasetNames, getGraphNames, getGridNames, getSpec, getStructureType, getTemplate, getTemplateNames, getTreeNames, setConfig, setConfigFile, setConfigFile

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureReader

public StructureReader()

Method Detail

getDataset

public java.util.Set<DataRecord> getDataset(java.lang.String datasetName)

Get the named dataset. If the dataset matches the dataset currently loaded, this method simply returns it. Otherwise, it attempts to open the dataset as a URL or file, and load it.

Specified by:

getDataset in interface DataAccessor<DataRecord,DataRecord>

Overrides:

getDataset in class RecordAccessor

Parameters:

datasetName - the named dataset, which should be a URL or file name

Returns:

the data set

getGraph

public Graph<DataRecord,DataRecord> getGraph(java.lang.String graphName)

Get the named graph. If the graph matches the graph currently loaded, this method simply returns it. Otherwise, it attempts to open the graph as a URL or file, and load it.

Specified by:

getGraph in interface DataAccessor<DataRecord,DataRecord>

Overrides:

getGraph in class RecordAccessor

Parameters:

graphName - the named graph, which should be a URL or file name

Returns:

the graph

getGrid

public Grid<DataRecord> getGrid(java.lang.String gridName)

Get the named grid. If the grid matches the grid currently loaded, this method simply returns it. Otherwise, it attempts to open the grid as a URL or file, and load it.

Specified by:

getGrid in interface DataAccessor<DataRecord,DataRecord>

Overrides:

getGrid in class RecordAccessor

Parameters:

gridName - the named grid, which should be a URL or file name

Returns:

the grid

getTree

public Tree<DataRecord> getTree(java.lang.String treeName)

Get the named tree. If the tree matches the tree currently loaded, this method simply returns it. Otherwise, it attempts to open the tree as a URL or file, and load it.

Specified by:

getTree in interface DataAccessor<DataRecord,DataRecord>

Overrides:

getTree in class RecordAccessor

Parameters:

treeName - the named tree, which should be a URL or file name

Returns:

the tree

loadDataFile

public void loadDataFile(java.lang.String dataFile)
                  throws java.io.FileNotFoundException

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

Parameters:

dataFile - The path to the configuration file

Throws:

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

loadDataFile

public void loadDataFile(java.net.URL dataUrl)
                  throws java.io.IOException

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

Parameters:

dataUrl - the configuration file as a URL

Throws:

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

retrieveRecords

protected java.util.Set<DataRecord> retrieveRecords(DataTemplate template)

Retrieve a set of data records for a particular DataTemplate. This method is used by the default implementation of the various getStructure methods. However, since the StructureReader overrides the getStructure methods, this method is not used. Therefore, this implementation is a stub

Specified by:

retrieveRecords in class RecordAccessor

Parameters:

template - The data template specifying field mappings and descriptions

Returns:

null

setInitParameters

public void setInitParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Set the initialization parameters.

Parameters:

parameters - the initialization parameters

setQuery

public void setQuery(java.lang.String query)

Set the query string used to retrieve records. Currently stubbed

Specified by:

setQuery in class AbstractDataAccessor<DataRecord,DataRecord>

Parameters:

query - the query string