io.lettuce.core.search.aggregateutils

Class SortBy

java.lang.Object

io.lettuce.core.search.aggregateutils.SortBy

All Implemented Interfaces:

PostProcessingOperation

@Experimental
public class SortBy
extends Object
implements PostProcessingOperation

SORTBY post-processing operation. Sorts results by one or more properties.

Sorts the pipeline results up until the point of SORTBY, using a list of properties. By default, sorting is ascending, but ASC or DESC can be specified for each property.

Example Usage:

 {
     @code
     // Simple sort by single field
     SortBy sortBy = SortBy.of("price", SortDirection.DESC);

     // Multiple sort criteria
     SortBy multiSort = SortBy.of(SortProperty.of("category", SortDirection.ASC),
             SortProperty.of("price", SortDirection.DESC));
 }
 

Since:

7.5

Author:

Aleksandar Todorov

See Also:

SortProperty, SortDirection, PostProcessingOperation

Constructor Summary

Constructors

Constructor and Description
SortBy(List<SortProperty> properties) Creates a new SORTBY operation.

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<?,?> args) Build the operation arguments into the command args.
static SortBy	of(SortProperty... properties) Static factory method to create a SortBy instance with multiple properties.
static SortBy	of(String property, SortDirection direction) Static factory method to create a SortBy instance with a single property.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortBy

public SortBy(List<SortProperty> properties)

Creates a new SORTBY operation.

Parameters:

properties - the properties to sort by

Method Detail

of

public static SortBy of(String property,
                        SortDirection direction)

Static factory method to create a SortBy instance with a single property.

Parameters:

property - the property to sort by

direction - the sort direction

Returns:

new SortBy instance

of

@SafeVarargs
public static SortBy of(SortProperty... properties)

Static factory method to create a SortBy instance with multiple properties.

Parameters:

properties - the properties to sort by

Returns:

new SortBy instance

build

public void build(CommandArgs<?,?> args)

Description copied from interface: PostProcessingOperation

Build the operation arguments into the command args.

Specified by:

build in interface PostProcessingOperation

Parameters:

args - the command args to build into