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

Class TimeWindowLeaderboardWindowUpdate

java.lang.Object

com.apple.foundationdb.record.provider.foundationdb.IndexOperation

com.apple.foundationdb.record.provider.foundationdb.leaderboard.TimeWindowLeaderboardWindowUpdate

@API(EXPERIMENTAL)
public class TimeWindowLeaderboardWindowUpdate
extends IndexOperation

Maintain active set of time windows.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeWindowLeaderboardWindowUpdate.Rebuild	When to completely rebuild an index.
static class	TimeWindowLeaderboardWindowUpdate.TimeWindowSpec	A specification of a set of sliding time windows.

Constructor Summary

Constructors

Constructor	Description
TimeWindowLeaderboardWindowUpdate(long updateTimestamp, boolean highScoreFirst, long deleteBefore, boolean allTime, Iterable<TimeWindowLeaderboardWindowUpdate.TimeWindowSpec> specs, int nlevels, TimeWindowLeaderboardWindowUpdate.Rebuild rebuild)	Create a time window update operation.
TimeWindowLeaderboardWindowUpdate(long updateTimestamp, boolean highScoreFirst, long deleteBefore, boolean allTime, Iterable<TimeWindowLeaderboardWindowUpdate.TimeWindowSpec> specs, TimeWindowLeaderboardWindowUpdate.Rebuild rebuild)	Create a time window update operation.

Method Summary

Modifier and Type	Method	Description
long	getDeleteBefore()
int	getNlevels()
TimeWindowLeaderboardWindowUpdate.Rebuild	getRebuild()
Iterable<TimeWindowLeaderboardWindowUpdate.TimeWindowSpec>	getSpecs()
long	getUpdateTimestamp()
boolean	isAllTime()
boolean	isHighScoreFirst()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimeWindowLeaderboardWindowUpdate

public TimeWindowLeaderboardWindowUpdate(long updateTimestamp,
                                         boolean highScoreFirst,
                                         long deleteBefore,
                                         boolean allTime,
                                         Iterable<TimeWindowLeaderboardWindowUpdate.TimeWindowSpec> specs,
                                         int nlevels,
                                         TimeWindowLeaderboardWindowUpdate.Rebuild rebuild)

Create a time window update operation.

Parameters:

updateTimestamp - a timestamp to be recorded if any changes are made

highScoreFirst - if true, numerically higher scores come first in the index

deleteBefore - delete any time windows ending at this time or before

allTime - include an all-time leaderboard

specs - specifications for time windows to create

nlevels - number of skip list levels to maintain

rebuild - completely rebuild the index using the new time windows by scanning all existing records

TimeWindowLeaderboardWindowUpdate

public TimeWindowLeaderboardWindowUpdate(long updateTimestamp,
                                         boolean highScoreFirst,
                                         long deleteBefore,
                                         boolean allTime,
                                         Iterable<TimeWindowLeaderboardWindowUpdate.TimeWindowSpec> specs,
                                         TimeWindowLeaderboardWindowUpdate.Rebuild rebuild)

Create a time window update operation.

Parameters:

updateTimestamp - a timestamp to be recorded if any changes are made

highScoreFirst - if true, numerically higher scores come first in the index

deleteBefore - delete any time windows ending at this time or before

allTime - include an all-time leaderboard

specs - specifications for time windows to create

rebuild - completely rebuild the index using the new time windows by scanning all existing records

Method Detail

getUpdateTimestamp

public long getUpdateTimestamp()

isHighScoreFirst

public boolean isHighScoreFirst()

getDeleteBefore

public long getDeleteBefore()

isAllTime

public boolean isAllTime()

getSpecs

public Iterable<TimeWindowLeaderboardWindowUpdate.TimeWindowSpec> getSpecs()

getNlevels

public int getNlevels()

getRebuild

public TimeWindowLeaderboardWindowUpdate.Rebuild getRebuild()