org.cloudgraph.hbase.scan

Class PartialRowKeyScanAssembler

java.lang.Object

org.cloudgraph.hbase.scan.PartialRowKeyScanAssembler

All Implemented Interfaces:

PartialRowKey, RowKeyScanAssembler

public class PartialRowKeyScanAssembler
extends Object
implements RowKeyScanAssembler, PartialRowKey

Assembles a composite partial row (start/stop) key pair where each field within the composite start and stop row keys are constructed based a set of query predicates.

Since:

0.5

Author:

Scott Cinnamond

See Also:

DataGraphMapping, TableMapping, DataField, MetaField, MetaFieldName

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bufsize
protected Charset	charset
protected DataGraphMapping	graph
protected KeySupport	keySupport
protected StoreMappingContext	mappingContext
protected org.plasma.sdo.PlasmaType	rootType
protected String	rootUUID
protected ScanLiterals	scanLiterals
protected ByteBuffer	startKey
protected int	startRowFieldCount
protected ByteBuffer	stopKey
protected int	stopRowFieldCount
protected TableMapping	table

Constructor Summary

Constructors

Constructor and Description
PartialRowKeyScanAssembler(org.plasma.sdo.PlasmaType rootType, StoreMappingContext mappingContext) Constructor
PartialRowKeyScanAssembler(org.plasma.sdo.PlasmaType rootType, String rootUUID, StoreMappingContext mappingContext) Constructor which enables the use of data object UUID as a pre-defined row key field.

Method Summary

Modifier and Type	Method and Description
void	assemble() Assemble row key scan information based only on any meta row-key fields such as the data graph root type or URI.
void	assemble(ScanLiterals literals) Assemble row key scan information based on the given scan literals as well as meta row-key fields such as the data graph root type or URI.
void	assemble(org.plasma.query.model.Where where, org.plasma.sdo.PlasmaType contextType) Assemble row key scan information based on one or more given query predicates.
byte[]	getStartKey() Returns the start row key as a byte array.
byte[]	getStopKey() Returns the stop row key as a byte array.

Methods inherited from class java.lang.Object

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

Field Detail

bufsize

protected int bufsize

startKey

protected ByteBuffer startKey

stopKey

protected ByteBuffer stopKey

rootType

protected org.plasma.sdo.PlasmaType rootType

mappingContext

protected StoreMappingContext mappingContext

graph

protected DataGraphMapping graph

table

protected TableMapping table

keySupport

protected KeySupport keySupport

charset

protected Charset charset

scanLiterals

protected ScanLiterals scanLiterals

startRowFieldCount

protected int startRowFieldCount

stopRowFieldCount

protected int stopRowFieldCount

rootUUID

protected String rootUUID

Constructor Detail

PartialRowKeyScanAssembler

public PartialRowKeyScanAssembler(org.plasma.sdo.PlasmaType rootType,
                                  StoreMappingContext mappingContext)

Constructor

Parameters:

rootType - the root type

PartialRowKeyScanAssembler

public PartialRowKeyScanAssembler(org.plasma.sdo.PlasmaType rootType,
                                  String rootUUID,
                                  StoreMappingContext mappingContext)

Constructor which enables the use of data object UUID as a pre-defined row key field. Only applicable for graph predicate "slice" queries.

Parameters:

rootType - the root type

rootUUID - the root UUID.

Method Detail

assemble

public void assemble()

Assemble row key scan information based only on any meta row-key fields such as the data graph root type or URI.

Specified by:

assemble in interface RowKeyScanAssembler

See Also:

MetaField, MetaFieldName

assemble

public void assemble(ScanLiterals literals)

Assemble row key scan information based on the given scan literals as well as meta row-key fields such as the data graph root type or URI.

Specified by:

assemble in interface RowKeyScanAssembler

Parameters:

literalList - the scan literals

See Also:

MetaField, MetaFieldName

assemble

public void assemble(org.plasma.query.model.Where where,
                     org.plasma.sdo.PlasmaType contextType)

Assemble row key scan information based on one or more given query predicates.

Specified by:

assemble in interface RowKeyScanAssembler

Parameters:

where - the row predicate hierarchy

contextType - the context type which may be the root type or another type linked by one or more relations to the root

getStartKey

public byte[] getStartKey()

Returns the start row key as a byte array.

Specified by:

getStartKey in interface PartialRowKey

Returns:

the start row key

Throws:

IllegalStateException - if row keys are not yet assembled

getStopKey

public byte[] getStopKey()

Returns the stop row key as a byte array.

Specified by:

getStopKey in interface PartialRowKey

Returns:

the stop row key

Throws:

IllegalStateException - if row keys are not yet assembled