org.cloudgraph.hbase.io

Interface TableReader

All Superinterfaces:

TableOperation, TableState

All Known Implementing Classes:

GraphTableReader

public interface TableReader
extends TableOperation

Provides access to 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

Method Summary

Modifier and Type	Method and Description
void	addRowReader(String rowKey, RowReader rowContext)
void	addRowReader(UUID uuid, RowReader rowContext) Adds the given row reader context mapping it to the given UUID.
void	clear() Frees resources associated with this reader and any component readers.
RowReader	createRowReader(commonj.sdo.DataObject dataObject, CellValues resultRow) Creates and adds a row reader based on the given data object and result row.
List<RowReader>	getAllRowReaders() Returns all row reader context values for this table 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 or null if null exists

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

close, getDistributedOperation, getTable

Methods inherited from interface org.cloudgraph.state.TableState

getMappingContext, getTableConfig

Method Detail

getQualifiedLogicalTableName

String getQualifiedLogicalTableName()

Returns the qualified logical table name associated with this reader.

Returns:

the qualified logical table name associated with this reader.

getQualifiedPhysicalTableName

String getQualifiedPhysicalTableName()

Returns the qualified physical table name associated with this reader.

Returns:

the qualified physical table name associated with this reader.

getQualifiedPhysicalTableNamespace

String getQualifiedPhysicalTableNamespace()

Returns the qualified physical table namespace associated with this reader.

Returns:

the qualified physical table namespace associated with this reader.

getRowReader

RowReader getRowReader(UUID uuid)

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

Parameters:

uuid - the UUID

Returns:

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

getRowReader

RowReader getRowReader(byte[] rowKey)

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

Parameters:

rowKey - the row key bytes

Returns:

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

getRowReader

RowReader getRowReader(String rowKey)

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

Parameters:

rowKey - the row key string

Returns:

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

getRowReader

RowReader getRowReader(commonj.sdo.DataObject dataObject)

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

Parameters:

dataObject - the data object

Returns:

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

addRowReader

void addRowReader(UUID uuid,
                  RowReader rowContext)
           throws IllegalArgumentException

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

Parameters:

uuid - the UUID

rowContext - the row reader context

Throws:

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

addRowReader

void addRowReader(String rowKey,
                  RowReader rowContext)
           throws IllegalArgumentException

Throws:

IllegalArgumentException

createRowReader

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.

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

getAllRowReaders

List<RowReader> getAllRowReaders()

Returns all row reader context values for this table context.

Returns:

all row reader context values for this table context.

clear

void clear()

Frees resources associated with this reader and any component readers.