Package com.apple.foundationdb.record.lucene

Class LuceneIndexSpellCheckQueryPlan

java.lang.Object

com.apple.foundationdb.record.query.plan.plans.RecordQueryIndexPlan

com.apple.foundationdb.record.lucene.LuceneIndexQueryPlan

com.apple.foundationdb.record.lucene.LuceneIndexSpellCheckQueryPlan

All Implemented Interfaces:

PlanHashable, PlanSerializable, Correlated<RelationalExpression>, com.apple.foundationdb.record.query.plan.cascades.explain.PlannerGraphRewritable, RelationalExpression, Narrowable<RelationalExpression>, com.apple.foundationdb.record.query.plan.cascades.typing.Typed, QueryPlan<FDBQueriedRecord<Message>>, RecordQueryPlan, RecordQueryPlanWithComparisons, RecordQueryPlanWithConstraint, RecordQueryPlanWithExplain, RecordQueryPlanWithIndex, RecordQueryPlanWithMatchCandidate, RecordQueryPlanWithNoChildren, PlanWithOrderingKey, PlanWithStoredFields

public class LuceneIndexSpellCheckQueryPlan
extends LuceneIndexQueryPlan

Lucene query plan that allows to make spell-check suggestions.

Nested Class Summary

Nested classes/interfaces inherited from class com.apple.foundationdb.record.lucene.LuceneIndexQueryPlan

LuceneIndexQueryPlan.Deserializer

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.query.plan.cascades.Correlated

Correlated.BoundEquivalence<S extends Correlated<S>>

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.PlanHashable

PlanHashable.PlanHashKind, PlanHashable.PlanHashMode

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.query.plan.cascades.expressions.RelationalExpression

RelationalExpression.CombineFunction<R extends Object,S extends Object>, RelationalExpression.CombinePredicate

Field Summary

Fields inherited from class com.apple.foundationdb.record.query.plan.plans.RecordQueryIndexPlan

BASE_HASH, indexName, LOGGER, reverse, scanParameters, strictlySorted

Fields inherited from interface com.apple.foundationdb.record.PlanHashable

CURRENT_FOR_CONTINUATION, CURRENT_LEGACY

Fields inherited from interface com.apple.foundationdb.record.query.plan.plans.QueryPlan

UNKNOWN_MAX_CARDINALITY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LuceneIndexSpellCheckQueryPlan(String indexName, LuceneScanParameters scanParameters, RecordQueryFetchFromPartialRecordPlan.FetchIndexRecords fetchIndexRecords, boolean reverse, PlanOrderingKey planOrderingKey, List<KeyExpression> storedFields)

Method Summary

Modifier and Type	Method	Description
boolean	allowedForCoveringIndexPlan()	Auto-Complete and Spell-Check scan has their own implementation for IndexKeyValueToPartialRecord to build partial records, so they are not appropriate for the optimization by RecordQueryCoveringIndexPlan.
com.apple.foundationdb.record.query.plan.explain.ExplainTokensWithPrecedence	explain()
<M extends Message> RecordCursor<FDBQueriedRecord<M>>	fetchIndexRecords(FDBRecordStoreBase<M> store, EvaluationContext evaluationContext, Function<byte[],RecordCursor<IndexEntry>> entryCursorFunction, byte[] continuation, ExecuteProperties executeProperties)
protected RecordQueryIndexPlan	withIndexScanParameters(IndexScanParameters newIndexScanParameters)

Methods inherited from class com.apple.foundationdb.record.lucene.LuceneIndexQueryPlan

equals, fromProto, getComparisons, getPlanOrderingKey, getStoredFields, getStoredFields, hasComparisons, hashCode, of, toLuceneIndexPlanProto, toProto, toRecordQueryPlanProto

Methods inherited from class com.apple.foundationdb.record.query.plan.plans.RecordQueryIndexPlan

createIndexPlannerGraph, equalsWithoutChildren, executeEntries, executePlan, fromProto, getAvailableFields, getCommonPrimaryKey, getComparisonRanges, getComplexity, getConstraint, getCorrelatedTo, getFetchIndexRecords, getIndexFetchMethod, getIndexName, getMatchCandidateMaybe, getResultValue, getScanComparisons, getScanParameters, getScanType, getUsedIndexes, hasComparisonRanges, hasFullRecordScan, hashCodeWithoutChildren, hasIndexScan, hasLoadBykeys, hasRecordScan, hasScanComparisons, isReverse, isStrictlySorted, logPlanStructure, maxCardinality, planHash, strictlySorted, toRecordQueryIndexPlanProto, toString, translateCorrelations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.apple.foundationdb.record.query.plan.cascades.Correlated

isCorrelatedTo

Methods inherited from interface com.apple.foundationdb.record.query.plan.cascades.Narrowable

narrowMaybe

Methods inherited from interface com.apple.foundationdb.record.PlanHashable

planHash, planHash

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.QueryPlan

collectDescendantPlans, execute, execute

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.RecordQueryPlan

accept, execute, execute, execute, execute, getQueryPlanChildren, structuralEquals, structuralEquals, structuralHashCode

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.RecordQueryPlanWithIndex

rewritePlannerGraph

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.RecordQueryPlanWithMatchCandidate

getMatchCandidate

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.RecordQueryPlanWithNoChildren

getChildren, getQuantifiers

Methods inherited from interface com.apple.foundationdb.record.query.plan.cascades.expressions.RelationalExpression

acceptPropertyVisitor, adjustMatch, bindIdentities, canCorrelate, compensate, enumerateUnboundCorrelatedTo, exactlySubsumedBy, findMatches, getCorrelationOrder, getDynamicTypes, getMatchedQuantifiers, getResultType, hasIncompatibleBoundQuantifiers, hasUnboundQuantifiers, isCompatiblyAndCompletelyBound, match, match, rebase, semanticEquals, semanticEquals, semanticEqualsForResults, semanticHashCode, show, subsumedBy

Methods inherited from interface com.apple.foundationdb.record.query.plan.cascades.typing.Typed

describe

Constructor Details

LuceneIndexSpellCheckQueryPlan

protected LuceneIndexSpellCheckQueryPlan(@Nonnull
 String indexName,
 @Nonnull
 LuceneScanParameters scanParameters,
 @Nonnull
 RecordQueryFetchFromPartialRecordPlan.FetchIndexRecords fetchIndexRecords,
 boolean reverse,
 @Nullable
 PlanOrderingKey planOrderingKey,
 @Nullable
 List<KeyExpression> storedFields)

Method Details

fetchIndexRecords

@Nonnull
public <M extends Message>
RecordCursor<FDBQueriedRecord<M>> fetchIndexRecords(@Nonnull
 FDBRecordStoreBase<M> store,
 @Nonnull
 EvaluationContext evaluationContext,
 @Nonnull
 Function<byte[],RecordCursor<IndexEntry>> entryCursorFunction,
 @Nullable
 byte[] continuation,
 @Nonnull
 ExecuteProperties executeProperties)

allowedForCoveringIndexPlan

public boolean allowedForCoveringIndexPlan()

Auto-Complete and Spell-Check scan has their own implementation for IndexKeyValueToPartialRecord to build partial records, so they are not appropriate for the optimization by RecordQueryCoveringIndexPlan.

Specified by:

allowedForCoveringIndexPlan in interface RecordQueryPlanWithIndex

Overrides:

allowedForCoveringIndexPlan in class LuceneIndexQueryPlan

withIndexScanParameters

@Nonnull
protected RecordQueryIndexPlan withIndexScanParameters(@Nonnull
 IndexScanParameters newIndexScanParameters)

Overrides:

withIndexScanParameters in class LuceneIndexQueryPlan

explain

@Nonnull
public com.apple.foundationdb.record.query.plan.explain.ExplainTokensWithPrecedence explain()

Specified by:

explain in interface RecordQueryPlanWithExplain

Overrides:

explain in class LuceneIndexQueryPlan