com.apple.foundationdb.record.query.expressions

Interface Comparisons.Comparison

All Superinterfaces:

PlanHashable

All Known Implementing Classes:

Comparisons.ListComparison, Comparisons.NullComparison, Comparisons.ParameterComparison, Comparisons.SimpleComparison, Comparisons.TextComparison, Comparisons.TextContainsAllPrefixesComparison, Comparisons.TextWithMaxDistanceComparison

Enclosing class:

Comparisons

public static interface Comparisons.Comparison
extends PlanHashable

A comparison between a value associated with someplace in the record (such as a field) and a value associated with the plan (such as a constant or a bound parameter).

Method Summary

Modifier and Type	Method and Description
Boolean	eval(FDBRecordStoreBase<?> store, EvaluationContext context, Object value) Evaluate this comparison for the value taken from the target record.
default Object	getComparand() Get the comparison value without any bindings.
Object	getComparand(FDBRecordStoreBase<?> store, EvaluationContext context) Get the comparison value from the evaluation context.
Comparisons.Type	getType() Get the comparison type.
String	typelessString() Get the printed representation of the comparison less the comparison operator itself.
void	validate(Descriptors.FieldDescriptor descriptor, boolean fannedOut) Validate that this comparison is compatible with a given record field.

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

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

Method Detail

eval

@Nullable
Boolean eval(@Nonnull
                       FDBRecordStoreBase<?> store,
                       @Nonnull
                       EvaluationContext context,
                       @Nullable
                       Object value)

Evaluate this comparison for the value taken from the target record.

Parameters:

store - the record store for the query

context - the evaluation context for getting the other comparison value

value - the value taken from the record

Returns:

the tri-valued logic result of the comparison

validate

void validate(@Nonnull
              Descriptors.FieldDescriptor descriptor,
              boolean fannedOut)

Validate that this comparison is compatible with a given record field.

Parameters:

descriptor - the Protobuf descriptor for the proposed comparison field

fannedOut - whether a repeated field fans out into multiple comparisons or is treated as a single list value

getType

@Nonnull
Comparisons.Type getType()

Get the comparison type.

Returns:

the comparison type

getComparand

@Nullable
default Object getComparand()

Get the comparison value without any bindings.

Returns:

the value to be compared

getComparand

@Nullable
Object getComparand(@Nullable
                              FDBRecordStoreBase<?> store,
                              @Nullable
                              EvaluationContext context)

Get the comparison value from the evaluation context.

Parameters:

store - the record store for the query

context - the context for query evaluation

Returns:

the value to be compared

typelessString

@Nonnull
String typelessString()

Get the printed representation of the comparison less the comparison operator itself.

Returns:

the typeless string