com.apple.foundationdb.record.metadata.expressions

Class VersionKeyExpression

java.lang.Object

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

com.apple.foundationdb.record.metadata.expressions.VersionKeyExpression

All Implemented Interfaces:

AtomKeyExpression, KeyExpression, KeyExpressionWithoutChildren, PlanHashable

@API(value=MAINTAINED)
public class VersionKeyExpression
extends BaseKeyExpression
implements AtomKeyExpression, KeyExpressionWithoutChildren

A key expression that indicates that a serialized FDBRecordVersion should be contained within the key. This should then be used within version indexes to include data sorted by version.

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

Field Summary

Fields

Modifier and Type	Field and Description
static VersionKeyExpression	VERSION
static RecordMetaDataProto.KeyExpression	VERSION_PROTO

Method Summary

Modifier and Type	Method and 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.
int	getColumnSize() Returns the number of items in each KeyValue that will be returned.
GroupingKeyExpression	groupBy(KeyExpression groupByFirst, KeyExpression... groupByRest)
int	hashCode()
KeyExpression	normalizeForPlanner(Source source, List<String> fieldNamePrefix) Normalize this key expression into another key expression that pushes all nesting and fan-out to ElementKeyExpressions at the leaves.
int	planHash() Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.
RecordMetaDataProto.KeyExpression	toKeyExpression()
RecordMetaDataProto.Version	toProto()
String	toString()
GroupingKeyExpression	ungrouped() A Version expression with no grouping keys (mostly for evaluating record functions).
List<Descriptors.FieldDescriptor>	validate(Descriptors.Descriptor descriptor) Validate this expression against a given record type descriptor.
int	versionColumns() Returns the number of version columns produced by this key expression.

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, flattenForPlanner, fromProto, getSubKey, hasProperInterfaces, hasRecordTypeKey, isPrefixKey, normalizeKeyForPositions

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

combineHashes, iterablePlanHash, objectPlanHash, objectsPlanHash, planHash, planHash, planHashUnordered, stringHashUnordered

Field Detail

VERSION

public static final VersionKeyExpression VERSION

VERSION_PROTO

public static final RecordMetaDataProto.KeyExpression VERSION_PROTO

Method Detail

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

ungrouped

@Nonnull
public GroupingKeyExpression ungrouped()

A Version expression with no grouping keys (mostly for evaluating record functions).

Returns:

a GroupingKeyExpression with no grouping keys

groupBy

@Nonnull
public GroupingKeyExpression groupBy(@Nonnull
                                              KeyExpression groupByFirst,
                                              @Nonnull
                                              KeyExpression... groupByRest)

toProto

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

Specified by:

toProto in interface KeyExpression

Throws:

KeyExpression.SerializationException

toKeyExpression

@Nonnull
public RecordMetaDataProto.KeyExpression toKeyExpression()

Specified by:

toKeyExpression in interface KeyExpression

normalizeForPlanner

@Nonnull
public KeyExpression normalizeForPlanner(@Nonnull
                                                  Source source,
                                                  @Nonnull
                                                  List<String> fieldNamePrefix)

Description copied from interface: KeyExpression

Normalize this key expression into another key expression that pushes all nesting and fan-out to ElementKeyExpressions at the leaves.

By default, a key expression is a complicated nested structure that can be difficult to work with. This method pushes much of the complexity, including nested structures and fan-out of repeated fields, to special key expressions that track these relationship using the Source abstraction. This pre-processing makes planning nested and repeated structures much simpler.

This normalization process requires tracking some state since the name of a nested field is available only at the relevant FieldKeyExpression, but that information is necessary to construct the ElementKeyExpression at the leaves of the sub-tree rooted at the NestingKeyExpression. This extra information is tracked in the fieldNamePrefix.

Specified by:

normalizeForPlanner in interface KeyExpression

Parameters:

source - the source representing the input stream of the key expression

fieldNamePrefix - the (non-repeated) field names on the path from the most recent source to this part of the key expression

Returns:

a new key expression that has only ElementKeyExpressions at its leaves

versionColumns

public int versionColumns()

Description copied from interface: KeyExpression

Returns the number of version columns produced by this key expression.

Specified by:

versionColumns in interface KeyExpression

Returns:

the number of version columns

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

planHash

public int planHash()

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

Returns:

a stable hash code

equalsAtomic

public boolean equalsAtomic(AtomKeyExpression other)

Specified by:

equalsAtomic in interface AtomKeyExpression

toString

public String toString()

Overrides:

toString in class Object