org.cloudgraph.hbase.io

Class DistributedGraphReader

java.lang.Object

org.cloudgraph.hbase.io.DistributedGraphReader

All Implemented Interfaces:

DistributedGraphOperation, DistributedReader

public class DistributedGraphReader
extends Object
implements DistributedReader

Encapsulates one or more graph table reader components for federation across multiple physical tables and/or physical table rows. Maps physical configured table names to respective table readers. In most usage scenarios, a "root" table reader is typically added initially, then other reader are incrementally added as association target types are detected and found configured as graph roots within another distinct table context.

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

Since:

0.5.1

Author:

Scott Cinnamond

See Also:

GraphTableReader, GraphTable

Constructor Summary

Constructors

Constructor and Description
DistributedGraphReader(commonj.sdo.Type rootType, List<commonj.sdo.Type> types, Connection connection, StoreMappingContext mappingContext)

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.
void	close() Closes tables and connections.
Connection	getConnection() returns the shared connection for the operation
StoreMappingContext	getMappingContext()
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, or null if not exists.
TableReader	getTableReader(String tableName) Returns the table reader for the given configured table name, or null of not exists.
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 reader.
boolean	hasSingleRootType() Returns true if only one table operation exists with only one associated (root) type for this 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 class java.lang.Object

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

Constructor Detail

DistributedGraphReader

public DistributedGraphReader(commonj.sdo.Type rootType,
                              List<commonj.sdo.Type> types,
                              Connection connection,
                              StoreMappingContext mappingContext)

Method Detail

getTableReader

public TableReader getTableReader(String tableName)

Returns the table reader for the given configured table name, or null of not exists.

Specified by:

getTableReader in interface DistributedReader

Parameters:

tableName - the name of the configured table.

Returns:

the table reader for the given configured table name, or null of not exists.

getTableReader

public TableReader getTableReader(QName qualifiedTypeName)

Returns the table reader for the given qualified type name, or null if not exists.

Specified by:

getTableReader in interface DistributedReader

Parameters:

qualifiedTypeName - the qualified type name.

Returns:

the table reader for the given qualified type name, or null if not exists.

addTableReader

public void addTableReader(TableReader reader)

Adds the given table reader to the container

Specified by:

addTableReader in interface DistributedReader

Parameters:

reader - the table reader.

getTableReaderCount

public int getTableReaderCount()

Returns the count of table readers for this container.

Specified by:

getTableReaderCount in interface DistributedReader

Returns:

the count of table readers for this container

getTableReaders

public List<TableReader> getTableReaders()

Returns all table readers for the this container

Specified by:

getTableReaders in interface DistributedReader

Returns:

all table readers for the this container

getRootTableReader

public TableReader getRootTableReader()

Returns the table reader associated with the data graph root.

Specified by:

getRootTableReader in interface DistributedReader

Returns:

the table reader associated with the data graph root.

setRootTableReader

public void setRootTableReader(TableReader reader)

Sets the table reader associated with the data graph root.

Specified by:

setRootTableReader in interface DistributedReader

Parameters:

reader - the table reader

getRowReader

public RowReader getRowReader(commonj.sdo.DataObject dataObject)

Returns the row reader associated with the given data object

Specified by:

getRowReader in interface DistributedReader

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

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

Specified by:

mapRowReader in interface DistributedReader

mapRowReader

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

Specified by:

mapRowReader in interface DistributedReader

mapRowReader

public void mapRowReader(byte[] rowKey,
                         RowReader rowReader)

Specified by:

mapRowReader in interface DistributedReader

getTypes

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

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

Specified by:

getTypes in interface DistributedReader

Parameters:

reader - the table reader

Returns:

a list of types associated with the given table reader.

hasSingleRootType

public boolean hasSingleRootType()

Returns true if only one table operation exists with only one associated (root) type for this operation.

Specified by:

hasSingleRootType in interface DistributedGraphOperation

Returns:

true if only one table operation exists with only one associated (root) type for this operation.

clear

public void clear()

Frees resources associated with this reader and any component readers.

Specified by:

clear in interface DistributedReader

getConnection

public Connection getConnection()

Description copied from interface: DistributedGraphOperation

returns the shared connection for the operation

Specified by:

getConnection in interface DistributedGraphOperation

close

public void close()

Description copied from interface: DistributedGraphOperation

Closes tables and connections.

Specified by:

close in interface DistributedGraphOperation

getMappingContext

public StoreMappingContext getMappingContext()

Specified by:

getMappingContext in interface DistributedGraphOperation