Package com.apple.foundationdb.record.lucene

Class LuceneFunctionKeyExpression.LuceneSortBy

java.lang.Object

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

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

com.apple.foundationdb.record.lucene.LuceneFunctionKeyExpression

com.apple.foundationdb.record.lucene.LuceneFunctionKeyExpression.LuceneSortBy

All Implemented Interfaces:

AtomKeyExpression, KeyExpression, KeyExpressionWithChild, KeyExpressionWithChildren, PlanHashable

Enclosing class:

LuceneFunctionKeyExpression

public static class LuceneFunctionKeyExpression.LuceneSortBy
extends LuceneFunctionKeyExpression

Key function representing one of the Lucene built-in sorting techniques.

Nested Class Summary

Nested classes/interfaces inherited from class com.apple.foundationdb.record.lucene.LuceneFunctionKeyExpression

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

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

Constructor	Description
LuceneSortBy(String name, KeyExpression arguments)

Method Summary

Modifier and Type	Method	Description
<M extends Message> List<Key.Evaluated>	evaluateFunction(FDBRecord<M> rec, Message message, Key.Evaluated argvals)
int	getColumnSize()
int	getMaxArguments()
int	getMinArguments()
boolean	isRelevance()
Value	toValue(List<? extends Value> argumentValues)

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

createsDuplicates, planHash

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

basePlanHash, create, equals, equalsAtomic, evaluateMessage, expand, fromProto, getArguments, getChild, getName, groupBy, hashCode, resolveAndEncapsulateFunction, toKeyExpression, toProto, toString, 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, 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

LuceneSortBy

public LuceneSortBy(@Nonnull
 String name,
 @Nonnull
 KeyExpression arguments)

Method Details

getMinArguments

public int getMinArguments()

Specified by:

getMinArguments in class FunctionKeyExpression

getMaxArguments

public int getMaxArguments()

Specified by:

getMaxArguments in class FunctionKeyExpression

getColumnSize

public int getColumnSize()

evaluateFunction

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

Overrides:

evaluateFunction in class LuceneFunctionKeyExpression

isRelevance

public boolean isRelevance()

toValue

@Nonnull
public Value toValue(@Nonnull
 List<? extends Value> argumentValues)

Specified by:

toValue in class FunctionKeyExpression