Package com.apple.foundationdb.record.lucene

Class LuceneFunctionKeyExpression.LuceneStored

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

All Implemented Interfaces:

AtomKeyExpression, KeyExpression, KeyExpressionWithChild, KeyExpressionWithChildren, PlanHashable

Enclosing class:

LuceneFunctionKeyExpression

public static class LuceneFunctionKeyExpression.LuceneStored
extends LuceneFunctionKeyExpression

The lucene_stored key function. The field argument to this function is additionally stored in the Lucene documents and not just indexed.

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
LuceneStored(String name, KeyExpression arguments)

Method Summary

Modifier and Type	Method	Description
int	getColumnSize()
int	getMaxArguments()
int	getMinArguments()
KeyExpression	getStoredExpression()	Get the expression that is marked as stored.
Value	toValue(List<? extends Value> argumentValues)

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

createsDuplicates, evaluateFunction, 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

LuceneStored

public LuceneStored(@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()

getStoredExpression

@Nonnull
public KeyExpression getStoredExpression()

Get the expression that is marked as stored.

Returns:

the stored expression

toValue

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

Specified by:

toValue in class FunctionKeyExpression