ScaledNumberIndexFieldTypeOptionsStep (Hibernate Search 6.0.11.Final)

Type Parameters:

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

F - The type of field values.

All Superinterfaces:

IndexFieldTypeConverterStep<S,F>, IndexFieldTypeFinalStep<F>, IndexFieldTypeOptionsStep<S,F>, StandardIndexFieldTypeOptionsStep<S,F>
```
public interface ScaledNumberIndexFieldTypeOptionsStep<S extends ScaledNumberIndexFieldTypeOptionsStep<?,F>,F>
extends StandardIndexFieldTypeOptionsStep<S,F>
```
The initial and final step in a "scaled number" index field type definition, where optional parameters can be set.

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  S decimalScale(int decimalScale)
  - Methods inherited from interface org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeConverterStep
    dslConverter, projectionConverter
  - Methods inherited from interface org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeFinalStep
    toIndexFieldType
  - Methods inherited from interface org.hibernate.search.engine.backend.types.dsl.StandardIndexFieldTypeOptionsStep
    aggregable, indexNullAs, projectable, searchable, sortable

- Method Detail
  - decimalScale
```
S decimalScale(int decimalScale)
```
    Parameters:
    
    decimalScale - How the scale of values should be adjusted before indexing as a fixed-precision integer. A positive decimalScale will shift the decimal point to the right before rounding to the nearest integer and indexing, effectively retaining that many after the decimal place in the index, Since numbers are indexed with a fixed number of bits, this increase in precision also means that the maximum value that can be indexed will be smaller. A negative decimalScale will shift the decimal point to the left before rounding to the nearest integer and indexing, effectively setting that many of the smaller digits to zero in the index. Since numbers are indexed with a fixed number of bits, this decrease in precision also means that the maximum value that can be indexed will be larger.
    
    Returns:
    
    this, for method chaining.