redis.clients.jedis.params

Class SortingParams

java.lang.Object

redis.clients.jedis.params.SortingParams

All Implemented Interfaces:

IParams

public class SortingParams
extends java.lang.Object
implements IParams

Builder Class for SORT command parameters.

Constructor Summary

Constructors

Constructor and Description
SortingParams()

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
SortingParams	alpha() Sort lexicographicaly.
SortingParams	asc() Get the Sorting in Ascending Order.
SortingParams	by(byte[] pattern) Sort by weight in keys.
SortingParams	by(java.lang.String pattern) Sort by weight in keys.
SortingParams	desc() Get the Sorting in Descending Order.
boolean	equals(java.lang.Object o)
SortingParams	get(byte[]... patterns) Retrieving external keys from the result of the search.
SortingParams	get(java.lang.String... patterns) Retrieving external keys from the result of the search.
int	hashCode()
SortingParams	limit(int start, int count) Limit the Numbers of returned Elements.
SortingParams	nosort() No sorting.
SortingParams	sortingOrder(SortingOrder order) Get by the Sorting Order.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortingParams

public SortingParams()

Method Detail

by

public SortingParams by(java.lang.String pattern)

Sort by weight in keys.

Takes a pattern that is used in order to generate the key names of the weights used for sorting. Weight key names are obtained substituting the first occurrence of * with the actual value of the elements on the list.

The pattern for a normal key/value pair is "field*" and for a value in a hash "field*->fieldname".

Parameters:

pattern -

Returns:

the SortingParams Object

by

public SortingParams by(byte[] pattern)

Sort by weight in keys.

Takes a pattern that is used in order to generate the key names of the weights used for sorting. Weight key names are obtained substituting the first occurrence of * with the actual value of the elements on the list.

The pattern for a normal key/value pair is "field*" and for a value in a hash "field*->fieldname".

Parameters:

pattern -

Returns:

the SortingParams Object

nosort

public SortingParams nosort()

No sorting.

This is useful if you want to retrieve an external key (using GET) but you don't want the sorting overhead.

Returns:

the SortingParams Object

desc

public SortingParams desc()

Get the Sorting in Descending Order.

Returns:

the sortingParams Object

asc

public SortingParams asc()

Get the Sorting in Ascending Order. This is the default order.

Returns:

the SortingParams Object

sortingOrder

public SortingParams sortingOrder(SortingOrder order)

Get by the Sorting Order.

Parameters:

order - the Sorting order

Returns:

the SortingParams object

limit

public SortingParams limit(int start,
                           int count)

Limit the Numbers of returned Elements.

Parameters:

start - is zero based

count -

Returns:

the SortingParams Object

alpha

public SortingParams alpha()

Sort lexicographicaly. Note that Redis is utf-8 aware assuming you set the right value for the LC_COLLATE environment variable.

Returns:

the SortingParams Object

get

public SortingParams get(java.lang.String... patterns)

Retrieving external keys from the result of the search.

Takes a pattern that is used in order to generate the key names of the result of sorting. The key names are obtained substituting the first occurrence of * with the actual value of the elements on the list.

The pattern for a normal key/value pair is "field*" and for a value in a hash "field*->fieldname".

To get the list itself use the char # as pattern.

Parameters:

patterns -

Returns:

the SortingParams Object

get

public SortingParams get(byte[]... patterns)

Retrieving external keys from the result of the search.

Takes a pattern that is used in order to generate the key names of the result of sorting. The key names are obtained substituting the first occurrence of * with the actual value of the elements on the list.

The pattern for a normal key/value pair is "field*" and for a value in a hash "field*->fieldname".

To get the list itself use the char # as pattern.

Parameters:

patterns -

Returns:

the SortingParams Object

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object