org.cloudgraph.hbase.io

Class GraphTableReader

java.lang.Object

org.cloudgraph.state.GraphTable

org.cloudgraph.hbase.io.GraphTableReader

All Implemented Interfaces:

TableOperation, TableReader, TableState

public class GraphTableReader
extends GraphTable
implements TableReader

The operational, configuration and other state information required for read operations on a single graph table.

Acts as a container for one or more RowReader elements and encapsulates the HBase client Get operations for use in read operations across one or more graph rows.

Since:

0.5.1

Author:

Scott Cinnamond

See Also:

RowReader

Field Summary

Fields inherited from class org.cloudgraph.state.GraphTable

mappingContext, tableConfig

Constructor Summary

Constructors

Constructor and Description
GraphTableReader(TableMapping table, DistributedGraphOperation distributedOperation, StoreMappingContext mappingContext)

Method Summary

Modifier and Type	Method and Description
void	addRowReader(String rowKey, RowReader rowReader)
void	addRowReader(UUID uuid, RowReader rowReader) Adds the given row reader context mapping it to the given UUID
void	clear() Frees resources associated with this reader and any component readers.
void	close() Frees resources.
RowReader	createRowReader(commonj.sdo.DataObject dataObject, CellValues resultRow) Creates and adds a row reader based on the given data object and result row mapping it by UUID string and row key string.
List<RowReader>	getAllRowReaders() Returns all row reader context values for this table context.
DistributedGraphOperation	getDistributedOperation() Returns the distributed context associated with this table operation context.
String	getQualifiedLogicalTableName() Returns the qualified logical table name associated with this reader.
String	getQualifiedPhysicalTableName() Returns the qualified physical table name associated with this reader.
String	getQualifiedPhysicalTableNamespace() Returns the qualified physical table namespace associated with this reader.
RowReader	getRowReader(byte[] rowKey) Returns the row reader context for the given row key or null if null exists
RowReader	getRowReader(commonj.sdo.DataObject dataObject) Returns the row reader context for the given data object or null if null exists
RowReader	getRowReader(String rowKey) Returns the row reader context for the given row key or null if null exists
RowReader	getRowReader(UUID uuid) Returns the row reader context for the given UUID
org.apache.hadoop.hbase.client.Table	getTable() Returns the HBase table pooled connection for this context.

Methods inherited from class org.cloudgraph.state.GraphTable

getMappingContext, getTableConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cloudgraph.state.TableState

getMappingContext, getTableConfig

Constructor Detail

GraphTableReader

public GraphTableReader(TableMapping table,
                        DistributedGraphOperation distributedOperation,
                        StoreMappingContext mappingContext)

Method Detail

getQualifiedLogicalTableName

public String getQualifiedLogicalTableName()

Returns the qualified logical table name associated with this reader.

Specified by:

getQualifiedLogicalTableName in interface TableReader

Returns:

the qualified logical table name associated with this reader.

getQualifiedPhysicalTableName

public String getQualifiedPhysicalTableName()

Returns the qualified physical table name associated with this reader.

Specified by:

getQualifiedPhysicalTableName in interface TableReader

Returns:

the qualified physical table name associated with this reader.

getQualifiedPhysicalTableNamespace

public String getQualifiedPhysicalTableNamespace()

Returns the qualified physical table namespace associated with this reader.

Specified by:

getQualifiedPhysicalTableNamespace in interface TableReader

Returns:

the qualified physical table namespace associated with this reader.

getTable

public org.apache.hadoop.hbase.client.Table getTable()

Description copied from interface: TableOperation

Returns the HBase table pooled connection for this context.

Specified by:

getTable in interface TableOperation

Returns:

the HBase table pooled connection for this context.

getRowReader

public RowReader getRowReader(commonj.sdo.DataObject dataObject)

Returns the row reader context for the given data object or null if null exists

Specified by:

getRowReader in interface TableReader

Parameters:

dataObject - the data object

Returns:

the row reader context for the given data object or null if null exists

getRowReader

public RowReader getRowReader(byte[] rowKey)

Returns the row reader context for the given row key or null if null exists

Specified by:

getRowReader in interface TableReader

Parameters:

rowKey - the row key bytes

Returns:

the row reader context for the given row key or null if null exists

getRowReader

public RowReader getRowReader(String rowKey)

Description copied from interface: TableReader

Returns the row reader context for the given row key or null if null exists

Specified by:

getRowReader in interface TableReader

Parameters:

rowKey - the row key string

Returns:

the row reader context for the given row key or null if null exists

getRowReader

public RowReader getRowReader(UUID uuid)

Returns the row reader context for the given UUID

Specified by:

getRowReader in interface TableReader

Parameters:

uuid - the UUID

Returns:

the row reader context for the given UUID

addRowReader

public void addRowReader(UUID uuid,
                         RowReader rowReader)
                  throws IllegalArgumentException

Adds the given row reader context mapping it to the given UUID

Specified by:

addRowReader in interface TableReader

Parameters:

uuid - the UUID

rowReader - the row reader context

Throws:

IllegalArgumentException - if an existing row reader is already mapped for the given data object UUID

addRowReader

public void addRowReader(String rowKey,
                         RowReader rowReader)
                  throws IllegalArgumentException

Specified by:

addRowReader in interface TableReader

Throws:

IllegalArgumentException

getAllRowReaders

public List<RowReader> getAllRowReaders()

Returns all row reader context values for this table context.

Specified by:

getAllRowReaders in interface TableReader

Returns:

all row reader context values for this table context.

createRowReader

public RowReader createRowReader(commonj.sdo.DataObject dataObject,
                                 CellValues resultRow)
                          throws IllegalArgumentException

Creates and adds a row reader based on the given data object and result row mapping it by UUID string and row key string.

Specified by:

createRowReader in interface TableReader

Parameters:

dataObject - the data object

Returns:

the row reader

Throws:

IllegalArgumentException - if an existing row reader is already mapped for the given data object UUID

getDistributedOperation

public DistributedGraphOperation getDistributedOperation()

Returns the distributed context associated with this table operation context.

Specified by:

getDistributedOperation in interface TableOperation

Returns:

the distributed context associated with this table operation context.

clear

public void clear()

Frees resources associated with this reader and any component readers.

Specified by:

clear in interface TableReader

close

public void close()

Description copied from interface: TableOperation

Frees resources.

Specified by:

close in interface TableOperation