Package com.apple.foundationdb.record.provider.foundationdb.leaderboard

Class TimeWindowRecordFunction<T>

java.lang.Object

com.apple.foundationdb.record.RecordFunction<T>

com.apple.foundationdb.record.metadata.IndexRecordFunction<T>

com.apple.foundationdb.record.provider.foundationdb.leaderboard.TimeWindowRecordFunction<T>

Type Parameters:

T - type of the function result

All Implemented Interfaces:

PlanHashable, QueryHashable

@API(EXPERIMENTAL)
public class TimeWindowRecordFunction<T>
extends IndexRecordFunction<T>

The TIME_WINDOW_RANK record function. Evaluates to the given record's rank of the given type at the given time.

Nested Class Summary

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
TimeWindowRecordFunction(String name, GroupingKeyExpression operand, String index, TimeWindowForFunction timeWindow)

Method Summary

Modifier and Type	Method	Description
TimeWindowRecordFunction<T>	cloneWithIndex(String index)
TimeWindowRecordFunction<T>	cloneWithOperand(GroupingKeyExpression operand)
boolean	equals(Object o)
TimeWindowForFunction	getTimeWindow()
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()

Methods inherited from class com.apple.foundationdb.record.metadata.IndexRecordFunction

getIndex, getOperand, queryHash, validate

Methods inherited from class com.apple.foundationdb.record.RecordFunction

basePlanHash, baseQueryHash, getName

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

TimeWindowRecordFunction

public TimeWindowRecordFunction(@Nonnull
                                String name,
                                @Nonnull
                                GroupingKeyExpression operand,
                                @Nullable
                                String index,
                                @Nonnull
                                TimeWindowForFunction timeWindow)

Method Detail

getTimeWindow

@Nonnull
public TimeWindowForFunction getTimeWindow()

cloneWithOperand

@Nonnull
public TimeWindowRecordFunction<T> cloneWithOperand(@Nonnull
                                                    GroupingKeyExpression operand)

Overrides:

cloneWithOperand in class IndexRecordFunction<T>

cloneWithIndex

@Nonnull
public TimeWindowRecordFunction<T> cloneWithIndex(@Nonnull
                                                  String index)

Overrides:

cloneWithIndex in class IndexRecordFunction<T>

toString

public String toString()

Overrides:

toString in class IndexRecordFunction<T>

equals

public boolean equals(Object o)

Overrides:

equals in class IndexRecordFunction<T>

hashCode

public int hashCode()

Overrides:

hashCode in class IndexRecordFunction<T>

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

Overrides:

planHash in class IndexRecordFunction<T>

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