DistanceToFieldProjectionOptionsStep (Red Hat JBoss Enterprise Application Platform 8.0.0.GA public API)

Type Parameters:

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

T - The type of projected distances.

All Superinterfaces:

ProjectionFinalStep<T>

All Known Subinterfaces:

DistanceToFieldProjectionValueStep<N,T>

All Known Implementing Classes:

DistanceToFieldProjectionOptionsStepImpl, DistanceToFieldProjectionValueStepImpl
```
public interface DistanceToFieldProjectionOptionsStep<S extends DistanceToFieldProjectionOptionsStep<?,T>,T>
extends ProjectionFinalStep<T>
```
The initial and final step in a "distance to field" projection definition, where optional parameters can be set.

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  S unit(DistanceUnit unit)
  Defines the unit of the computed distance (default is meters).
  - Methods inherited from interface org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep
    toProjection

- Method Detail
  - unit
```
S unit(DistanceUnit unit)
```
    Defines the unit of the computed distance (default is meters).
    
    Parameters:
    
    unit - The unit.
    
    Returns:
    
    this, for method chaining.