public class ConnectedSortContext extends AbstractConnectedSortContext implements SortContext
queryContext, states
Constructor and Description |
---|
ConnectedSortContext(QueryBuildingContext queryContext) |
Modifier and Type | Method and Description |
---|---|
SortDistanceNoFieldContext |
byDistance()
Order elements by distance.
|
SortFieldContext |
byField(String field)
Order elements by the value of a specific field.
|
SortFieldContext |
byField(String field,
SortField.Type sortFieldType)
Order elements by value of a specific field, with the sort field type provided.
|
SortOrderTermination |
byIndexOrder()
Order elements by their internal index order.
|
SortNativeContext |
byNative(SortField sortField)
Order element using the native backend API for Lucene.
|
SortNativeContext |
byNative(String field,
String nativeDescription)
Order element using the native backend API for Elasticsearch.
|
SortScoreContext |
byScore()
Order elements by their relevance score.
|
getQueryContext, getStates
public ConnectedSortContext(QueryBuildingContext queryContext)
public SortScoreContext byScore()
SortContext
The default order is descending, i.e. higher scores come first.
byScore
in interface SortContext
public SortOrderTermination byIndexOrder()
SortContext
byIndexOrder
in interface SortContext
public SortFieldContext byField(String field)
SortContext
The default order is ascending.
The sort field type will be determined automatically if possible, and an exception will be thrown
if it is not possible. Automatically determining the type is impossible in particular if
a custom field bridge is defined on the given field and if this bridge doesn't implement
MetadataProvidingFieldBridge
.
byField
in interface SortContext
field
- The name of the index field to sort byThe alternative for
numeric fields with custom field bridges that don't implement {@link MetadataProvidingFieldBridge}.
public SortFieldContext byField(String field, SortField.Type sortFieldType)
SortContext
The default order is ascending.
Note: using this method is only required when sorting on a
field on which a custom field bridge that doesn't implement
MetadataProvidingFieldBridge
is defined.
Otherwise, one may simply use SortContext.byField(String)
.
byField
in interface SortContext
field
- The name of the index field to sort bysortFieldType
- The sort field typepublic SortDistanceNoFieldContext byDistance()
SortContext
The default order is ascending, i.e. shorter distances come first.
The distance is computed between the value of a field carrying coordinates
(to be provided in the next context
)
and reference coordinates.
byDistance
in interface SortContext
public SortNativeContext byNative(SortField sortField)
SortContext
The sort order (ascending/descending) is defined in sortField
byNative
in interface SortContext
sortField
- The sort field to be added to the sort list.public SortNativeContext byNative(String field, String nativeDescription)
SortContext
byNative
in interface SortContext
field
- The name of the index field to sort bynativeDescription
- The sort field description, as valid JSON. This may be a
simple quoted string (e.g. "'asc'") or a JSON map (e.g. "{'key': 'value'}"). See
Elasticsearch's documentation for information about the exact syntax.Copyright © 2006-2017 Red Hat, Inc. All Rights Reserved