com.apple.foundationdb.record.provider.foundationdb.indexes

Class RankedSetIndexHelper

java.lang.Object

com.apple.foundationdb.record.provider.foundationdb.indexes.RankedSetIndexHelper

@API(value=INTERNAL)
public class RankedSetIndexHelper
extends Object

Helper functions for index maintainers that use a RankedSet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RankedSetIndexHelper.Events Instrumentation events specific to rank index maintenance.
static class	RankedSetIndexHelper.InstrumentedRankedSet A RankedSet that adds StoreTimer instrumentation.

Field Summary

Fields

Modifier and Type	Field and Description
static Tuple	COMPARISON_SKIPPED_SCORE

Method Summary

Modifier and Type	Method and Description
static CompletableFuture<Long>	rankForScore(IndexMaintainerState state, RankedSet rankedSet, Tuple score, boolean nullIfMissing)
static CompletableFuture<TupleRange>	rankRangeToScoreRange(IndexMaintainerState state, int groupPrefixSize, Subspace rankSubspace, int nlevels, TupleRange rankRange)
static CompletableFuture<Tuple>	scoreForRank(IndexMaintainerState state, RankedSet rankedSet, Number rank, Tuple outOfRange)
static CompletableFuture<Void>	updateRankedSet(IndexMaintainerState state, Subspace rankSubspace, int nlevels, Tuple valueKey, Tuple scoreKey, boolean remove)

Methods inherited from class java.lang.Object

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

Field Detail

COMPARISON_SKIPPED_SCORE

public static final Tuple COMPARISON_SKIPPED_SCORE

Method Detail

rankRangeToScoreRange

@Nonnull
public static CompletableFuture<TupleRange> rankRangeToScoreRange(@Nonnull
                                                                           IndexMaintainerState state,
                                                                           int groupPrefixSize,
                                                                           @Nonnull
                                                                           Subspace rankSubspace,
                                                                           int nlevels,
                                                                           @Nonnull
                                                                           TupleRange rankRange)

scoreForRank

public static CompletableFuture<Tuple> scoreForRank(@Nonnull
                                                    IndexMaintainerState state,
                                                    @Nonnull
                                                    RankedSet rankedSet,
                                                    @Nullable
                                                    Number rank,
                                                    @Nullable
                                                    Tuple outOfRange)

rankForScore

public static CompletableFuture<Long> rankForScore(@Nonnull
                                                   IndexMaintainerState state,
                                                   @Nonnull
                                                   RankedSet rankedSet,
                                                   @Nullable
                                                   Tuple score,
                                                   boolean nullIfMissing)

updateRankedSet

@Nonnull
public static CompletableFuture<Void> updateRankedSet(@Nonnull
                                                               IndexMaintainerState state,
                                                               @Nonnull
                                                               Subspace rankSubspace,
                                                               int nlevels,
                                                               @Nonnull
                                                               Tuple valueKey,
                                                               @Nonnull
                                                               Tuple scoreKey,
                                                               boolean remove)