org.cloudgraph.hbase.io

Interface DistributedReader

All Superinterfaces:

DistributedGraphOperation

All Known Implementing Classes:

DistributedGraphReader

public interface DistributedReader
extends DistributedGraphOperation

Encapsulates one or more graph table reader components for federation across multiple physical tables and/or physical table rows.

Acts as a container for one or more TableReader elements encapsulating a set of component table reader operations for federation across multiple tables, or a single table in the most simple (degenerate) case.

Since:

0.5.1

Author:

Scott Cinnamond

See Also:

GraphTableReader, GraphTable

Method Summary

Modifier and Type	Method and Description
void	addTableReader(TableReader reader) Adds the given table reader to the container
void	clear() Frees resources associated with this reader and any component readers.
TableReader	getRootTableReader() Returns the table reader associated with the data graph root.
RowReader	getRowReader(commonj.sdo.DataObject dataObject) Returns the row reader associated with the given data object
TableReader	getTableReader(QName qualifiedTypeName) Returns the table reader for the given qualified type name.
TableReader	getTableReader(String tableName) Returns the table reader for the given configured table name.
int	getTableReaderCount() Returns the count of table readers for this container.
List<TableReader>	getTableReaders() Returns all table readers for the this container
List<commonj.sdo.Type>	getTypes(TableReader operation) Returns a list of types associated with the given table operation.
void	mapRowReader(byte[] rowKey, RowReader rowReader)
void	mapRowReader(commonj.sdo.DataObject dataObject, RowReader rowReader)
void	mapRowReader(long dataObjectSequence, org.plasma.sdo.PlasmaType type, RowReader rowReader)
void	setRootTableReader(TableReader reader) Sets the table reader associated with the data graph root.

Methods inherited from interface org.cloudgraph.hbase.io.DistributedGraphOperation

close, getConnection, getMappingContext, hasSingleRootType

Method Detail

getTableReader

TableReader getTableReader(String tableName)

Returns the table reader for the given configured table name.

Parameters:

tableName - the name of the configured table.

Returns:

the table reader for the given configured table name.

getTableReader

TableReader getTableReader(QName qualifiedTypeName)

Returns the table reader for the given qualified type name.

Parameters:

qualifiedTypeName - the qualified type name.

Returns:

the table reader for the given qualified type name.

addTableReader

void addTableReader(TableReader reader)

Adds the given table reader to the container

Parameters:

reader - the table reader.

getTableReaderCount

int getTableReaderCount()

Returns the count of table readers for this container.

Returns:

the count of table readers for this container

getTableReaders

List<TableReader> getTableReaders()

Returns all table readers for the this container

Returns:

all table readers for the this container

getRootTableReader

TableReader getRootTableReader()

Returns the table reader associated with the data graph root.

Returns:

the table reader associated with the data graph root.

setRootTableReader

void setRootTableReader(TableReader reader)

Sets the table reader associated with the data graph root.

Parameters:

reader - the table reader

getRowReader

RowReader getRowReader(commonj.sdo.DataObject dataObject)

Returns the row reader associated with the given data object

Parameters:

dataObject - the data object

Returns:

the row reader associated with the given data object

Throws:

IllegalArgumentException - if the given data object is not associated with any row reader.

mapRowReader

void mapRowReader(commonj.sdo.DataObject dataObject,
                  RowReader rowReader)

mapRowReader

void mapRowReader(long dataObjectSequence,
                  org.plasma.sdo.PlasmaType type,
                  RowReader rowReader)

mapRowReader

void mapRowReader(byte[] rowKey,
                  RowReader rowReader)

getTypes

List<commonj.sdo.Type> getTypes(TableReader operation)

Returns a list of types associated with the given table operation.

Parameters:

reader - the table operation

Returns:

a list of types associated with the given table operation.

clear

void clear()

Frees resources associated with this reader and any component readers.