org.springframework.data.redis.core

Interface BoundZSetOperations<K,V>

All Superinterfaces:

BoundKeyOperations<K>

public interface BoundZSetOperations<K,V>
extends BoundKeyOperations<K>

ZSet (or SortedSet) operations bound to a certain key.

Author:

Costin Leau, Christoph Strobl, Mark Paluch, Wongoo (望哥)

Method Summary

Modifier and Type	Method and Description
Long	add(Set<ZSetOperations.TypedTuple<V>> tuples) Add tuples to a sorted set at the bound key, or update its score if it already exists.
Boolean	add(V value, double score) Add value to a sorted set at the bound key, or update its score if it already exists.
Long	count(double min, double max) Count number of elements within sorted set with scores between min and max.
RedisOperations<K,V>	getOperations()
Double	incrementScore(V value, double delta) Increment the score of element with value in sorted set by increment.
Long	intersectAndStore(Collection<K> otherKeys, K destKey) Intersect sorted sets at the bound key and otherKeys and store result in destination destKey.
Long	intersectAndStore(Collection<K> otherKeys, K destKey, RedisZSetCommands.Aggregate aggregate) Intersect sorted sets at the bound key and otherKeys and store result in destination destKey.
Long	intersectAndStore(Collection<K> otherKeys, K destKey, RedisZSetCommands.Aggregate aggregate, RedisZSetCommands.Weights weights) Intersect sorted sets at the bound key and otherKeys and store result in destination destKey.
Long	intersectAndStore(K otherKey, K destKey) Intersect sorted sets at the bound key and otherKey and store result in destination destKey.
Set<V>	range(long start, long end) Get elements between start and end from sorted set.
Set<V>	rangeByLex(RedisZSetCommands.Range range) Get all elements with lexicographical ordering with a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().
Set<V>	rangeByLex(RedisZSetCommands.Range range, RedisZSetCommands.Limit limit) Get all elements n elements, where n = RedisZSetCommands.Limit.getCount(), starting at RedisZSetCommands.Limit.getOffset() with lexicographical ordering having a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().
Set<V>	rangeByScore(double min, double max) Get elements where score is between min and max from sorted set.
Set<ZSetOperations.TypedTuple<V>>	rangeByScoreWithScores(double min, double max) Get set of RedisZSetCommands.Tuples where score is between min and max from sorted set.
Set<ZSetOperations.TypedTuple<V>>	rangeWithScores(long start, long end) Get set of RedisZSetCommands.Tuples between start and end from sorted set.
Long	rank(Object o) Determine the index of element with value in a sorted set.
Long	remove(Object... values) Remove values from sorted set.
Long	removeRange(long start, long end) Remove elements in range between start and end from sorted set with the bound key.
Long	removeRangeByScore(double min, double max) Remove elements with scores between min and max from sorted set with the bound key.
Set<V>	reverseRange(long start, long end) Get elements in range from start to end from sorted set ordered from high to low.
Set<V>	reverseRangeByScore(double min, double max) Get elements where score is between min and max from sorted set ordered from high to low.
Set<ZSetOperations.TypedTuple<V>>	reverseRangeByScoreWithScores(double min, double max) Get set of RedisZSetCommands.Tuple where score is between min and max from sorted set ordered from high to low.
Set<ZSetOperations.TypedTuple<V>>	reverseRangeWithScores(long start, long end) Get set of RedisZSetCommands.Tuples in range from start to end from sorted set ordered from high to low.
Long	reverseRank(Object o) Determine the index of element with value in a sorted set when scored high to low.
Cursor<ZSetOperations.TypedTuple<V>>	scan(ScanOptions options) Iterate over elements in zset at the bound key.
Double	score(Object o) Get the score of element with value from sorted set with key the bound key.
Long	size() Returns the number of elements of the sorted set stored with given the bound key.
Long	unionAndStore(Collection<K> otherKeys, K destKey) Union sorted sets at the bound key and otherKeys and store result in destination destKey.
Long	unionAndStore(Collection<K> otherKeys, K destKey, RedisZSetCommands.Aggregate aggregate) Union sorted sets at the bound key and otherKeys and store result in destination destKey.
Long	unionAndStore(Collection<K> otherKeys, K destKey, RedisZSetCommands.Aggregate aggregate, RedisZSetCommands.Weights weights) Union sorted sets at the bound key and otherKeys and store result in destination destKey.
Long	unionAndStore(K otherKey, K destKey) Union sorted sets at the bound key and otherKeys and store result in destination destKey.
Long	zCard() Get the size of sorted set with the bound key.

Methods inherited from interface org.springframework.data.redis.core.BoundKeyOperations

expire, expire, expireAt, expireAt, getExpire, getKey, getType, persist, rename

Method Detail

add

@Nullable
Boolean add(V value,
                      double score)

Add value to a sorted set at the bound key, or update its score if it already exists.

Parameters:

score - the score.

value - the value.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZADD

add

@Nullable
Long add(Set<ZSetOperations.TypedTuple<V>> tuples)

Add tuples to a sorted set at the bound key, or update its score if it already exists.

Parameters:

tuples - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZADD

remove

@Nullable
Long remove(Object... values)

Remove values from sorted set. Return number of removed elements.

Parameters:

values - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREM

incrementScore

@Nullable
Double incrementScore(V value,
                                double delta)

Increment the score of element with value in sorted set by increment.

Parameters:

delta -

value - the value.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZINCRBY

rank

@Nullable
Long rank(Object o)

Determine the index of element with value in a sorted set.

Parameters:

o - the value.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANK

reverseRank

@Nullable
Long reverseRank(Object o)

Determine the index of element with value in a sorted set when scored high to low.

Parameters:

o - the value.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANK

range

@Nullable
Set<V> range(long start,
                       long end)

Get elements between start and end from sorted set.

Parameters:

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGE

rangeWithScores

@Nullable
Set<ZSetOperations.TypedTuple<V>> rangeWithScores(long start,
                                                            long end)

Get set of RedisZSetCommands.Tuples between start and end from sorted set.

Parameters:

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGE

rangeByScore

@Nullable
Set<V> rangeByScore(double min,
                              double max)

Get elements where score is between min and max from sorted set.

Parameters:

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGEBYSCORE

rangeByScoreWithScores

@Nullable
Set<ZSetOperations.TypedTuple<V>> rangeByScoreWithScores(double min,
                                                                   double max)

Get set of RedisZSetCommands.Tuples where score is between min and max from sorted set.

Parameters:

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGEBYSCORE

reverseRange

@Nullable
Set<V> reverseRange(long start,
                              long end)

Get elements in range from start to end from sorted set ordered from high to low.

Parameters:

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGE

reverseRangeWithScores

@Nullable
Set<ZSetOperations.TypedTuple<V>> reverseRangeWithScores(long start,
                                                                   long end)

Get set of RedisZSetCommands.Tuples in range from start to end from sorted set ordered from high to low.

Parameters:

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGE

reverseRangeByScore

@Nullable
Set<V> reverseRangeByScore(double min,
                                     double max)

Get elements where score is between min and max from sorted set ordered from high to low.

Parameters:

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGEBYSCORE

reverseRangeByScoreWithScores

@Nullable
Set<ZSetOperations.TypedTuple<V>> reverseRangeByScoreWithScores(double min,
                                                                          double max)

Get set of RedisZSetCommands.Tuple where score is between min and max from sorted set ordered from high to low.

Parameters:

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGEBYSCORE

count

@Nullable
Long count(double min,
                     double max)

Count number of elements within sorted set with scores between min and max.

Parameters:

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZCOUNT

size

@Nullable
Long size()

Returns the number of elements of the sorted set stored with given the bound key.

Returns:

null when used in pipeline / transaction.

See Also:

zCard(), Redis Documentation: ZCARD

zCard

@Nullable
Long zCard()

Get the size of sorted set with the bound key.

Returns:

null when used in pipeline / transaction.

Since:

1.3

See Also:

Redis Documentation: ZCARD

score

@Nullable
Double score(Object o)

Get the score of element with value from sorted set with key the bound key.

Parameters:

o - the value.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZSCORE

removeRange

@Nullable
Long removeRange(long start,
                           long end)

Remove elements in range between start and end from sorted set with the bound key.

Parameters:

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREMRANGEBYRANK

removeRangeByScore

@Nullable
Long removeRangeByScore(double min,
                                  double max)

Remove elements with scores between min and max from sorted set with the bound key.

Parameters:

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREMRANGEBYSCORE

unionAndStore

@Nullable
Long unionAndStore(K otherKey,
                             K destKey)

Union sorted sets at the bound key and otherKeys and store result in destination destKey.

Parameters:

otherKey - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZUNIONSTORE

unionAndStore

@Nullable
Long unionAndStore(Collection<K> otherKeys,
                             K destKey)

Union sorted sets at the bound key and otherKeys and store result in destination destKey.

Parameters:

otherKeys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZUNIONSTORE

unionAndStore

@Nullable
Long unionAndStore(Collection<K> otherKeys,
                             K destKey,
                             RedisZSetCommands.Aggregate aggregate)

Union sorted sets at the bound key and otherKeys and store result in destination destKey.

Parameters:

otherKeys - must not be null.

destKey - must not be null.

aggregate - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: ZUNIONSTORE

unionAndStore

@Nullable
Long unionAndStore(Collection<K> otherKeys,
                             K destKey,
                             RedisZSetCommands.Aggregate aggregate,
                             RedisZSetCommands.Weights weights)

Union sorted sets at the bound key and otherKeys and store result in destination destKey.

Parameters:

otherKeys - must not be null.

destKey - must not be null.

aggregate - must not be null.

weights - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: ZUNIONSTORE

intersectAndStore

@Nullable
Long intersectAndStore(K otherKey,
                                 K destKey)

Intersect sorted sets at the bound key and otherKey and store result in destination destKey.

Parameters:

otherKey - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZINTERSTORE

intersectAndStore

@Nullable
Long intersectAndStore(Collection<K> otherKeys,
                                 K destKey)

Intersect sorted sets at the bound key and otherKeys and store result in destination destKey.

Parameters:

otherKeys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZINTERSTORE

intersectAndStore

@Nullable
Long intersectAndStore(Collection<K> otherKeys,
                                 K destKey,
                                 RedisZSetCommands.Aggregate aggregate)

Intersect sorted sets at the bound key and otherKeys and store result in destination destKey.

Parameters:

otherKeys - must not be null.

destKey - must not be null.

aggregate - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: ZINTERSTORE

intersectAndStore

@Nullable
Long intersectAndStore(Collection<K> otherKeys,
                                 K destKey,
                                 RedisZSetCommands.Aggregate aggregate,
                                 RedisZSetCommands.Weights weights)

Intersect sorted sets at the bound key and otherKeys and store result in destination destKey.

Parameters:

otherKeys - must not be null.

destKey - must not be null.

aggregate - must not be null.

weights - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: ZINTERSTORE

scan

Cursor<ZSetOperations.TypedTuple<V>> scan(ScanOptions options)

Iterate over elements in zset at the bound key.
Important: Call Closeable.close() when done to avoid resource leak.

Parameters:

options -

Returns:

Since:

1.4

rangeByLex

@Nullable
Set<V> rangeByLex(RedisZSetCommands.Range range)

Get all elements with lexicographical ordering with a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().

Parameters:

range - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

1.7

See Also:

Redis Documentation: ZRANGEBYLEX

rangeByLex

@Nullable
Set<V> rangeByLex(RedisZSetCommands.Range range,
                            RedisZSetCommands.Limit limit)

Get all elements n elements, where n = RedisZSetCommands.Limit.getCount(), starting at RedisZSetCommands.Limit.getOffset() with lexicographical ordering having a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().

Parameters:

range - must not be null.

limit - can be null.

Returns:

null when used in pipeline / transaction.

Since:

1.7

See Also:

Redis Documentation: ZRANGEBYLEX

getOperations

RedisOperations<K,V> getOperations()

Returns:

never null.