Package com.apple.foundationdb.record.metadata.expressions

Interface QueryableKeyExpression

All Superinterfaces:

KeyExpression, KeyExpressionWithValue, PlanHashable, QueryHashable

All Known Implementing Classes:

CollateFunctionKeyExpression, CollateFunctionKeyExpressionFactoryJRE.CollateFunctionKeyExpressionJRE

@API(EXPERIMENTAL)
public interface QueryableKeyExpression
extends KeyExpression, KeyExpressionWithValue

A KeyExpression that can be used with a QueryKeyExpressionWithComparison. The index entries generated by the key expression are matched to the application of the key expression to the query record, with an optional conversion of any comparison operand.

Nested Class Summary

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

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

QueryHashable.QueryHashKind

Method Summary

Modifier and Type	Method	Description
default <M extends Message> Object	evalForQuery(FDBRecordStoreBase<M> store, EvaluationContext context, FDBRecord<M> record, Message message)
default boolean	evalForQueryAsTuple()
default Function<Object,Object>	getComparandConversionFunction()	Get a function to be applied to the comparison operand before comparing it with the application of the key expression to the record.
String	getName()

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

createsDuplicates, evaluate, evaluateMessage, evaluateSingleton, getColumnSize, getSubKey, hasLosslessNormalization, hasProperInterfaces, hasRecordTypeKey, isPrefixKey, normalizeKeyForPositions, toKeyExpression, toProto, validate, versionColumns

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

expand, toValue

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

planHash, planHash

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

queryHash

Method Detail

getName

@Nonnull
String getName()

evalForQuery

@Nullable
default <M extends Message> Object evalForQuery(@Nonnull
                                                FDBRecordStoreBase<M> store,
                                                @Nonnull
                                                EvaluationContext context,
                                                @Nullable
                                                FDBRecord<M> record,
                                                @Nullable
                                                Message message)

evalForQueryAsTuple

default boolean evalForQueryAsTuple()

getComparandConversionFunction

@Nullable
default Function<Object,Object> getComparandConversionFunction()

Get a function to be applied to the comparison operand before comparing it with the application of the key expression to the record.

Returns:

a conversion function or null for no conversion