org.cloudgraph.hbase.scan

Class ScanContext

java.lang.Object

org.plasma.query.visitor.DefaultQueryVisitor

org.cloudgraph.hbase.scan.ScanContext

All Implemented Interfaces:

org.plasma.query.visitor.QueryVisitor

Deprecated.

@Deprecated
public class ScanContext
extends org.plasma.query.visitor.DefaultQueryVisitor

Conducts an initial traversal while capturing and analyzing the characteristics of a query in order to leverage the important HBase partial row-key scan capability for every possible predicate expression.

Based on the various access methods, if a client determines that an HBase partial row-key scan is possible based, a PartialRowKeyScanAssembler may be invoked using the current scan context resulting is a precise set of composite start/stop row keys. These are used in HBase client scan API start and stop row.

Since:

0.5

Author:

Scott Cinnamond

Field Summary

Fields

Modifier and Type	Field and Description
protected ScanLiterals	fuzzyKeyScanLiterals Deprecated.
protected DataGraphMapping	graph Deprecated.
protected boolean	hasContiguousPartialKeyScanFieldValues Deprecated.
protected boolean	hasOnlyPartialKeyScanSupportedLogicalOperators Deprecated.
protected boolean	hasOnlyPartialKeyScanSupportedRelationalOperators Deprecated.
protected ScanLiterals	partialKeyScanLiterals Deprecated.
protected org.plasma.sdo.PlasmaType	rootType Deprecated.

Constructor Summary

Constructors

Constructor and Description
ScanContext(org.plasma.sdo.PlasmaType rootType, org.plasma.query.model.Where where, StoreMappingContext mappingContext) Deprecated. Conducts an initial traversal while capturing and analyzing the characteristics of a query in order to leverage the important HBase partial row-key scan capability for every possible predicate expression.

Method Summary

Modifier and Type	Method and Description
boolean	canUseFuzzyKeyScan() Deprecated.
boolean	canUsePartialKeyScan() Deprecated. Returns whether an HBase partial row-key scan is possible under the current scan context.
ScanLiterals	getFuzzyKeyScanLiterals() Deprecated.
ScanLiterals	getPartialKeyScanLiterals() Deprecated. Return the current scan literals.
boolean	hasContiguousFieldValues() Deprecated. Returns whether the underlying query predicates represent a contiguous set of composite row-key fields making a partial row-key scan possible.
boolean	hasOnlyPartialKeyScanSupportedLogicalOperators() Deprecated. Returns whether the underlying query contains only logical operators supportable for under a partial row-key scan.
boolean	hasOnlyPartialKeyScanSupportedRelationalOperators() Deprecated. Returns whether the underlying query contains only relational operators supportable for under a partial row-key scan.
void	start(org.plasma.query.model.GroupOperator operator) Deprecated. Process the traversal start event for a query GroupOperator within an expression creating context information useful for determining an HBase scan strategy.
void	start(org.plasma.query.model.LogicalOperator operator) Deprecated. Process the traversal start event for a query LogicalOperator within an expression creating context information useful for determining an HBase scan strategy.
void	start(org.plasma.query.model.PredicateOperator operator) Deprecated. Process the traversal start event for a query WildcardOperator within an expression creating context information useful for determining an HBase scan strategy.
void	start(org.plasma.query.model.RelationalOperator operator) Deprecated. Process the traversal start event for a query RelationalOperator within an expression creating context information useful for determining an HBase scan strategy.

Methods inherited from class org.plasma.query.visitor.DefaultQueryVisitor

end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, end, getContext, start, start, start, start, start, start, start, start, start, start, start, start, start, start, start, start, start, start, start, start, start

Methods inherited from class java.lang.Object

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

Field Detail

rootType

protected org.plasma.sdo.PlasmaType rootType

Deprecated.

graph

protected DataGraphMapping graph

Deprecated.

partialKeyScanLiterals

protected ScanLiterals partialKeyScanLiterals

Deprecated.

fuzzyKeyScanLiterals

protected ScanLiterals fuzzyKeyScanLiterals

Deprecated.

hasContiguousPartialKeyScanFieldValues

protected boolean hasContiguousPartialKeyScanFieldValues

Deprecated.

hasOnlyPartialKeyScanSupportedLogicalOperators

protected boolean hasOnlyPartialKeyScanSupportedLogicalOperators

Deprecated.

hasOnlyPartialKeyScanSupportedRelationalOperators

protected boolean hasOnlyPartialKeyScanSupportedRelationalOperators

Deprecated.

Constructor Detail

ScanContext

public ScanContext(org.plasma.sdo.PlasmaType rootType,
                   org.plasma.query.model.Where where,
                   StoreMappingContext mappingContext)

Deprecated.

Conducts an initial traversal while capturing and analyzing the characteristics of a query in order to leverage the important HBase partial row-key scan capability for every possible predicate expression.

Parameters:

rootType - the root type

where - the predicates

Method Detail

getPartialKeyScanLiterals

public ScanLiterals getPartialKeyScanLiterals()

Deprecated.

Return the current scan literals.

Returns:

the current scan literals.

getFuzzyKeyScanLiterals

public ScanLiterals getFuzzyKeyScanLiterals()

Deprecated.

canUsePartialKeyScan

public boolean canUsePartialKeyScan()

Deprecated.

Returns whether an HBase partial row-key scan is possible under the current scan context.

Returns:

whether an HBase partial row-key scan is possible under the current scan context.

canUseFuzzyKeyScan

public boolean canUseFuzzyKeyScan()

Deprecated.

hasContiguousFieldValues

public boolean hasContiguousFieldValues()

Deprecated.

Returns whether the underlying query predicates represent a contiguous set of composite row-key fields making a partial row-key scan possible.

Returns:

whether the underlying query predicates represent a contiguous set of composite row-key fields making a partial row-key scan possible.

hasOnlyPartialKeyScanSupportedLogicalOperators

public boolean hasOnlyPartialKeyScanSupportedLogicalOperators()

Deprecated.

Returns whether the underlying query contains only logical operators supportable for under a partial row-key scan.

Returns:

whether the underlying query contains only logical operators supportable for under a partial row-key scan.

hasOnlyPartialKeyScanSupportedRelationalOperators

public boolean hasOnlyPartialKeyScanSupportedRelationalOperators()

Deprecated.

Returns whether the underlying query contains only relational operators supportable for under a partial row-key scan.

Returns:

whether the underlying query contains only relational operators supportable for under a partial row-key scan.

start

public void start(org.plasma.query.model.PredicateOperator operator)

Deprecated.

Process the traversal start event for a query WildcardOperator within an expression creating context information useful for determining an HBase scan strategy.

Specified by:

start in interface org.plasma.query.visitor.QueryVisitor

Overrides:

start in class org.plasma.query.visitor.DefaultQueryVisitor

Parameters:

literal - the expression literal

Throws:

GraphServiceException - if an unknown wild card operator is encountered.

start

public void start(org.plasma.query.model.LogicalOperator operator)

Deprecated.

Process the traversal start event for a query LogicalOperator within an expression creating context information useful for determining an HBase scan strategy.

Specified by:

start in interface org.plasma.query.visitor.QueryVisitor

Overrides:

start in class org.plasma.query.visitor.DefaultQueryVisitor

Parameters:

literal - the expression literal

Throws:

GraphServiceException - if an unknown logical operator is encountered.

start

public void start(org.plasma.query.model.RelationalOperator operator)

Deprecated.

Process the traversal start event for a query RelationalOperator within an expression creating context information useful for determining an HBase scan strategy.

Specified by:

start in interface org.plasma.query.visitor.QueryVisitor

Overrides:

start in class org.plasma.query.visitor.DefaultQueryVisitor

Parameters:

literal - the expression literal

Throws:

GraphServiceException - if an unknown relational operator is encountered.

start

public void start(org.plasma.query.model.GroupOperator operator)

Deprecated.

Process the traversal start event for a query GroupOperator within an expression creating context information useful for determining an HBase scan strategy.

Specified by:

start in interface org.plasma.query.visitor.QueryVisitor

Overrides:

start in class org.plasma.query.visitor.DefaultQueryVisitor

Parameters:

literal - the expression literal

Throws:

GraphServiceException - if an unknown group operator is encountered.