prajna.structure

Class DataAccessorClient<N extends java.io.Serializable,E extends java.io.Serializable>

java.lang.Object

prajna.structure.DataAccessorClient<N,E>

Type Parameters:

N - The node class for this DataAccessor. Must extend Serializable.

E - The edge class for this DataAccessor. Must extend Serializable.

All Implemented Interfaces:

DataAccessor<N,E>

public class DataAccessorClient<N extends java.io.Serializable,E extends java.io.Serializable>
extends java.lang.Object
implements DataAccessor<N,E>

Class which interacts with server-side DataAccessors. The DataAccessorClient connects to a RecordAccessorServlet, and retrieves the various data through servlet invocations. The data received from the servlet is transmitted as serialized objects to enhance performance.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
DataAccessorClient(java.net.URL documentBase) Creates a new DataAccessorClient object.

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.This method issues a servlet call to retrieve the grid names.
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	setDocBase(java.net.URL documentBase) Set the document base for this DataAccessorClient.
void	setInitParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Set any initialization parameters required by this data accessor.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataAccessorClient

public DataAccessorClient(java.net.URL documentBase)

Creates a new DataAccessorClient object. This constructor needs a document base so that it will know where to communicate with the server.

Parameters:

documentBase - The document base

Method Detail

extendGraph

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

Extend the given graph around the specified node. This method uses the basic graph retrieval, but adds the node's name as an additional argument attached to the graph name

Specified by:

extendGraph in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

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

public 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. This method uses the basic tree retrieval, but adds the node's name as an additional argument attached to the tree name

Specified by:

extendTree in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

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

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

Retrieve the dataset from the underlying data source. This method queries the servlet to retrieve the named dataset. The dataset is retrieved from the servlet in a serialized form.

Specified by:

getDataset in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Parameters:

datasetName - the name of the dataset

Returns:

the dataset

getDatasetNames

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

Get the names of the available datasets from this accessor. This method issues a servlet call to retrieve the dataset names. If there is a problem retrieving data, an empty set is returned.

Specified by:

getDatasetNames in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Returns:

the set of dataset names

getGraph

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

Retrieve the graph from the underlying data source. This method queries the servlet to retrieve the named graph. The graph is retrieved from the servlet in a serialized form.

Specified by:

getGraph in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Parameters:

graphName - the name of the graph

Returns:

the graph

getGraphNames

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

Get the names of the available graphs from this accessor. This method issues a servlet call to retrieve the graph names. If there is a problem retrieving data, an empty set is returned.

Specified by:

getGraphNames in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Returns:

the set of graph names

getGrid

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

Retrieve the grid from the underlying data source. This method queries the servlet to retrieve the named grid. The grid is retrieved from the servlet in a serialized form.

Specified by:

getGrid in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Parameters:

gridName - the name of the grid

Returns:

the grid

getGridNames

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

Get the names of the available grids from this accessor.This method issues a servlet call to retrieve the grid names. If there is a problem retrieving data, an empty set is returned.

Specified by:

getGridNames in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Returns:

the set of grid names

getStructureType

public DataStructureType getStructureType(java.lang.String dataName)

Get the data type for the specified dataName.

Specified by:

getStructureType in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Parameters:

dataName - the name of the data

Returns:

the data type

getTree

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

Retrieve the tree from the underlying data source. This method queries the servlet to retrieve the named tree. The tree is retrieved from the servlet in a serialized form.

Specified by:

getTree in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Parameters:

treeName - the name of the tree

Returns:

the tree

getTreeNames

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

Get the names of the available trees from this accessor. This method issues a servlet call to retrieve the tree names. If there is a problem retrieving data, an empty set is returned.

Specified by:

getTreeNames in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Returns:

the set of tree names

setConfig

public 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.

Specified by:

setConfig in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Parameters:

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

setDocBase

public void setDocBase(java.net.URL documentBase)

Set the document base for this DataAccessorClient.

Parameters:

documentBase - The document base

setInitParameters

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

Set any initialization parameters required by this data accessor. The DataAccessorClient looks for the docBase parameter, and initializes itself to the specified

Specified by:

setInitParameters in interface DataAccessor<N extends java.io.Serializable,E extends java.io.Serializable>

Parameters:

parameters - a map of initialization parameters