Package com.apple.foundationdb.record.metadata

Class IndexAggregateFunction

java.lang.Object

com.apple.foundationdb.record.metadata.IndexAggregateFunction

All Implemented Interfaces:

PlanHashable

Direct Known Subclasses:

TimeWindowAggregateFunction

@API(MAINTAINED)
public class IndexAggregateFunction
extends Object
implements PlanHashable

An aggregate function implemented by scanning an appropriate index.

See Also:

FunctionNames, FDBRecordStore.evaluateAggregateFunction(java.util.List<java.lang.String>, com.apple.foundationdb.record.metadata.IndexAggregateFunction, com.apple.foundationdb.record.TupleRange, com.apple.foundationdb.record.IsolationLevel)

Nested Class Summary

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

PlanHashable.PlanHashKind

Constructor Summary

Constructors

Constructor	Description
IndexAggregateFunction(String name, KeyExpression operand, String index)

Method Summary

Modifier and Type	Method	Description
TupleRange	adjustRange(EvaluationContext context, TupleRange tupleRange)
IndexAggregateFunction	cloneWithIndex(String index)
IndexAggregateFunction	cloneWithOperand(KeyExpression operand)
boolean	equals(Object o)
String	getIndex()
String	getName()
KeyExpression	getOperand()
int	hashCode()
int	planHash(PlanHashable.PlanHashKind hashKind)	Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.
String	toString()
void	validate(Descriptors.Descriptor descriptor)

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

IndexAggregateFunction

public IndexAggregateFunction(@Nonnull
                              String name,
                              @Nonnull
                              KeyExpression operand,
                              @Nullable
                              String index)

Method Detail

getName

@Nonnull
public String getName()

getOperand

@Nonnull
public KeyExpression getOperand()

getIndex

@Nullable
public String getIndex()

cloneWithOperand

@Nonnull
public IndexAggregateFunction cloneWithOperand(@Nonnull
                                               KeyExpression operand)

cloneWithIndex

@Nonnull
public IndexAggregateFunction cloneWithIndex(@Nonnull
                                             String index)

validate

public void validate(@Nonnull
                     Descriptors.Descriptor descriptor)

adjustRange

@Nonnull
public TupleRange adjustRange(@Nonnull
                              EvaluationContext context,
                              @Nonnull
                              TupleRange tupleRange)

toString

public String toString()

Overrides:

toString in class Object

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