Package org.hibernate.search.query.dsl.sort

Interface SortAdditionalSortFieldContext

All Known Subinterfaces:

SortDistanceFieldAndReferenceContext, SortFieldContext, SortNativeContext, SortScoreContext

@Deprecated
public interface SortAdditionalSortFieldContext

Deprecated.

See the deprecation note on SortContext.

A context from which one may add another sort definition to the sort list.

Author:

Emmanuel Bernard emmanuel@hibernate.org, Yoann Rodiere

Method Summary

Modifier and Type	Method	Description
SortDistanceNoFieldContext	andByDistance()	Deprecated. Order elements by distance.
SortFieldContext	andByField(String fieldName)	Deprecated. Order elements by the value of a specific field.
SortOrderTermination	andByIndexOrder()	Deprecated. Order elements by their internal index order.
SortNativeContext	andByNative(SortField sortField)	Deprecated. Order element using the native backend API for Lucene.
SortScoreContext	andByScore()	Deprecated. Order elements by their relevance score.

Method Detail

andByScore

SortScoreContext andByScore()

Deprecated.

Order elements by their relevance score.

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

Returns:

a context instance for building the sort

See Also:

SortContext.byScore()

andByIndexOrder

SortOrderTermination andByIndexOrder()

Deprecated.

Order elements by their internal index order.

Returns:

a context instance for building the sort

See Also:

SortContext.byIndexOrder()

andByField

SortFieldContext andByField(String fieldName)

Deprecated.

Order elements by the value of a specific field.

The default order is ascending.

Parameters:

fieldName - The name of the index field to sort by

Returns:

a context instance for building the sort

Throws:

org.hibernate.search.util.common.SearchException - If the sort field type could not be automatically determined.

See Also:

SortContext.byField(String)

andByDistance

SortDistanceNoFieldContext andByDistance()

Deprecated.

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.

Returns:

a context instance for building the sort

See Also:

SortContext.byDistance()

andByNative

SortNativeContext andByNative(SortField sortField)

Deprecated.

Order element using the native backend API for Lucene.

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

Parameters:

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

Returns:

a context instance for building the sort

See Also:

SortContext.byNative(SortField)