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

Interface FieldSortMissingValueContext<N>

Type Parameters:

N - The type of the next context (returned by sortFirst(), for example).

public interface FieldSortMissingValueContext<N>

The context used when defining the missing value behavior of a field sort.

Author:

Emmanuel Bernard emmanuel@hibernate.org, Yoann Rodiere

Method Summary

Modifier and Type	Method and Description
N	sortFirst() Put documents with missing values first in the sorting.
N	sortLast() Put documents with missing values last in the sorting.
N	use(Object value) When documents are missing a value on the sort field, use the given value instead.

Method Detail

sortLast

N sortLast()

Put documents with missing values last in the sorting.

This instruction is independent of whether the sort is being ascending or descending.

Returns:

The original context, for method chaining.

sortFirst

N sortFirst()

Put documents with missing values first in the sorting.

This instruction is independent of whether the sort is being ascending or descending.

Returns:

The original context, for method chaining.

use

N use(Object value)

When documents are missing a value on the sort field, use the given value instead.

Parameters:

value - The value to use as a default when a document is missing a value on the sort field.

Returns:

The original context, for method chaining.

Throws:

SearchException - If the field is not numeric.