Package com.apple.foundationdb.record.lucene

Class LuceneScanParameters

java.lang.Object

com.apple.foundationdb.record.lucene.LuceneScanParameters

All Implemented Interfaces:

PlanHashable, PlanSerializable, IndexScanParameters, Correlated<IndexScanParameters>

Direct Known Subclasses:

LuceneScanQueryParameters, LuceneScanSpellCheckParameters

@API(UNSTABLE)
public abstract class LuceneScanParameters
extends Object
implements IndexScanParameters

Base class for IndexScanParameters used by LUCENE indexes. Stores any group comparisons used to determine the directory location.

Nested Class Summary

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final ScanComparisons	groupComparisons
protected final IndexScanType	scanType

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

CURRENT_FOR_CONTINUATION, CURRENT_LEGACY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LuceneScanParameters(IndexScanType scanType, ScanComparisons groupComparisons)
protected	LuceneScanParameters(PlanSerializationContext serializationContext, com.apple.foundationdb.record.planprotos.PLuceneScanParameters luceneScanParametersProto)

Method Summary

Modifier and Type	Method	Description
abstract LuceneScanBounds	bind(FDBRecordStoreBase<?> store, Index index, EvaluationContext context)
boolean	equals(Object o)
ScanComparisons	getGroupComparisons()
protected Tuple	getGroupKey(FDBRecordStoreBase<?> store, EvaluationContext context)
Tuple	getGroupKeyWithoutContext()
protected String	getGroupScanDetails()
void	getPlannerGraphDetails(com.google.common.collect.ImmutableList.Builder<String> detailsBuilder, com.google.common.collect.ImmutableMap.Builder<String,com.apple.foundationdb.record.query.plan.cascades.explain.Attribute> attributeMapBuilder)
IndexScanType	getScanType()
int	hashCode()
protected static List<String>	indexTextFields(Index index, RecordMetaData metaData)
boolean	isUnique(Index index)
com.apple.foundationdb.record.planprotos.PLuceneScanParameters	toLuceneScanParametersProto(PlanSerializationContext serializationContext)
String	toString()

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

getCorrelatedTo, isCorrelatedTo, rebase, semanticEquals, semanticHashCode

Methods inherited from interface com.apple.foundationdb.record.provider.foundationdb.IndexScanParameters

explain, toIndexScanParametersProto, translateCorrelations

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

planHash, planHash, planHash

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

toProto

Field Details

scanType

@Nonnull
protected final IndexScanType scanType

groupComparisons

@Nonnull
protected final ScanComparisons groupComparisons

Constructor Details

LuceneScanParameters

protected LuceneScanParameters(@Nonnull
 PlanSerializationContext serializationContext,
 @Nonnull
 com.apple.foundationdb.record.planprotos.PLuceneScanParameters luceneScanParametersProto)

LuceneScanParameters

protected LuceneScanParameters(@Nonnull
 IndexScanType scanType,
 @Nonnull
 ScanComparisons groupComparisons)

Method Details

getScanType

@Nonnull
public IndexScanType getScanType()

Specified by:

getScanType in interface IndexScanParameters

bind

@Nonnull
public abstract LuceneScanBounds bind(@Nonnull
 FDBRecordStoreBase<?> store,
 @Nonnull
 Index index,
 @Nonnull
 EvaluationContext context)

Specified by:

bind in interface IndexScanParameters

getGroupComparisons

@Nonnull
public ScanComparisons getGroupComparisons()

indexTextFields

@Nonnull
protected static List<String> indexTextFields(@Nonnull
 Index index,
 @Nonnull
 RecordMetaData metaData)

isUnique

public boolean isUnique(@Nonnull
 Index index)

Specified by:

isUnique in interface IndexScanParameters

getGroupScanDetails

protected String getGroupScanDetails()

getGroupKey

@Nonnull
protected Tuple getGroupKey(@Nullable
 FDBRecordStoreBase<?> store,
 @Nullable
 EvaluationContext context)

getGroupKeyWithoutContext

@Nullable
public Tuple getGroupKeyWithoutContext()

getPlannerGraphDetails

public void getPlannerGraphDetails(@Nonnull
 com.google.common.collect.ImmutableList.Builder<String> detailsBuilder,
 @Nonnull
 com.google.common.collect.ImmutableMap.Builder<String,com.apple.foundationdb.record.query.plan.cascades.explain.Attribute> attributeMapBuilder)

Specified by:

getPlannerGraphDetails in interface IndexScanParameters

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toLuceneScanParametersProto

@Nonnull
public com.apple.foundationdb.record.planprotos.PLuceneScanParameters toLuceneScanParametersProto(@Nonnull
 PlanSerializationContext serializationContext)