Package com.apple.foundationdb.record.lucene

Class LuceneScanQueryParameters

java.lang.Object

com.apple.foundationdb.record.lucene.LuceneScanParameters

com.apple.foundationdb.record.lucene.LuceneScanQueryParameters

All Implemented Interfaces:

PlanHashable, PlanSerializable, IndexScanParameters, Correlated<IndexScanParameters>

@API(UNSTABLE)
public class LuceneScanQueryParameters
extends LuceneScanParameters
implements PlanSerializable

Scan parameters for making a LuceneScanQuery.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LuceneScanQueryParameters.Deserializer	Deserializer.
static class	LuceneScanQueryParameters.LuceneQueryHighlightParameters	The parameters for highlighting matching terms of a Lucene search.

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 inherited from class com.apple.foundationdb.record.lucene.LuceneScanParameters

groupComparisons, scanType

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

CURRENT_FOR_CONTINUATION, CURRENT_LEGACY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LuceneScanQueryParameters(PlanSerializationContext serializationContext, com.apple.foundationdb.record.planprotos.PLuceneScanQueryParameters luceneScanQueryParametersProto)
	LuceneScanQueryParameters(ScanComparisons groupComparisons, LuceneQueryClause query)
	LuceneScanQueryParameters(ScanComparisons groupComparisons, LuceneQueryClause query, org.apache.lucene.search.Sort sort, List<String> storedFields, List<LuceneIndexExpressions.DocumentFieldType> storedFieldTypes, LuceneScanQueryParameters.LuceneQueryHighlightParameters luceneQueryHighlightParameters)

Method Summary

Modifier and Type	Method	Description
LuceneScanQuery	bind(FDBRecordStoreBase<?> store, Index index, EvaluationContext context)
boolean	equals(Object o)
com.apple.foundationdb.record.query.plan.explain.ExplainTokensWithPrecedence	explain()
static LuceneScanQueryParameters	fromProto(PlanSerializationContext serializationContext, com.apple.foundationdb.record.planprotos.PLuceneScanQueryParameters luceneScanQueryParametersProto)
Set<CorrelationIdentifier>	getCorrelatedTo()
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)
LuceneQueryClause	getQuery()
org.apache.lucene.search.Sort	getSort()
List<String>	getStoredFields()
List<LuceneIndexExpressions.DocumentFieldType>	getStoredFieldTypes()
int	hashCode()
int	planHash(PlanHashable.PlanHashMode mode)
IndexScanParameters	rebase(AliasMap translationMap)
boolean	semanticEquals(Object other, AliasMap aliasMap)
int	semanticHashCode()
com.apple.foundationdb.record.planprotos.PIndexScanParameters	toIndexScanParametersProto(PlanSerializationContext serializationContext)
com.apple.foundationdb.record.planprotos.PLuceneScanQueryParameters	toProto(PlanSerializationContext serializationContext)
String	toString()
IndexScanParameters	translateCorrelations(com.apple.foundationdb.record.query.plan.cascades.values.translation.TranslationMap translationMap, boolean shouldSimplifyValues)

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

getGroupComparisons, getGroupKey, getGroupKeyWithoutContext, getGroupScanDetails, getScanType, indexTextFields, isUnique, toLuceneScanParametersProto

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.PlanHashable

planHash, planHash

Constructor Details

LuceneScanQueryParameters

protected LuceneScanQueryParameters(@Nonnull
 PlanSerializationContext serializationContext,
 @Nonnull
 com.apple.foundationdb.record.planprotos.PLuceneScanQueryParameters luceneScanQueryParametersProto)

LuceneScanQueryParameters

public LuceneScanQueryParameters(@Nonnull
 ScanComparisons groupComparisons,
 @Nonnull
 LuceneQueryClause query)

LuceneScanQueryParameters

public LuceneScanQueryParameters(@Nonnull
 ScanComparisons groupComparisons,
 @Nonnull
 LuceneQueryClause query,
 @Nullable
 org.apache.lucene.search.Sort sort,
 @Nullable
 List<String> storedFields,
 @Nullable
 List<LuceneIndexExpressions.DocumentFieldType> storedFieldTypes,
 @Nullable
 LuceneScanQueryParameters.LuceneQueryHighlightParameters luceneQueryHighlightParameters)

Method Details

getQuery

@Nonnull
public LuceneQueryClause getQuery()

getSort

@Nullable
public org.apache.lucene.search.Sort getSort()

getStoredFields

@Nullable
public List<String> getStoredFields()

getStoredFieldTypes

@Nullable
public List<LuceneIndexExpressions.DocumentFieldType> getStoredFieldTypes()

planHash

public int planHash(@Nonnull
 PlanHashable.PlanHashMode mode)

Specified by:

planHash in interface PlanHashable

bind

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

Specified by:

bind in interface IndexScanParameters

Specified by:

bind in class LuceneScanParameters

explain

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

Specified by:

explain in interface IndexScanParameters

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

Overrides:

getPlannerGraphDetails in class LuceneScanParameters

translateCorrelations

@Nonnull
public IndexScanParameters translateCorrelations(@Nonnull
 com.apple.foundationdb.record.query.plan.cascades.values.translation.TranslationMap translationMap,
 boolean shouldSimplifyValues)

Specified by:

translateCorrelations in interface IndexScanParameters

getCorrelatedTo

@Nonnull
public Set<CorrelationIdentifier> getCorrelatedTo()

Specified by:

getCorrelatedTo in interface Correlated<IndexScanParameters>

rebase

@Nonnull
public IndexScanParameters rebase(@Nonnull
 AliasMap translationMap)

Specified by:

rebase in interface Correlated<IndexScanParameters>

semanticEquals

public boolean semanticEquals(@Nullable
 Object other,
 @Nonnull
 AliasMap aliasMap)

Specified by:

semanticEquals in interface Correlated<IndexScanParameters>

semanticHashCode

public int semanticHashCode()

Specified by:

semanticHashCode in interface Correlated<IndexScanParameters>

toString

public String toString()

Overrides:

toString in class LuceneScanParameters

equals

public boolean equals(Object o)

Overrides:

equals in class LuceneScanParameters

hashCode

public int hashCode()

Overrides:

hashCode in class LuceneScanParameters

toProto

@Nonnull
public com.apple.foundationdb.record.planprotos.PLuceneScanQueryParameters toProto(@Nonnull
 PlanSerializationContext serializationContext)

Specified by:

toProto in interface PlanSerializable

toIndexScanParametersProto

@Nonnull
public com.apple.foundationdb.record.planprotos.PIndexScanParameters toIndexScanParametersProto(@Nonnull
 PlanSerializationContext serializationContext)

Specified by:

toIndexScanParametersProto in interface IndexScanParameters

fromProto

@Nonnull
public static LuceneScanQueryParameters fromProto(@Nonnull
 PlanSerializationContext serializationContext,
 @Nonnull
 com.apple.foundationdb.record.planprotos.PLuceneScanQueryParameters luceneScanQueryParametersProto)