Package com.apple.foundationdb.record.lucene

Class LuceneFunctionKeyExpression.LuceneFieldName

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

All Implemented Interfaces:

AtomKeyExpression, KeyExpression, KeyExpressionWithChild, KeyExpressionWithChildren, PlanHashable

Enclosing class:

LuceneFunctionKeyExpression

public static class LuceneFunctionKeyExpression.LuceneFieldName
extends LuceneFunctionKeyExpression

The lucene_field_name key function. Takes two arguments, a child key expression and a name and overrides the field naming of that child (and its descendants) to be the specified name. Common cases of the name expression would be a literal string or null or another field whose value determines the name at index time.

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

Method Summary

Modifier and Type	Method	Description
int	getColumnSize()
int	getMaxArguments()
int	getMinArguments()
KeyExpression	getNamedExpression()	Get the expression for which a name is given.
KeyExpression	getNameExpression()	Get the expression to determine the name.
Value	toValue(List<? extends Value> argumentValues)
List<Descriptors.FieldDescriptor>	validate(Descriptors.Descriptor descriptor)

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

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

LuceneFieldName

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

validate

public List<Descriptors.FieldDescriptor> validate(@Nonnull
 Descriptors.Descriptor descriptor)

Specified by:

validate in interface KeyExpression

Overrides:

validate in class FunctionKeyExpression

getNamedExpression

@Nonnull
public KeyExpression getNamedExpression()

Get the expression for which a name is given.

Returns:

the expression that is named

getNameExpression

@Nonnull
public KeyExpression getNameExpression()

Get the expression to determine the name.

Returns:

the expression to be evaluated to produce the name

toValue

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

Specified by:

toValue in class FunctionKeyExpression