org.hibernate.search.query.dsl.sort.impl

Class ConnectedSortAdditionalSortFieldContext

java.lang.Object

org.hibernate.search.query.dsl.sort.impl.AbstractConnectedSortContext

org.hibernate.search.query.dsl.sort.impl.ConnectedSortAdditionalSortFieldContext

All Implemented Interfaces:

SortAdditionalSortFieldContext

Direct Known Subclasses:

ConnectedSortDistanceFieldAndReferenceContext, ConnectedSortFieldContext, ConnectedSortNativeContext, ConnectedSortScoreContext

public abstract class ConnectedSortAdditionalSortFieldContext
extends AbstractConnectedSortContext
implements SortAdditionalSortFieldContext

Author:

Emmanuel Bernard emmanuel@hibernate.org

Field Summary

Fields inherited from class org.hibernate.search.query.dsl.sort.impl.AbstractConnectedSortContext

queryContext, states

Constructor Summary

Constructors

Constructor and Description
ConnectedSortAdditionalSortFieldContext(QueryBuildingContext queryContext, SortFieldStates states)

Method Summary

Modifier and Type	Method and Description
SortDistanceNoFieldContext	andByDistance() Order elements by distance.
SortFieldContext	andByField(String field) Order elements by the value of a specific field.
SortFieldContext	andByField(String field, org.apache.lucene.search.SortField.Type sortFieldType) Order elements by value of a specific field, with the sort field type provided.
SortOrderTermination	andByIndexOrder() Order elements by their internal index order.
SortNativeContext	andByNative(org.apache.lucene.search.SortField sortField) Order element using the native backend API for Lucene.
SortNativeContext	andByNative(String sortField, String nativeDescription) Order element using the native backend API for Elasticsearch.
SortScoreContext	andByScore() Order elements by their relevance score.

Methods inherited from class org.hibernate.search.query.dsl.sort.impl.AbstractConnectedSortContext

getQueryContext, getStates

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectedSortAdditionalSortFieldContext

public ConnectedSortAdditionalSortFieldContext(QueryBuildingContext queryContext,
                                               SortFieldStates states)

Method Detail

andByField

public SortFieldContext andByField(String field)

Description copied from interface: SortAdditionalSortFieldContext

Order elements by the value of a specific field.

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.

Specified by:

andByField in interface SortAdditionalSortFieldContext

Parameters:

field - The name of the index field to sort by

See Also:

SortContext.byField(String), The alternative for numeric fields with custom field bridges that don't implement {@link MetadataProvidingFieldBridge}.

andByField

public SortFieldContext andByField(String field,
                                   org.apache.lucene.search.SortField.Type sortFieldType)

Description copied from interface: SortAdditionalSortFieldContext

Order elements by value of a specific field, with the sort field type provided.

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 SortAdditionalSortFieldContext.andByField(String).

Specified by:

andByField in interface SortAdditionalSortFieldContext

Parameters:

field - The name of the index field to sort by

sortFieldType - The sort field type

andByScore

public SortScoreContext andByScore()

Description copied from interface: SortAdditionalSortFieldContext

Order elements by their relevance score.

The default order is descending, i.e. higher scores come first.

Specified by:

andByScore in interface SortAdditionalSortFieldContext

See Also:

SortContext.byScore()

andByIndexOrder

public SortOrderTermination andByIndexOrder()

Description copied from interface: SortAdditionalSortFieldContext

Order elements by their internal index order.

Specified by:

andByIndexOrder in interface SortAdditionalSortFieldContext

See Also:

SortContext.byIndexOrder()

andByDistance

public SortDistanceNoFieldContext andByDistance()

Description copied from interface: SortAdditionalSortFieldContext

Order elements by distance.

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.

Specified by:

andByDistance in interface SortAdditionalSortFieldContext

See Also:

SortContext.byDistance()

andByNative

public SortNativeContext andByNative(org.apache.lucene.search.SortField sortField)

Description copied from interface: SortAdditionalSortFieldContext

Order element using the native backend API for Lucene.

The sort order (ascending/descending) is defined in sortField

Specified by:

andByNative in interface SortAdditionalSortFieldContext

Parameters:

sortField - The sort field to be added to the sort list.

See Also:

SortContext.byNative(SortField)

andByNative

public SortNativeContext andByNative(String sortField,
                                     String nativeDescription)

Description copied from interface: SortAdditionalSortFieldContext

Order element using the native backend API for Elasticsearch.

Specified by:

andByNative in interface SortAdditionalSortFieldContext

Parameters:

sortField - The name of the index field to sort by

nativeDescription - 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.

See Also:

SortContext.byNative(String, String)