org.cloudgraph.hbase.scan

Class TemporalLiteral

java.lang.Object

org.cloudgraph.hbase.scan.ScanLiteral

org.cloudgraph.hbase.scan.TemporalLiteral

All Implemented Interfaces:

CompleteRowKeyLiteral, FuzzyRowKeyLiteral, PartialRowKeyLiteral

public class TemporalLiteral
extends ScanLiteral
implements PartialRowKeyLiteral, FuzzyRowKeyLiteral, CompleteRowKeyLiteral

A temporal data "flavor" specific literal class 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. A temporal literal does not contain or involve wildcards but nevertheless may "participate" in a fuzzy scan as part of a composite row key and therefore implements FuzzyRowKeyLiteral supplying only default key and info bytes.

See Also:

TableMapping, HBaseDataConverter

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATE_INCREMENT
static int	DATE_TIME_INCREMENT
static int	INCREMENT

Fields inherited from class org.cloudgraph.hbase.scan.ScanLiteral

charset, dataConverter, fieldMapping, HASH_INCREMENT, keySupport, literal, logicalOperatorContext, property, relationalOperator, rootType, table

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
byte[]	getEqualsBytes() Returns the bytes used to represent an "equals" relational operator for a specific composite row key field, under an HBase 'Get' operation for the various optionally configurable hashing, formatting and padding features.
byte[]	getEqualsStartBytes() Returns the "start row" bytes used to represent "equals" relational operator under an HBase partial row-key scan for this string (data flavor) literal under the various optionally configurable hashing, formatting and padding features.
byte[]	getEqualsStopBytes() Returns the "stop row" bytes used to represent "equals" relational operator under an HBase partial row-key scan for this string (data flavor) literal under the various optionally configurable hashing, formatting and padding features.
byte[]	getFuzzyInfoBytes()
byte[]	getFuzzyKeyBytes()
byte[]	getGreaterThanEqualStartBytes() Returns the "start row" bytes used to represent "greater than equals" relational operator under an HBase partial row-key scan for this string (data flavor) literal under the various optionally configurable hashing, formatting and padding features.
byte[]	getGreaterThanEqualStopBytes() The "greater than equals" relational operator does not effect the stop bytes for an HBase partial row-key scan and this method therefore returns an empty byte array or "no-op".
byte[]	getGreaterThanStartBytes() Returns the "start row" bytes used to represent "greater than" relational operator under an HBase partial row-key scan for this string (data flavor) literal under the various optionally configurable hashing, formatting and padding features.
byte[]	getGreaterThanStopBytes() The "greater than" relational operator does not effect the stop bytes for an HBase partial row-key scan and this method therefore returns an empty byte array or "no-op".
protected int	getIncrement(org.plasma.sdo.DataType dataType)
byte[]	getLessThanEqualStartBytes() The "less than equal" relational operator does not effect the start bytes for an HBase partial row-key scan and this method therefore returns an empty byte array or "no-op".
byte[]	getLessThanEqualStopBytes() Returns the "stop row" bytes used to represent "less than equals" relational operator under an HBase partial row-key scan for this string (data flavor) literal under the various optionally configurable hashing, formatting and padding features.
byte[]	getLessThanStartBytes() The "less than" relational operator does not effect the start bytes for an HBase partial row-key scan and this method therefore returns an empty byte array or "no-op".
byte[]	getLessThanStopBytes() Returns the "stop row" bytes used to represent "less than" relational operator under an HBase partial row-key scan for this string (data flavor) literal under the various optionally configurable hashing, formatting and padding features.

Methods inherited from class org.cloudgraph.hbase.scan.ScanLiteral

getContent, getFieldConfig, getLogicalOperatorContext, getRelationalOperator, getStartBytes, getStopBytes, hastLogicalOperatorContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cloudgraph.hbase.scan.PartialRowKeyLiteral

getStartBytes, getStopBytes

Field Detail

INCREMENT

public static final int INCREMENT

See Also:

Constant Field Values

DATE_INCREMENT

public static final int DATE_INCREMENT

See Also:

Constant Field Values

DATE_TIME_INCREMENT

public static final int DATE_TIME_INCREMENT

See Also:

Constant Field Values

Constructor Detail

TemporalLiteral

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

Method Detail

getIncrement

protected int getIncrement(org.plasma.sdo.DataType dataType)

getEqualsStartBytes

public byte[] getEqualsStartBytes()

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

Specified by:

getEqualsStartBytes in interface PartialRowKeyLiteral

Specified by:

getEqualsStartBytes in class ScanLiteral

Returns:

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

getEqualsStopBytes

public byte[] getEqualsStopBytes()

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

Specified by:

getEqualsStopBytes in interface PartialRowKeyLiteral

Specified by:

getEqualsStopBytes in class ScanLiteral

Returns:

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

getGreaterThanStartBytes

public byte[] getGreaterThanStartBytes()

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

Specified by:

getGreaterThanStartBytes in interface PartialRowKeyLiteral

Specified by:

getGreaterThanStartBytes in class ScanLiteral

Returns:

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

getGreaterThanStopBytes

public byte[] getGreaterThanStopBytes()

The "greater than" relational operator does not effect the stop bytes for an HBase partial row-key scan and this method therefore returns an empty byte array or "no-op".

Specified by:

getGreaterThanStopBytes in interface PartialRowKeyLiteral

Specified by:

getGreaterThanStopBytes in class ScanLiteral

Returns:

an empty byte array or "no-op".

getGreaterThanEqualStartBytes

public byte[] getGreaterThanEqualStartBytes()

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

Specified by:

getGreaterThanEqualStartBytes in interface PartialRowKeyLiteral

Specified by:

getGreaterThanEqualStartBytes in class ScanLiteral

Returns:

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

getGreaterThanEqualStopBytes

public byte[] getGreaterThanEqualStopBytes()

The "greater than equals" relational operator does not effect the stop bytes for an HBase partial row-key scan and this method therefore returns an empty byte array or "no-op".

Specified by:

getGreaterThanEqualStopBytes in interface PartialRowKeyLiteral

Specified by:

getGreaterThanEqualStopBytes in class ScanLiteral

Returns:

an empty byte array or "no-op".

getLessThanStartBytes

public byte[] getLessThanStartBytes()

The "less than" relational operator does not effect the start bytes for an HBase partial row-key scan and this method therefore returns an empty byte array or "no-op".

Specified by:

getLessThanStartBytes in interface PartialRowKeyLiteral

Specified by:

getLessThanStartBytes in class ScanLiteral

Returns:

an empty byte array or "no-op".

getLessThanStopBytes

public byte[] getLessThanStopBytes()

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

Specified by:

getLessThanStopBytes in interface PartialRowKeyLiteral

Specified by:

getLessThanStopBytes in class ScanLiteral

Returns:

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

getLessThanEqualStartBytes

public byte[] getLessThanEqualStartBytes()

The "less than equal" relational operator does not effect the start bytes for an HBase partial row-key scan and this method therefore returns an empty byte array or "no-op".

Specified by:

getLessThanEqualStartBytes in interface PartialRowKeyLiteral

Specified by:

getLessThanEqualStartBytes in class ScanLiteral

Returns:

an empty byte array or "no-op".

getLessThanEqualStopBytes

public byte[] getLessThanEqualStopBytes()

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

Specified by:

getLessThanEqualStopBytes in interface PartialRowKeyLiteral

Specified by:

getLessThanEqualStopBytes in class ScanLiteral

Returns:

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

getEqualsBytes

public byte[] getEqualsBytes()

Returns the bytes used to represent an "equals" relational operator for a specific composite row key field, under an HBase 'Get' operation for the various optionally configurable hashing, formatting and padding features.

Specified by:

getEqualsBytes in interface CompleteRowKeyLiteral

Returns:

the bytes used to represent an "equals" relational operator for a specific composite row key field, under an HBase 'Get' operation for the various optionally configurable hashing, formatting and padding features.

getFuzzyKeyBytes

public byte[] getFuzzyKeyBytes()

Specified by:

getFuzzyKeyBytes in interface FuzzyRowKeyLiteral

getFuzzyInfoBytes

public byte[] getFuzzyInfoBytes()

Specified by:

getFuzzyInfoBytes in interface FuzzyRowKeyLiteral