org.hibernate.search.engine.search.sort.dsl

Interface FieldSortOptionsStep<S extends FieldSortOptionsStep<?>>

Type Parameters:

S - The "self" type (the actual exposed type of this step).

All Superinterfaces:

SortFinalStep, SortOrderStep<S>, SortThenStep

public interface FieldSortOptionsStep<S extends FieldSortOptionsStep<?>>
extends SortFinalStep, SortThenStep, SortOrderStep<S>

The initial and final step in a "field" sort definition, where optional parameters can be set.

Author:

Emmanuel Bernard emmanuel@hibernate.org

Method Summary

Modifier and Type	Method and Description
FieldSortMissingValueBehaviorStep<S>	missing() Start describing the behavior of this sort when a document doesn't have any value for the targeted field.
default FieldSortMissingValueBehaviorStep<S>	onMissingValue() Deprecated. Use missing() instead.

Methods inherited from interface org.hibernate.search.engine.search.sort.dsl.SortThenStep

then

Methods inherited from interface org.hibernate.search.engine.search.sort.dsl.SortFinalStep

toSort

Methods inherited from interface org.hibernate.search.engine.search.sort.dsl.SortOrderStep

asc, desc, order

Method Detail

missing

FieldSortMissingValueBehaviorStep<S> missing()

Start describing the behavior of this sort when a document doesn't have any value for the targeted field.

Returns:

The next step.

onMissingValue

@Deprecated
default FieldSortMissingValueBehaviorStep<S> onMissingValue()

Deprecated. Use missing() instead.

Returns:

The next step.