prajna.structure

Interface DataAccessor<N,E>

Type Parameters:

N - The node class, used in grids, datasets, trees, and the nodes of graphs

E - the edge class for graphs

All Known Subinterfaces:

StreamingAccessor<N,E>

All Known Implementing Classes:

AbstractDataAccessor, CommonMLAccessor, DataAccessorClient, DataCoordinator, DbpediaAccessor, DbpediaVerifier, DelimitedAccessor, FusionAccessor, JdbcAccessor, RecordAccessor, RecordAccessorClient, SolrAccessor, StreamSemanticAccessor, StructureReader, XmlDataAccessor

public interface DataAccessor<N,E>

The DataAccessor provides composite data as datasets, graphs, grids, and trees. A DataAccessor can assemble these structures in ways that are conducive to advanced analysis, visualization, and exploration. Each DataAccessor may access a specific data source (or sources), and provide the data in specific data structures.

The various data structures which can be provided are referenced by names. These names map to particular data structures, and the same name will always map to the same type of data structure. The individual DataAccessors may define these names in an implementation-specific fashion.

Not all structures may be available in every DataAccessor - for instance, one may not have any useful data which can be represented as a tree or a grid. Which data structures are available and provided by an individual DataAccessor is entirely up to the implementation.

Author:

Edward Swing

Method Summary

Methods

Modifier and Type	Method and Description
boolean	extendGraph(java.lang.String graphName, Graph<N,E> graph, N node) Extend the given graph around the specified node.
boolean	extendTree(java.lang.String treeName, Tree<N> tree, N node) Extend the given tree around the specified node.
java.util.Set<N>	getDataset(java.lang.String datasetName) Retrieve the dataset from the underlying data source.
java.util.Set<java.lang.String>	getDatasetNames() Get the names of the available datasets from this accessor.
Graph<N,E>	getGraph(java.lang.String graphName) Retrieve the graph from the underlying data source.
java.util.Set<java.lang.String>	getGraphNames() Get the names of the available graphs from this accessor.
Grid<N>	getGrid(java.lang.String gridName) Retrieve the grid from the underlying data source.
java.util.Set<java.lang.String>	getGridNames() Get the names of the available grids from this accessor.
DataStructureType	getStructureType(java.lang.String dataName) Get the data type for the specified dataName.
Tree<N>	getTree(java.lang.String treeName) Retrieve the tree from the underlying data source.
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 configuration information from an input stream.
void	setInitParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Set any initialization parameters required by this data accessor.

Method Detail

extendGraph

boolean extendGraph(java.lang.String graphName,
                  Graph<N,E> graph,
                  N node)

Extend the given graph around the specified node.

Parameters:

graphName - The name of the graph

graph - The graph to extend

node - The node to use as an extension point.

Returns:

true if more data was added to the graph, false otherwise.

extendTree

boolean extendTree(java.lang.String treeName,
                 Tree<N> tree,
                 N node)

Extend the given tree around the specified node. This method adds any children which are not already part of the tree.

Parameters:

treeName - The name of the graph

tree - The graph to extend

node - The node to use as an extension point.

Returns:

true if more data was added to the tree, false otherwise.

getDataset

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

Retrieve the dataset from the underlying data source.

Parameters:

datasetName - the name of the dataset

Returns:

the dataset

getDatasetNames

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

Get the names of the available datasets from this accessor.

Returns:

the set of dataset names

getGraph

Graph<N,E> getGraph(java.lang.String graphName)

Retrieve the graph from the underlying data source.

Parameters:

graphName - the name of the graph

Returns:

the graph

getGraphNames

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

Get the names of the available graphs from this accessor.

Returns:

the set of graph names

getGrid

Grid<N> getGrid(java.lang.String gridName)

Retrieve the grid from the underlying data source.

Parameters:

gridName - the name of the grid

Returns:

the grid

getGridNames

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

Get the names of the available grids from this accessor.

Returns:

the set of grid names

getStructureType

DataStructureType getStructureType(java.lang.String dataName)

Get the data type for the specified dataName.

Parameters:

dataName - the name of the data

Returns:

the data type

getTree

Tree<N> getTree(java.lang.String treeName)

Retrieve the tree from the underlying data source.

Parameters:

treeName - the name of the tree

Returns:

the tree

getTreeNames

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

Get the names of the available trees from this accessor.

Returns:

the set of tree names

setConfig

void setConfig(java.io.InputStream inStream)

Set the configuration information from an input stream. The input stream should contain any required initialization parameters. This method should initialize the data accessor if necessary. The format of the stream is implementation-dependent.

Parameters:

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

setInitParameters

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

Set any initialization parameters required by this data accessor.

Parameters:

parameters - a map of initialization parameters