prajna.structure.accessor

Class CommonMLAccessor

java.lang.Object

prajna.structure.AbstractDataAccessor<DataRecord,DataRecord>

prajna.structure.accessor.RecordAccessor

prajna.structure.accessor.CommonMLAccessor

All Implemented Interfaces:

DataAccessor<DataRecord,DataRecord>

public class CommonMLAccessor
extends RecordAccessor

This class is designed to read data from GraphML and TreeML files, and provide the data as a DataAccessor. The CommonMLAccessor aggregates a list of files that it has read, and will convert any of them as needed. It does not retain the information on any particular data structure, so that if the underlying file changes, a new call will regenerate the data as needed.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
CommonMLAccessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFile(java.io.File file) Adds a file to this accessor.
void	addFile(java.lang.String fileName) Adds a file by name to this accessor.
void	addUrl(java.net.URL url) Adds a file by url to this accessor.
java.util.Set<DataRecord>	getDataset(java.lang.String datasetName) Retrieves the named dataset.
Graph<DataRecord,DataRecord>	getGraph(java.lang.String graphName) Retrieves the named graph.
Grid<DataRecord>	getGrid(java.lang.String gridName) Retrieves the named grid.
Tree<DataRecord>	getTree(java.lang.String treeName) Retrieves the named tree.
Graph<DataRecord,DataRecord>	parseGraphML(java.io.InputStream inStream, java.lang.String graphName) Parses a stream containing a graphML format, and returns the graph with the matching name.
Tree<DataRecord>	parseTreeML(java.io.InputStream inStream) Parses a stream containing a treeML format, and returns the tree contained in the treeML data
protected java.util.Set<DataRecord>	retrieveRecords(DataTemplate template) Stub implementation of retrieveRecords.
void	setInitParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Set 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

CommonMLAccessor

public CommonMLAccessor()

Method Detail

addFile

public void addFile(java.io.File file)
             throws java.io.IOException,
                    org.xml.sax.SAXException

Adds a file to this accessor. This method will scan the file to determine which type of file it is, if it is supported, and what the data structures contained within it are.

Parameters:

file - the file

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

org.xml.sax.SAXException - if there is a problem with the XML format

addFile

public void addFile(java.lang.String fileName)
             throws java.io.IOException,
                    org.xml.sax.SAXException

Adds a file by name to this accessor. This method will scan the file to determine which type of file it is, if it is supported, and what the data structures contained within it are.

Parameters:

fileName - the file name

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

org.xml.sax.SAXException - if there is a problem with the XML format

addUrl

public void addUrl(java.net.URL url)
            throws java.io.IOException,
                   org.xml.sax.SAXException

Adds a file by url to this accessor. This method will scan the file to determine which type of file it is, if it is supported, and what the data structures contained within it are.

Parameters:

url - the url to the file

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

org.xml.sax.SAXException - if there is a problem with the XML format

java.lang.IllegalArgumentException - if the file is in an unsupported format.

getDataset

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

Retrieves the named dataset. Currently unsupported.

Specified by:

getDataset in interface DataAccessor<DataRecord,DataRecord>

Overrides:

getDataset in class RecordAccessor

Parameters:

datasetName - the name of the dataset

Returns:

null

getGraph

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

Retrieves the named graph. This method retrieves the graph data from the corresponding URL which contains the information about the named graph. It reconstructs the graph from a GraphML file. This method retrieves the URL for the graph name, and then calls parseGraphML to retrieve the current graph data.

Specified by:

getGraph in interface DataAccessor<DataRecord,DataRecord>

Overrides:

getGraph in class RecordAccessor

Parameters:

graphName - the name of the graph

Returns:

the graph named, or null if there is no such graph

getGrid

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

Retrieves the named grid. Currently unsupported.

Specified by:

getGrid in interface DataAccessor<DataRecord,DataRecord>

Overrides:

getGrid in class RecordAccessor

Parameters:

gridName - the name of the grid

Returns:

null

getTree

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

Retrieves the named tree. This method retrieves the tree data from the corresponding URL which contains the information about the named tree. It reconstructs the tree from a TreeML file. This method retrieves the URL for the tree name, and then calls parseTreeML to retrieve the current tree data.

Specified by:

getTree in interface DataAccessor<DataRecord,DataRecord>

Overrides:

getTree in class RecordAccessor

Parameters:

treeName - the name of the tree

Returns:

the tree named, or null if there is no such tree

parseGraphML

public Graph<DataRecord,DataRecord> parseGraphML(java.io.InputStream inStream,
                                        java.lang.String graphName)
                                          throws org.xml.sax.SAXException,
                                                 java.io.IOException

Parses a stream containing a graphML format, and returns the graph with the matching name. If the graphName is null, the top-level graph is returned

Parameters:

inStream - the input stream to read from

graphName - the name of the graph

Returns:

the graph created from the graphML data

Throws:

org.xml.sax.SAXException - if there is a problem parsing the graphML

java.io.IOException - if there is a problem with the input stream

parseTreeML

public Tree<DataRecord> parseTreeML(java.io.InputStream inStream)
                             throws org.xml.sax.SAXException,
                                    java.io.IOException

Parses a stream containing a treeML format, and returns the tree contained in the treeML data

Parameters:

inStream - the input stream to read from

Returns:

the tree created from the treeML data

Throws:

org.xml.sax.SAXException - if there is a problem parsing the treeML

java.io.IOException - if there is a problem with the input stream

retrieveRecords

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

Stub implementation of retrieveRecords. Since this SemanticAccessor retrieves different data structures from specific data files, this method is never used.

Specified by:

retrieveRecords in class RecordAccessor

Parameters:

template - the DataTemplate

Returns:

an empty set

setInitParameters

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

Set initialization parameters.

Parameters:

parameters - initialization parameter map

setQuery

public void setQuery(java.lang.String query)

Set the query string used to retrieve records. This accessor ignors the query string.

Specified by:

setQuery in class AbstractDataAccessor<DataRecord,DataRecord>

Parameters:

query - the query string