io.lettuce.core

Class ZStoreArgs

java.lang.Object

io.lettuce.core.ZAggregateArgs

io.lettuce.core.ZStoreArgs

All Implemented Interfaces:

CompositeArgument

public class ZStoreArgs
extends ZAggregateArgs

Argument list builder for the Redis ZUNIONSTORE and ZINTERSTORE commands. Static import the methods from ZStoreArgs.Builder and chain the method calls: weights(1, 2).max().

ZStoreArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Author:

Will Glozer, Xy Ma, Mark Paluch, Mikhael Sokolov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZStoreArgs.Builder Builder entry points for ScanArgs.

Constructor Summary

Constructors

Constructor and Description
ZStoreArgs()

Method Summary

Modifier and Type	Method and Description
ZStoreArgs	count() Aggregate scores of elements existing across multiple sets by using the number of input sets that contain each element.
ZStoreArgs	max() Aggregate scores of elements existing across multiple sets by using the highest score.
ZStoreArgs	min() Aggregate scores of elements existing across multiple sets by using the lowest score.
ZStoreArgs	sum() Aggregate scores of elements existing across multiple sets by summing up.
ZStoreArgs	weights(double... weights) Specify a multiplication factor for each input sorted set.
static ZStoreArgs	weights(long[] weights) Deprecated. use weights(double...)

Methods inherited from class io.lettuce.core.ZAggregateArgs

build

Methods inherited from class java.lang.Object

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

Constructor Detail

ZStoreArgs

public ZStoreArgs()

Method Detail

weights

@Deprecated
public static ZStoreArgs weights(long[] weights)

Deprecated. use weights(double...)

Specify a multiplication factor for each input sorted set.

Parameters:

weights - must not be null.

Returns:

this ZStoreArgs.

weights

public ZStoreArgs weights(double... weights)

Specify a multiplication factor for each input sorted set.

Overrides:

weights in class ZAggregateArgs

Parameters:

weights - must not be null.

Returns:

this ZStoreArgs.

sum

public ZStoreArgs sum()

Aggregate scores of elements existing across multiple sets by summing up.

Overrides:

sum in class ZAggregateArgs

Returns:

this ZStoreArgs.

min

public ZStoreArgs min()

Aggregate scores of elements existing across multiple sets by using the lowest score.

Overrides:

min in class ZAggregateArgs

Returns:

this ZStoreArgs.

max

public ZStoreArgs max()

Aggregate scores of elements existing across multiple sets by using the highest score.

Overrides:

max in class ZAggregateArgs

Returns:

this ZStoreArgs.

count

public ZStoreArgs count()

Aggregate scores of elements existing across multiple sets by using the number of input sets that contain each element. When COUNT is specified, the scores in the input sets are ignored. WEIGHTS are not ignored: the score of each element becomes the sum of the weights specified for the input sets that contain it (defaulting to 1 per set when WEIGHTS is not provided).

Overrides:

count in class ZAggregateArgs

Returns:

this ZStoreArgs.

Since:

7.6