Package com.apple.foundationdb.record.lucene

Class LuceneQueryClause

java.lang.Object

com.apple.foundationdb.record.lucene.LuceneQueryClause

All Implemented Interfaces:

PlanHashable

Direct Known Subclasses:

LuceneAutoCompleteQueryClause, LuceneBooleanQuery, LuceneQueryFieldComparisonClause, LuceneQueryMultiFieldSearchClause, LuceneQuerySearchClause

@API(UNSTABLE)
public abstract class LuceneQueryClause
extends Object
implements PlanHashable

Binder for a single query clause.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LuceneQueryClause.BoundQuery	Helper class to capture a bound query, i.e.

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

PlanHashable.PlanHashKind, PlanHashable.PlanHashMode

Field Summary

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

CURRENT_FOR_CONTINUATION, CURRENT_LEGACY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LuceneQueryClause(LuceneQueryType queryType)

Method Summary

Modifier and Type	Method	Description
abstract LuceneQueryClause.BoundQuery	bind(FDBRecordStoreBase<?> store, Index index, EvaluationContext context)
protected static Map<String,Set<String>>	combineHighlightingTermsMaps(Map<String,Set<String>> existingMap, Map<String,Set<String>> newMap)
protected static Map<String,Set<String>>	getHighlightingTermsMap(org.apache.lucene.search.Query query)	Parse the Lucene query to get all the mapping from field to terms.
abstract 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)
LuceneQueryType	getQueryType()
protected LuceneQueryClause.BoundQuery	toBoundQuery(org.apache.lucene.search.Query luceneQuery)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

planHash, planHash, planHash

Constructor Details

LuceneQueryClause

protected LuceneQueryClause(@Nonnull
 LuceneQueryType queryType)

Method Details

getQueryType

@Nonnull
public LuceneQueryType getQueryType()

bind

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

getPlannerGraphDetails

public abstract 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)

toBoundQuery

@Nonnull
protected LuceneQueryClause.BoundQuery toBoundQuery(@Nonnull
 org.apache.lucene.search.Query luceneQuery)

getHighlightingTermsMap

@Nonnull
protected static Map<String,Set<String>> getHighlightingTermsMap(@Nonnull
 org.apache.lucene.search.Query query)

Parse the Lucene query to get all the mapping from field to terms.

Parameters:

query - lucene query to extract all terms from

Returns:

a new highlighting terms map

combineHighlightingTermsMaps

@CanIgnoreReturnValue
@Nonnull
protected static Map<String,Set<String>> combineHighlightingTermsMaps(@Nonnull
 Map<String,Set<String>> existingMap,
 @Nonnull
 Map<String,Set<String>> newMap)