org.cloudgraph.hbase.scan

Class ScanLiteral

java.lang.Object

org.cloudgraph.hbase.scan.ScanLiteral

Direct Known Subclasses:

IntegralLiteral, RealLiteral, StringLiteral, TemporalLiteral

public abstract class ScanLiteral
extends Object

A configuration driven, context rich abstract class where subclasses are data "flavor" and data type specific and used to abstract the complexities involved in assembling the various segments and fields of composite (scan start/stop) row keys under various relational and logical operator and various configurable composite key-field hashing, formatting, padding and other features.

Since:

0.5

Author:

Scott Cinnamond

See Also:

TableMapping

Field Summary

Fields

Modifier and Type	Field and Description
protected Charset	charset
protected org.plasma.sdo.helper.DataConverter	dataConverter
protected DataRowKeyFieldMapping	fieldMapping
protected int	HASH_INCREMENT
protected KeySupport	keySupport
protected String	literal
protected org.plasma.query.model.LogicalOperatorName	logicalOperatorContext
protected org.plasma.sdo.PlasmaProperty	property
protected org.plasma.query.model.RelationalOperatorName	relationalOperator Deprecated.
protected org.plasma.sdo.PlasmaType	rootType
protected TableMapping	table

Constructor Summary

Constructors

Constructor and Description
ScanLiteral(String literal, org.plasma.sdo.PlasmaType rootType, org.plasma.query.model.RelationalOperatorName relationalOperator, org.plasma.query.model.LogicalOperatorName logicalOperatorContext, DataRowKeyFieldMapping fieldMapping, StoreMappingContext mappingContext)

Method Summary

Modifier and Type	Method and Description
String	getContent() Returns the string literal
abstract byte[]	getEqualsStartBytes() Returns the "start row" bytes used to represent "equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.
abstract byte[]	getEqualsStopBytes() Returns the "stop row" bytes used to represent "equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.
DataRowKeyFieldMapping	getFieldConfig() Returns the composite row-key field configuration.
abstract byte[]	getGreaterThanEqualStartBytes() Returns the "start row" bytes used to represent "greater than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.
abstract byte[]	getGreaterThanEqualStopBytes() Returns the "stop row" bytes used to represent "greater than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.
abstract byte[]	getGreaterThanStartBytes() Returns the "start row" bytes used to represent "greater than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.
abstract byte[]	getGreaterThanStopBytes() Returns the "stop row" bytes used to represent "greater than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.
abstract byte[]	getLessThanEqualStartBytes() Returns the "start row" bytes used to represent "less than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.
abstract byte[]	getLessThanEqualStopBytes() Returns the "stop row" bytes used to represent "less than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.
abstract byte[]	getLessThanStartBytes() Returns the "start row" bytes used to represent "less than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.
abstract byte[]	getLessThanStopBytes() Returns the "stop row" bytes used to represent "less than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.
org.plasma.query.model.LogicalOperatorName	getLogicalOperatorContext()
org.plasma.query.model.RelationalOperatorName	getRelationalOperator() Returns the context relational operator.
byte[]	getStartBytes() Returns the HBase scan "start-row" composite row-key field bytes for this literal under the various relational, logical operator and other optionally configurable hashing, formatting and padding features.
byte[]	getStopBytes() Returns the HBase scan "stop-row" composite row-key field bytes for this literal under the various relational, logical operator and other optionally configurable hashing, formatting and padding features.
boolean	hastLogicalOperatorContext()

Methods inherited from class java.lang.Object

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

Field Detail

HASH_INCREMENT

protected final int HASH_INCREMENT

See Also:

Constant Field Values

literal

protected String literal

relationalOperator

@Deprecated
protected org.plasma.query.model.RelationalOperatorName relationalOperator

Deprecated.

fieldMapping

protected DataRowKeyFieldMapping fieldMapping

dataConverter

protected org.plasma.sdo.helper.DataConverter dataConverter

rootType

protected org.plasma.sdo.PlasmaType rootType

charset

protected Charset charset

table

protected TableMapping table

keySupport

protected KeySupport keySupport

property

protected org.plasma.sdo.PlasmaProperty property

logicalOperatorContext

protected org.plasma.query.model.LogicalOperatorName logicalOperatorContext

Constructor Detail

ScanLiteral

public ScanLiteral(String literal,
                   org.plasma.sdo.PlasmaType rootType,
                   org.plasma.query.model.RelationalOperatorName relationalOperator,
                   org.plasma.query.model.LogicalOperatorName logicalOperatorContext,
                   DataRowKeyFieldMapping fieldMapping,
                   StoreMappingContext mappingContext)

Method Detail

hastLogicalOperatorContext

public boolean hastLogicalOperatorContext()

getLogicalOperatorContext

public org.plasma.query.model.LogicalOperatorName getLogicalOperatorContext()

getContent

public final String getContent()

Returns the string literal

Returns:

the string literal

getRelationalOperator

public final org.plasma.query.model.RelationalOperatorName getRelationalOperator()

Returns the context relational operator.

Returns:

the context relational operator.

getFieldConfig

public final DataRowKeyFieldMapping getFieldConfig()

Returns the composite row-key field configuration.

Returns:

the composite row-key field configuration.

getStartBytes

public byte[] getStartBytes()

Returns the HBase scan "start-row" composite row-key field bytes for this literal under the various relational, logical operator and other optionally configurable hashing, formatting and padding features.

Returns:

the HBase scan "start-row" composite row-key field bytes for this literal under the various relational, logical operator and other optionally configurable hashing, formatting and padding features.

getStopBytes

public byte[] getStopBytes()

Returns the HBase scan "stop-row" composite row-key field bytes for this literal under the various relational, logical operator and other optionally configurable hashing, formatting and padding features.

Returns:

the HBase scan "stop-row" composite row-key field bytes for this literal under the various relational, logical operator and other optionally configurable hashing, formatting and padding features.

getEqualsStartBytes

public abstract byte[] getEqualsStartBytes()

Returns the "start row" bytes used to represent "equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

Returns:

the "start row" bytes used to represent "equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

getEqualsStopBytes

public abstract byte[] getEqualsStopBytes()

Returns the "stop row" bytes used to represent "equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

Returns:

the "stop row" bytes used to represent "equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

getGreaterThanStartBytes

public abstract byte[] getGreaterThanStartBytes()

Returns the "start row" bytes used to represent "greater than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

Returns:

the "start row" bytes used to represent "greater than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

getGreaterThanStopBytes

public abstract byte[] getGreaterThanStopBytes()

Returns the "stop row" bytes used to represent "greater than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

Returns:

the "stop row" bytes used to represent "greater than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

getGreaterThanEqualStartBytes

public abstract byte[] getGreaterThanEqualStartBytes()

Returns the "start row" bytes used to represent "greater than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

Returns:

the "start row" bytes used to represent "greater than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

getGreaterThanEqualStopBytes

public abstract byte[] getGreaterThanEqualStopBytes()

Returns the "stop row" bytes used to represent "greater than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

Returns:

the "stop row" bytes used to represent "greater than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

getLessThanStartBytes

public abstract byte[] getLessThanStartBytes()

Returns the "start row" bytes used to represent "less than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

Returns:

the "start row" bytes used to represent "less than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

getLessThanStopBytes

public abstract byte[] getLessThanStopBytes()

Returns the "stop row" bytes used to represent "less than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

Returns:

the "stop row" bytes used to represent "less than" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

getLessThanEqualStartBytes

public abstract byte[] getLessThanEqualStartBytes()

Returns the "start row" bytes used to represent "less than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

Returns:

the "start row" bytes used to represent "less than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

getLessThanEqualStopBytes

public abstract byte[] getLessThanEqualStopBytes()

Returns the "stop row" bytes used to represent "less than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.

Returns:

the "stop row" bytes used to represent "less than equals" relational operator under an HBase partial row-key scan for this literal under the various optionally configurable hashing, formatting and padding features.