Package com.apple.foundationdb.record.lucene

Class LuceneQueryComponent

java.lang.Object

com.apple.foundationdb.record.lucene.LuceneQueryComponent

All Implemented Interfaces:

PlanHashable, ComponentWithNoChildren, QueryComponent, QueryHashable

@API(EXPERIMENTAL)
public class LuceneQueryComponent
extends Object
implements QueryComponent, ComponentWithNoChildren

A Query Component for Lucene that wraps the query supplied.

Nested Class Summary

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

QueryHashable.QueryHashKind

Field Summary

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

CURRENT_FOR_CONTINUATION, CURRENT_LEGACY

Constructor Summary

Constructors

Constructor	Description
LuceneQueryComponent(LuceneQueryType type, String query, boolean queryIsParameter, List<String> fields, boolean multiFieldSearch)
LuceneQueryComponent(LuceneQueryType type, String query, boolean queryIsParameter, List<String> fields, boolean multiFieldSearch, LuceneScanQueryParameters.LuceneQueryHighlightParameters luceneQueryHighlightParameters, Set<String> explicitFieldNames)
LuceneQueryComponent(String query, List<String> fields)
LuceneQueryComponent(String query, List<String> fields, boolean multiField)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
<M extends Message> Boolean	evalMessage(FDBRecordStoreBase<M> store, EvaluationContext context, FDBRecord<M> rec, Message message)
GraphExpansion	expand(Quantifier.ForEach baseQuantifier, Supplier<Quantifier.ForEach> outerQuantifierSupplier, List<String> fieldNamePrefix)
Set<String>	getExplicitFieldNames()
List<String>	getFields()
LuceneScanQueryParameters.LuceneQueryHighlightParameters	getLuceneQueryHighlightParameters()
String	getQuery()
LuceneQueryType	getType()
int	hashCode()
boolean	isMultiFieldSearch()
boolean	isQueryIsParameter()
int	planHash(PlanHashable.PlanHashMode mode)
int	queryHash(QueryHashable.QueryHashKind hashKind)
String	toString()
void	validate(Descriptors.Descriptor descriptor)
LuceneQueryComponent	withNewFields(List<String> fields, Set<String> explicitFieldNames)	Creates an instance of this LuceneQueryComponent with a new list of fields.

Methods inherited from class java.lang.Object

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

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

planHash, planHash

Methods inherited from interface com.apple.foundationdb.record.query.expressions.QueryComponent

eval, evalAsync, evalMessageAsync, expand, isAsync, withParameterRelationshipMap

Constructor Details

LuceneQueryComponent

public LuceneQueryComponent(String query,
 List<String> fields)

LuceneQueryComponent

public LuceneQueryComponent(String query,
 List<String> fields,
 boolean multiField)

LuceneQueryComponent

public LuceneQueryComponent(LuceneQueryType type,
 String query,
 boolean queryIsParameter,
 List<String> fields,
 boolean multiFieldSearch)

LuceneQueryComponent

public LuceneQueryComponent(LuceneQueryType type,
 String query,
 boolean queryIsParameter,
 List<String> fields,
 boolean multiFieldSearch,
 @Nullable
 LuceneScanQueryParameters.LuceneQueryHighlightParameters luceneQueryHighlightParameters,
 @Nullable
 Set<String> explicitFieldNames)

Method Details

evalMessage

@Nonnull
public <M extends Message> Boolean evalMessage(@Nonnull
 FDBRecordStoreBase<M> store,
 @Nonnull
 EvaluationContext context,
 @Nullable
 FDBRecord<M> rec,
 @Nullable
 Message message)

Specified by:

evalMessage in interface QueryComponent

validate

public void validate(@Nonnull
 Descriptors.Descriptor descriptor)

Specified by:

validate in interface QueryComponent

expand

@Nonnull
public GraphExpansion expand(@Nonnull
 Quantifier.ForEach baseQuantifier,
 @Nonnull
 Supplier<Quantifier.ForEach> outerQuantifierSupplier,
 @Nonnull
 List<String> fieldNamePrefix)

Specified by:

expand in interface QueryComponent

getType

@Nonnull
public LuceneQueryType getType()

getQuery

@Nonnull
public String getQuery()

isQueryIsParameter

public boolean isQueryIsParameter()

getFields

@Nonnull
public List<String> getFields()

isMultiFieldSearch

public boolean isMultiFieldSearch()

getLuceneQueryHighlightParameters

@Nullable
public LuceneScanQueryParameters.LuceneQueryHighlightParameters getLuceneQueryHighlightParameters()

getExplicitFieldNames

@Nullable
public Set<String> getExplicitFieldNames()

withNewFields

@Nonnull
public LuceneQueryComponent withNewFields(@Nonnull
 List<String> fields,
 @Nullable
 Set<String> explicitFieldNames)

Creates an instance of this LuceneQueryComponent with a new list of fields.

Parameters:

fields - The new list of fields.

explicitFieldNames - the new list of explicit field names

Returns:

a new instance of LuceneQueryComponent.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

planHash

public int planHash(@Nonnull
 PlanHashable.PlanHashMode mode)

Specified by:

planHash in interface PlanHashable

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

queryHash

public int queryHash(@Nonnull
 QueryHashable.QueryHashKind hashKind)

Specified by:

queryHash in interface QueryHashable