com.textkernel.tx.models.api.matchV2.querying

Class Sorting

java.lang.Object

com.textkernel.tx.models.api.matchV2.querying.Sorting

public class Sorting
extends Object

Options to control sort order

Field Summary

Fields

Modifier and Type	Field and Description
String	Field The field name.
SortOrder	Order Optional order of the sorting.
String	ReferenceLocation Optional (required for fields with location data type specified) String representation of a location point in the form of LATITUDE LONGITUDE (e.g.

Constructor Summary

Constructors

Constructor and Description
Sorting()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

Field

public String Field

The field name. Two special "fields" exist: _reranker and _score. _score means sorting by the engine score, _reranker means sorting by reranker score. For sorting with type _reranker a reranker needs to be configured. A sorting on field _reranker cannot have subsortings on other fields and cannot have a custom order.

Order

public SortOrder Order

Optional order of the sorting. The default behavior depends on the data type of the field: SortOrder.DESCENDING for numeric and date types, SortOrder.ASCENDING for other types. For fields with location data type, results will be sorted according to the distance to the ReferenceLocation and only SortOrder.ASCENDING is supported.

ReferenceLocation

public String ReferenceLocation

Optional (required for fields with location data type specified) String representation of a location point in the form of LATITUDE LONGITUDE (e.g. 53.3478 -6.2597). This is used for distance sorting on a location field.

Constructor Detail

Sorting

public Sorting()