Package com.apple.foundationdb.record.lucene

Class LuceneFunctionKeyExpression

java.lang.Object

com.apple.foundationdb.record.metadata.expressions.BaseKeyExpression

com.apple.foundationdb.record.metadata.expressions.FunctionKeyExpression

com.apple.foundationdb.record.lucene.LuceneFunctionKeyExpression

All Implemented Interfaces:

AtomKeyExpression, KeyExpression, KeyExpressionWithChild, KeyExpressionWithChildren, PlanHashable

Direct Known Subclasses:

LuceneFunctionKeyExpression.LuceneFieldConfig, LuceneFunctionKeyExpression.LuceneFieldName, LuceneFunctionKeyExpression.LuceneSortBy, LuceneFunctionKeyExpression.LuceneSorted, LuceneFunctionKeyExpression.LuceneStored, LuceneFunctionKeyExpression.LuceneText

@API(EXPERIMENTAL)
public abstract class LuceneFunctionKeyExpression
extends FunctionKeyExpression

Lucene function key expressions. These are just markers, interpreted by LuceneDocumentFromRecord.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LuceneFunctionKeyExpression.LuceneFieldConfig	The key function for Lucene field configuration.
static class	LuceneFunctionKeyExpression.LuceneFieldName	The lucene_field_name key function.
static class	LuceneFunctionKeyExpression.LuceneSortBy	Key function representing one of the Lucene built-in sorting techniques.
static class	LuceneFunctionKeyExpression.LuceneSorted	The lucene_sorted key function.
static class	LuceneFunctionKeyExpression.LuceneStored	The lucene_stored key function.
static class	LuceneFunctionKeyExpression.LuceneText	The lucent_text key function.

Nested classes/interfaces inherited from class com.apple.foundationdb.record.metadata.expressions.FunctionKeyExpression

FunctionKeyExpression.BiFunctionBuilder, FunctionKeyExpression.Builder, FunctionKeyExpression.Factory, FunctionKeyExpression.Registry

Nested classes/interfaces inherited from class com.apple.foundationdb.record.metadata.expressions.BaseKeyExpression

BaseKeyExpression.IllegalSubKeyException, BaseKeyExpression.UnsplittableKeyExpressionException

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.metadata.expressions.KeyExpression

KeyExpression.DeserializationException, KeyExpression.FanType, KeyExpression.InvalidExpressionException, KeyExpression.InvalidResultException, KeyExpression.NoSuchArgumentException, KeyExpression.SerializationException

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.metadata.expressions.FunctionKeyExpression

arguments, name

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

CURRENT_FOR_CONTINUATION, CURRENT_LEGACY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LuceneFunctionKeyExpression(String name, KeyExpression arguments)

Method Summary

Modifier and Type	Method	Description
boolean	createsDuplicates()
<M extends Message> List<Key.Evaluated>	evaluateFunction(FDBRecord<M> rec, Message message, Key.Evaluated argvals)
int	planHash(PlanHashable.PlanHashMode mode)

Methods inherited from class com.apple.foundationdb.record.metadata.expressions.FunctionKeyExpression

basePlanHash, create, equals, equalsAtomic, evaluateMessage, expand, fromProto, getArguments, getChild, getMaxArguments, getMinArguments, getName, groupBy, hashCode, resolveAndEncapsulateFunction, toKeyExpression, toProto, toString, toValue, validate

Methods inherited from class com.apple.foundationdb.record.metadata.expressions.BaseKeyExpression

getSubKey, getSubKeyImpl, isPrefixKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.apple.foundationdb.record.metadata.expressions.KeyExpression

evaluate, evaluateMessageSingleton, evaluateSingleton, getColumnSize, getSubKey, hasLosslessNormalization, hasProperInterfaces, hasRecordTypeKey, isPrefixKey, needsCopyingToPartialRecord, normalizeKeyForPositions, versionColumns

Methods inherited from interface com.apple.foundationdb.record.metadata.expressions.KeyExpressionWithChild

getChildren

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

planHash, planHash

Constructor Details

LuceneFunctionKeyExpression

protected LuceneFunctionKeyExpression(@Nonnull
 String name,
 @Nonnull
 KeyExpression arguments)

Method Details

evaluateFunction

@Nonnull
public <M extends Message> List<Key.Evaluated> evaluateFunction(@Nullable
 FDBRecord<M> rec,
 @Nullable
 Message message,
 @Nonnull
 Key.Evaluated argvals)

Specified by:

evaluateFunction in class FunctionKeyExpression

createsDuplicates

public boolean createsDuplicates()

planHash

public int planHash(@Nonnull
 PlanHashable.PlanHashMode mode)