org.cloudgraph.hbase.scan

Class ScanLiterals

java.lang.Object

org.cloudgraph.hbase.scan.ScanLiterals

public class ScanLiterals
extends Object

A collection of scan literals which provides various accessor methods which indicate the applicability of the scan literal collection under various scan operations. Given that a query may represent any number of scans or gets, clients should ensure that the collection is populated with literals applicable for its query expression context.

Since:

0.5

Author:

Scott Cinnamond

See Also:

ScanLiteral

Constructor Summary

Constructors

Constructor and Description
ScanLiterals()

Method Summary

Modifier and Type	Method and Description
void	addLiteral(ScanLiteral scanLiteral)
List<ScanLiteral>	getLiterals()
List<ScanLiteral>	getLiterals(DataRowKeyFieldMapping fieldConfig)
int	size()
boolean	supportCompleteRowKey(ScanCollector collector) Returns true if this set of literals can support a partial row key scan for the given graph
boolean	supportFuzzyRowKeyScan(ScanCollector collector) Returns true if this set of literals can support a fuzzy row key scan for the given graph
boolean	supportPartialRowKeyScan(ScanCollector collector) Returns true if this set of literals can support a partial row key scan for the given graph

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanLiterals

public ScanLiterals()

Method Detail

getLiterals

public List<ScanLiteral> getLiterals()

getLiterals

public List<ScanLiteral> getLiterals(DataRowKeyFieldMapping fieldConfig)

size

public int size()

addLiteral

public void addLiteral(ScanLiteral scanLiteral)

supportPartialRowKeyScan

public boolean supportPartialRowKeyScan(ScanCollector collector)

Returns true if this set of literals can support a partial row key scan for the given graph

Parameters:

graph - the graph

Returns:

true if this set of literals can support a partial row key scan for the given graph

supportFuzzyRowKeyScan

public boolean supportFuzzyRowKeyScan(ScanCollector collector)

Returns true if this set of literals can support a fuzzy row key scan for the given graph

Parameters:

graph - the graph

Returns:

true if this set of literals can support a fuzzy row key scan for the given graph

supportCompleteRowKey

public boolean supportCompleteRowKey(ScanCollector collector)

Returns true if this set of literals can support a partial row key scan for the given graph

Parameters:

graph - the graph

Returns:

true if this set of literals can support a partial row key scan for the given graph