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

Class LiteralKeyExpression<T>

java.lang.Object

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

com.apple.foundationdb.record.metadata.expressions.LiteralKeyExpression<T>

Type Parameters:

T - the type of the literal value

All Implemented Interfaces:

AtomKeyExpression, KeyExpression, KeyExpressionWithoutChildren, KeyExpressionWithValue, PlanHashable, QueryHashable

@API(MAINTAINED)
public class LiteralKeyExpression<T>
extends BaseKeyExpression
implements AtomKeyExpression, KeyExpressionWithValue, KeyExpressionWithoutChildren

Expression to allow a static value to be utilized in a key expression. This primary use case for this is for passing static arguments to functions (see FunctionKeyExpression for details).

Nested Class Summary

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

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

QueryHashable.QueryHashKind

Constructor Summary

Constructors

Constructor	Description
LiteralKeyExpression(T value)

Method Summary

Modifier and Type	Method	Description
boolean	createsDuplicates()	This states whether the given expression type is capable of evaluating more to more than one value when applied to a single record.
boolean	equals(Object o)
boolean	equalsAtomic(AtomKeyExpression other)
<M extends Message> List<Key.Evaluated>	evaluateMessage(FDBRecord<M> record, Message message)	Evaluate this expression against a record or a Protobuf message.
static LiteralKeyExpression<?>	fromProto(RecordMetaDataProto.Value proto)
static Object	fromProtoValue(RecordMetaDataProto.Value proto)
int	getColumnSize()	Returns the number of items in each KeyValue that will be returned.
T	getValue()
int	hashCode()
int	planHash(PlanHashable.PlanHashKind hashKind)	Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.
int	queryHash(QueryHashable.QueryHashKind hashKind)	Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.
RecordMetaDataProto.KeyExpression	toKeyExpression()
RecordMetaDataProto.Value	toProto()
static RecordMetaDataProto.Value	toProtoValue(Object value)
String	toString()
Value	toValue(CorrelationIdentifier baseAlias, List<String> fieldNamePrefix)
List<Descriptors.FieldDescriptor>	validate(Descriptors.Descriptor descriptor)	Validate this expression against a given record type descriptor.

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, evaluateSingleton, getSubKey, hasLosslessNormalization, hasProperInterfaces, hasRecordTypeKey, isPrefixKey, normalizeKeyForPositions, versionColumns

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

expand

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

planHash

Constructor Detail

LiteralKeyExpression

public LiteralKeyExpression(@Nullable
                            T value)

Method Detail

getValue

@Nullable
public T getValue()

evaluateMessage

@Nonnull
public <M extends Message> List<Key.Evaluated> evaluateMessage(@Nullable
                                                               FDBRecord<M> record,
                                                               @Nullable
                                                               Message message)

Description copied from interface: KeyExpression

Evaluate this expression against a record or a Protobuf message. The message might be the Protobuf form of a record or a piece of that record. If the key expression is meaningful against a subrecord, it should evaluate against the message. Otherwise, it should evaluate against the record and ignore what part of that record is being considered. There should not be any reason to call this method outside of the implementation of another evaluateMessage. Under ordinary circumstances, if record is null, then message will be null. Otherwise, message will be record.getRecord() or some submessage of that, possibly null if the corresponding field is missing.

Specified by:

evaluateMessage in interface KeyExpression

Type Parameters:

M - the type of record

Parameters:

record - the record

message - the Protobuf message to evaluate against

Returns:

the evaluated keys for the given record

See Also:

KeyExpression.evaluate(com.apple.foundationdb.record.provider.foundationdb.FDBRecord<M>)

createsDuplicates

public boolean createsDuplicates()

Description copied from interface: KeyExpression

This states whether the given expression type is capable of evaluating more to more than one value when applied to a single record. In practice, this can happen if this expression is evaluated on a repeated field with FanType.FanOut set (either directly or indirectly).

Specified by:

createsDuplicates in interface KeyExpression

Returns:

true if this expression can evaluate to multiple values and false otherwise

validate

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

Description copied from interface: KeyExpression

Validate this expression against a given record type descriptor.

Specified by:

validate in interface KeyExpression

Parameters:

descriptor - the descriptor for the record type or submessage

Returns:

a list of fields that this key applies to

getColumnSize

public int getColumnSize()

Description copied from interface: KeyExpression

Returns the number of items in each KeyValue that will be returned. For key expressions that support KeyExpression.FanType.Concatenate, this will the count of non-nested lists, i.e. this will be value of evaluate(r).get(i).toList().size() for any i or r.

Specified by:

getColumnSize in interface KeyExpression

Returns:

the number of elements that will be produced for every key

toProto

@Nonnull
public RecordMetaDataProto.Value toProto()
                                  throws KeyExpression.SerializationException

Specified by:

toProto in interface KeyExpression

Throws:

KeyExpression.SerializationException

toValue

@Nonnull
public Value toValue(@Nonnull
                     CorrelationIdentifier baseAlias,
                     @Nonnull
                     List<String> fieldNamePrefix)

Specified by:

toValue in interface KeyExpressionWithValue

toKeyExpression

@Nonnull
public RecordMetaDataProto.KeyExpression toKeyExpression()

Specified by:

toKeyExpression in interface KeyExpression

fromProto

@Nonnull
public static LiteralKeyExpression<?> fromProto(RecordMetaDataProto.Value proto)

fromProtoValue

@Nullable
public static Object fromProtoValue(RecordMetaDataProto.Value proto)

toProtoValue

@Nonnull
public static RecordMetaDataProto.Value toProtoValue(@Nullable
                                                     Object value)

equalsAtomic

public boolean equalsAtomic(AtomKeyExpression other)

Specified by:

equalsAtomic in interface AtomKeyExpression

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

planHash

public int planHash(@Nonnull
                    PlanHashable.PlanHashKind hashKind)

Description copied from interface: PlanHashable

Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.

Specified by:

planHash in interface PlanHashable

Parameters:

hashKind - the "kind" of hash to calculate. Each kind of hash has a particular logic with regards to included and excluded items.

Returns:

a stable hash code

queryHash

public int queryHash(@Nonnull
                     QueryHashable.QueryHashKind hashKind)

Description copied from interface: QueryHashable

Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.

Specified by:

queryHash in interface QueryHashable

Parameters:

hashKind - the "kind" of hash to calculate. Each kind of hash has a particular logic with regards to included and excluded items.

Returns:

a stable hash code

toString

public String toString()

Overrides:

toString in class Object