FieldSortMissingValueBehaviorStep (Hibernate Search Engine 6.0.0.Beta1 API)

Type Parameters:

N - The type of the next step (returned by first(), for example).
```
public interface FieldSortMissingValueBehaviorStep<N>
```
The step in a sort definition where the behavior on missing values can be set.

Author:

Emmanuel Bernard emmanuel@hibernate.org

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`N`	`first()` Put documents with missing values first in the sorting.
`N`	`last()` Put documents with missing values last in the sorting.
`default N`	`sortFirst()` Deprecated. Use `first()` instead.
`default N`	`sortLast()` Deprecated. Use `last()` instead.
`default N`	`use(Object value)` When documents are missing a value on the sort field, use the given value instead.
`N`	`use(Object value, ValueConvert convert)` When documents are missing a value on the sort field, use the given value instead.

- Method Detail
  - last
```
N last()
```
    Put documents with missing values last in the sorting.
    This instruction is independent of whether the sort is being ascending or descending.
    
    Returns:
    
    The next step.
  - sortLast
```
@Deprecated
default N sortLast()
```
    Deprecated. Use last() instead.
    
    Returns:
    
    The next step.
  - first
```
N first()
```
    Put documents with missing values first in the sorting.
    This instruction is independent of whether the sort is being ascending or descending.
    
    Returns:
    
    The next step.
  - sortFirst
```
@Deprecated
default N sortFirst()
```
    Deprecated. Use first() instead.
    
    Returns:
    
    The next step.
  - use
```
default N use(Object value)
```
    When documents are missing a value on the sort field, use the given value instead.
    This method will apply DSL converters to value before Hibernate Search attempts to interpret it as a field value. See ValueConvert.YES.
    
    Parameters:
    
    value - The value to use as a default when a document is missing a value on the sort field.
    
    Returns:
    
    The next step.
    
    Throws:
    
    SearchException - If the field is not numeric.
  - use
```
N use(Object value,
      ValueConvert convert)
```
    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.
    
    convert - Controls how the value should be converted before Hibernate Search attempts to interpret it as a field value. See ValueConvert.
    
    Returns:
    
    The next step.
    
    Throws:
    
    SearchException - If the field is not numeric.

Interface FieldSortMissingValueBehaviorStep<N>

Method Summary

Method Detail

last

sortLast

first

sortFirst

use

use