Package com.couchbase.client.java.search.sort

Class SearchSort

java.lang.Object

com.couchbase.client.java.search.sort.SearchSort

Direct Known Subclasses:

SearchSortField, SearchSortGeoDistance, SearchSortId, SearchSortScore

public abstract class SearchSort
extends Object

Base class for all FTS sort options in querying.

Since:

2.4.5

Author:

Michael Nitschinger

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	descending

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SearchSort()

Method Summary

Modifier and Type	Method	Description
static SearchSortField	byField(String field)	Sort by a field in the rows.
static SearchSortGeoDistance	byGeoDistance(double locationLon, double locationLat, String field)	Sort by distance from a geographic location.
static SearchSortId	byId()	Sort by the document identifier.
static SearchSortScore	byScore()	Sort by the hit score.
SearchSort	desc(boolean descending)
abstract CoreSearchSort	toCore()

Methods inherited from class java.lang.Object

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

Field Detail

descending

protected boolean descending

Constructor Detail

SearchSort

protected SearchSort()

Method Detail

toCore

@Internal
public abstract CoreSearchSort toCore()

desc

public SearchSort desc(boolean descending)

byId

public static SearchSortId byId()

Sort by the document identifier.

byScore

public static SearchSortScore byScore()

Sort by the hit score.

byField

public static SearchSortField byField(String field)

Sort by a field in the rows.

Parameters:

field - the field name.

byGeoDistance

public static SearchSortGeoDistance byGeoDistance(double locationLon,
                                                  double locationLat,
                                                  String field)

Sort by distance from a geographic location.

Parameters:

locationLon - longitude of the location.

locationLat - latitude of the location.

field - the field name.