Package com.apple.foundationdb.record.query.expressions

Class QueryRecordFunction<T>

java.lang.Object

com.apple.foundationdb.record.query.expressions.QueryRecordFunction<T>

Type Parameters:

T - the result type of the function

All Implemented Interfaces:

PlanHashable

@API(MAINTAINED)
public class QueryRecordFunction<T>
extends Object
implements PlanHashable

Class that provides context for asserting about a specially calculated value.

Nested Class Summary

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

PlanHashable.PlanHashKind

Constructor Summary

Constructors

Constructor	Description
QueryRecordFunction(RecordFunction<T> function)
QueryRecordFunction(RecordFunction<T> function, QueryComponent additionalCondition)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
QueryComponent	equalsValue(Object comparand)	Checks if the calculated value has a value equal to the given comparand.
<M extends Message> CompletableFuture<T>	eval(FDBRecordStoreBase<M> store, EvaluationContext context, FDBStoredRecord<M> record)
QueryComponent	getAdditionalCondition()
RecordFunction<T>	getFunction()
QueryComponent	greaterThan(Object comparand)	Checks if the calculated value has a value greater than the given comparand.
QueryComponent	greaterThanOrEquals(Object comparand)	Checks if the calculated value has a value greater than or equal to the given comparand.
int	hashCode()
QueryComponent	in(String param)	Checks if the result for this function is in the list that is bound to the given param.
QueryComponent	in(List<?> comparand)	Checks if the result for this function is in the given list.
QueryComponent	lessThan(Object comparand)	Checks if the calculated value has a value less than the given comparand.
QueryComponent	lessThanOrEquals(Object comparand)	Checks if the calculated value has a value less than or equal to the given comparand.
QueryComponent	notEquals(Object comparand)	Checks if the calculated value has a value not equal to the given comparand.
int	planHash(PlanHashable.PlanHashKind hashKind)	Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.
String	toString()
QueryRecordFunction<T>	withAdditionalCondition(QueryComponent additionalCondition)
QueryComponent	withComparison(Comparisons.Comparison comparison)
QueryComponent	withComparison(Comparisons.Type type, Object comparand)
QueryRecordFunction<T>	withFunction(RecordFunction<T> function)
QueryComponent	withParameterComparison(Comparisons.Type type, String parameter)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

planHash

Constructor Detail

QueryRecordFunction

public QueryRecordFunction(@Nonnull
                           RecordFunction<T> function,
                           @Nullable
                           QueryComponent additionalCondition)

QueryRecordFunction

public QueryRecordFunction(@Nonnull
                           RecordFunction<T> function)

Method Detail

getFunction

public RecordFunction<T> getFunction()

withFunction

@Nonnull
public QueryRecordFunction<T> withFunction(@Nonnull
                                           RecordFunction<T> function)

getAdditionalCondition

@Nullable
public QueryComponent getAdditionalCondition()

withAdditionalCondition

@Nonnull
public QueryRecordFunction<T> withAdditionalCondition(@Nonnull
                                                      QueryComponent additionalCondition)

equalsValue

@Nonnull
public QueryComponent equalsValue(@Nonnull
                                  Object comparand)

Checks if the calculated value has a value equal to the given comparand.

Parameters:

comparand - the object to compare with the value in the calculated value

Returns:

a new component for doing the actual evaluation

notEquals

@Nonnull
public QueryComponent notEquals(@Nonnull
                                Object comparand)

Checks if the calculated value has a value not equal to the given comparand.

Parameters:

comparand - the object to compare with the value in the calculated value

Returns:

a new component for doing the actual evaluation

greaterThan

@Nonnull
public QueryComponent greaterThan(@Nonnull
                                  Object comparand)

Checks if the calculated value has a value greater than the given comparand.

Parameters:

comparand - the object to compare with the value in the calculated value

Returns:

a new component for doing the actual evaluation

greaterThanOrEquals

@Nonnull
public QueryComponent greaterThanOrEquals(@Nonnull
                                          Object comparand)

Checks if the calculated value has a value greater than or equal to the given comparand.

Parameters:

comparand - the object to compare with the value in the calculated value

Returns:

a new component for doing the actual evaluation

lessThan

@Nonnull
public QueryComponent lessThan(@Nonnull
                               Object comparand)

Checks if the calculated value has a value less than the given comparand.

Parameters:

comparand - the object to compare with the value in the calculated value

Returns:

a new component for doing the actual evaluation

lessThanOrEquals

@Nonnull
public QueryComponent lessThanOrEquals(@Nonnull
                                       Object comparand)

Checks if the calculated value has a value less than or equal to the given comparand.

Parameters:

comparand - the object to compare with the value in the calculated value

Returns:

a new component for doing the actual evaluation

in

@Nonnull
public QueryComponent in(@Nonnull
                         List<?> comparand)

Checks if the result for this function is in the given list.

Parameters:

comparand - a list of elements

Returns:

a new component for doing the actual evaluation

in

@Nonnull
public QueryComponent in(@Nonnull
                         String param)

Checks if the result for this function is in the list that is bound to the given param.

Parameters:

param - a param that will be bound to a list in the execution context

Returns:

a new component for doing the actual evaluation

withComparison

@Nonnull
public QueryComponent withComparison(@Nonnull
                                     Comparisons.Comparison comparison)

withComparison

@Nonnull
public QueryComponent withComparison(@Nonnull
                                     Comparisons.Type type,
                                     @Nonnull
                                     Object comparand)

withParameterComparison

@Nonnull
public QueryComponent withParameterComparison(@Nonnull
                                              Comparisons.Type type,
                                              String parameter)

eval

public <M extends Message> CompletableFuture<T> eval(@Nonnull
                                                     FDBRecordStoreBase<M> store,
                                                     @Nonnull
                                                     EvaluationContext context,
                                                     @Nullable
                                                     FDBStoredRecord<M> record)

equals

public boolean equals(Object obj)

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

toString

public String toString()

Overrides:

toString in class Object