Package co.elasticsearch.enterprisesearch.client.model

Class Sort

java.lang.Object

co.elasticsearch.enterprisesearch.client.model.Sort

public class Sort
extends Object

Represents a sort order

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Sort.Order	Represents a sort order

Field Summary

Fields

Modifier and Type	Field	Description
static String	SCORE	Default sorting for documents, score

Constructor Summary

Constructors

Constructor	Description
Sort()	Create a sort without name or direction.
Sort(String field, GeolocationSort location)	Create a sort with the given name and location
Sort(String field, Sort.Order order)	Create a sort with the given name and order

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SortOrder	getDirection()	The sort order
String	getName()	The sort name
int	hashCode()
Sort	setDirection(SortOrder direction)	The sort order
Sort	setName(String name)	The sort name

Methods inherited from class java.lang.Object

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

Field Detail

SCORE

public static final String SCORE

Default sorting for documents, score

See Also:

Constant Field Values

Constructor Detail

Sort

public Sort()

Create a sort without name or direction. Used for reflection libraries

Sort

public Sort(String field,
            @NonNull
            Sort.Order order)

Create a sort with the given name and order

Parameters:

field - The field to sort on

order - The order to sort results

Sort

public Sort(String field,
            GeolocationSort location)

Create a sort with the given name and location

Parameters:

field - The field name to sort on

location - The location to sort on;

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

public String getName()

The sort name

Returns:

the sort name

getDirection

public SortOrder getDirection()

The sort order

Returns:

the sort order

setName

public Sort setName(String name)

The sort name

Parameters:

name - the sort name

Returns:

this.

setDirection

public Sort setDirection(SortOrder direction)

The sort order

Parameters:

direction - the sort order

Returns:

this.