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

Interface FieldSortOptionsStep<S extends FieldSortOptionsStep<?,PDF>,PDF extends SearchPredicateFactory>

Type Parameters:
S - The "self" type (the actual exposed type of this step).
PDF - The type of factory used to create predicates in SortFilterStep.filter(Function).
All Superinterfaces:
SortFilterStep<S,PDF>, SortFinalStep, SortModeStep<S>, SortOrderStep<S>, SortThenStep
public interface FieldSortOptionsStep<S extends FieldSortOptionsStep<?,PDF>,PDF extends SearchPredicateFactory> extends SortFinalStep, SortThenStep, SortOrderStep<S>, SortModeStep<S>, SortFilterStep<S,PDF>
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
    Description
    FieldSortMissingValueBehaviorStep<S>
    missing()
    Start describing the behavior of this sort when a document doesn't have any value for the targeted field.

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

    filter, filter, filter

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

    toSort

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

    mode

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

    asc, desc, order

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

    then

  • Method Details

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