Module spring.data.elasticsearch

Package org.springframework.data.elasticsearch.core.query

Class Order

java.lang.Object

org.springframework.data.domain.Sort.Order

org.springframework.data.elasticsearch.core.query.Order

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GeoDistanceOrder

public class Order
extends Sort.Order

Extends the Sort.Order with properties that can be set on Elasticsearch order options.

Since:

4.3

Author:

Peter-Josef Meisch

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Order.Mode
static class	Order.Nested

Field Summary

Fields

Modifier and Type	Field	Description
static final Sort.NullHandling	DEFAULT_NULL_HANDLING
protected final String	missing
protected final Order.Mode	mode
protected final Order.Nested	nested
protected final String	unmappedType

Constructor Summary

Constructors

Constructor	Description
Order(Sort.Direction direction, String property)
Order(Sort.Direction direction, String property, String unmappedType)
Order(Sort.Direction direction, String property, Sort.NullHandling nullHandlingHint)
Order(Sort.Direction direction, String property, Sort.NullHandling nullHandlingHint, String unmappedType)
Order(Sort.Direction direction, String property, Sort.NullHandling nullHandlingHint, Order.Mode mode)
Order(Sort.Direction direction, String property, Sort.NullHandling nullHandlingHint, Order.Mode mode, String unmappedType)
Order(Sort.Direction direction, String property, Sort.NullHandling nullHandlingHint, Order.Mode mode, String unmappedType, String missing)
Order(Sort.Direction direction, String property, Sort.NullHandling nullHandlingHint, Order.Mode mode, String unmappedType, String missing, Order.Nested nested)
Order(Sort.Direction direction, String property, Order.Mode mode)
Order(Sort.Direction direction, String property, Order.Mode mode, String unmappedType)

Method Summary

Modifier and Type	Method	Description
String	getMissing()
Order.Mode	getMode()
Order.Nested	getNested()
String	getUnmappedType()
Sort.Order	with(Sort.Direction direction)
Sort.Order	with(Sort.NullHandling nullHandling)
Order	with(Order.Mode mode)
Order	withMissing(String missing)
Order	withNested(Order.Nested nested)
Sort.Order	withProperty(String property)
Order	withUnmappedType(String unmappedType)

Methods inherited from class org.springframework.data.domain.Sort.Order

asc, by, desc, equals, getDirection, getNullHandling, getProperty, hashCode, ignoreCase, isAscending, isDescending, isIgnoreCase, nullsFirst, nullsLast, nullsNative, reverse, toString, withProperties

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_NULL_HANDLING

public static final Sort.NullHandling DEFAULT_NULL_HANDLING

mode

@Nullable
protected final Order.Mode mode

unmappedType

@Nullable
protected final String unmappedType

missing

@Nullable
protected final String missing

nested

@Nullable
protected final Order.Nested nested

Constructor Details

Order

public Order(Sort.Direction direction,
 String property)

Order

public Order(Sort.Direction direction,
 String property,
 @Nullable
 Order.Mode mode)

Order

public Order(Sort.Direction direction,
 String property,
 @Nullable
 String unmappedType)

Order

public Order(Sort.Direction direction,
 String property,
 @Nullable
 Order.Mode mode,
 @Nullable
 String unmappedType)

Order

public Order(Sort.Direction direction,
 String property,
 Sort.NullHandling nullHandlingHint)

Order

public Order(Sort.Direction direction,
 String property,
 Sort.NullHandling nullHandlingHint,
 @Nullable
 Order.Mode mode)

Order

public Order(Sort.Direction direction,
 String property,
 Sort.NullHandling nullHandlingHint,
 @Nullable
 String unmappedType)

Order

public Order(Sort.Direction direction,
 String property,
 Sort.NullHandling nullHandlingHint,
 @Nullable
 Order.Mode mode,
 @Nullable
 String unmappedType)

Order

public Order(Sort.Direction direction,
 String property,
 Sort.NullHandling nullHandlingHint,
 @Nullable
 Order.Mode mode,
 @Nullable
 String unmappedType,
 @Nullable
 String missing)

Order

public Order(Sort.Direction direction,
 String property,
 Sort.NullHandling nullHandlingHint,
 @Nullable
 Order.Mode mode,
 @Nullable
 String unmappedType,
 @Nullable
 String missing,
 @Nullable
 Order.Nested nested)

Method Details

getUnmappedType

@Nullable
public String getUnmappedType()

with

public Sort.Order with(Sort.Direction direction)

Overrides:

with in class Sort.Order

withProperty

public Sort.Order withProperty(String property)

Overrides:

withProperty in class Sort.Order

with

public Sort.Order with(Sort.NullHandling nullHandling)

Overrides:

with in class Sort.Order

withUnmappedType

public Order withUnmappedType(@Nullable
 String unmappedType)

with

public Order with(@Nullable
 Order.Mode mode)

withMissing

public Order withMissing(@Nullable
 String missing)

withNested

public Order withNested(@Nullable
 Order.Nested nested)

getMode

@Nullable
public Order.Mode getMode()

getMissing

@Nullable
public String getMissing()

getNested

@Nullable
public Order.Nested getNested()