@API(value=INTERNAL) public class TextScan extends Object implements PlanHashable
NOTE: This API is still a work in progress and might change in a future without notice. This class should not be used outside of the Record Layer project.
Constructor and Description |
---|
TextScan(Index index,
ScanComparisons groupingComparisons,
Comparisons.TextComparison textComparison,
ScanComparisons suffixComparisons) |
Modifier and Type | Method and Description |
---|---|
boolean |
createsDuplicates()
Determines whether this scan might return duplicate results for the same
record.
|
boolean |
equals(Object o) |
ScanComparisons |
getGroupingComparisons()
Get any grouping comparisons necessary to scan only within one grouping key.
|
Index |
getIndex()
Get the index being scanned.
|
ScanComparisons |
getSuffixComparisons()
Get any comparisons performed on fields of the index following the text field.
|
Comparisons.TextComparison |
getTextComparison()
Get the comparison performed on the text field.
|
int |
hashCode() |
int |
planHash()
Return a hash similar to
hashCode , but with the additional guarantee that is is stable across JVMs. |
<M extends Message> |
scan(FDBRecordStoreBase<M> store,
EvaluationContext context,
byte[] continuation,
ScanProperties scanProperties)
Scan the store to produce a cursor of index entries that all satisfy the comparison.
|
String |
toString() |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
combineHashes, iterablePlanHash, objectPlanHash, objectsPlanHash, planHash, planHash, planHashUnordered, stringHashUnordered
public TextScan(@Nonnull Index index, @Nullable ScanComparisons groupingComparisons, @Nonnull Comparisons.TextComparison textComparison, @Nullable ScanComparisons suffixComparisons)
@Nonnull public <M extends Message> RecordCursor<IndexEntry> scan(@Nonnull FDBRecordStoreBase<M> store, @Nonnull EvaluationContext context, @Nullable byte[] continuation, @Nonnull ScanProperties scanProperties)
M
- message type associated with the store and evaluation contextstore
- the record store for the querycontext
- the query evaluation contextcontinuation
- a continuation from a previous scan to resume query executionscanProperties
- execution properties of this scanpublic boolean createsDuplicates()
true
if this scan might return multiple entries for the same record@Nonnull public Index getIndex()
@Nullable public ScanComparisons getGroupingComparisons()
null
or an empty ScanComparisons
object.@Nonnull public Comparisons.TextComparison getTextComparison()
@Nullable public ScanComparisons getSuffixComparisons()
null
or an empty ScanComparisons
object.public int planHash()
PlanHashable
hashCode
, but with the additional guarantee that is is stable across JVMs.planHash
in interface PlanHashable