org.hibernate.search.engine.backend.types.dsl

Interface StandardIndexFieldTypeOptionsStep<S extends StandardIndexFieldTypeOptionsStep<?,F>,F>

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>

All Known Subinterfaces:

ScaledNumberIndexFieldTypeOptionsStep<S,F>, StringIndexFieldTypeOptionsStep<S>

public interface StandardIndexFieldTypeOptionsStep<S extends StandardIndexFieldTypeOptionsStep<?,F>,F>
extends IndexFieldTypeOptionsStep<S,F>

The initial and final step in a "standard" index field type definition, where optional parameters can be set.

"Standard" index field types are types exposing a common set capabilities that are considered "standard", such as search or projection.

Method Summary

Modifier and Type	Method and Description
S	aggregable(Aggregable aggregable)
S	indexNullAs(F indexNullAs)
S	projectable(Projectable projectable)
S	searchable(Searchable searchable)
S	sortable(Sortable sortable)

Methods inherited from interface org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeFinalStep

toIndexFieldType

Methods inherited from interface org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeConverterStep

dslConverter, projectionConverter

Method Detail

projectable

S projectable(Projectable projectable)

Parameters:

projectable - Whether projections are enabled for this field.

Returns:

this, for method chaining.

See Also:

Projectable

sortable

S sortable(Sortable sortable)

Parameters:

sortable - Whether this field should be sortable.

Returns:

this, for method chaining.

See Also:

Sortable

indexNullAs

S indexNullAs(F indexNullAs)

Parameters:

indexNullAs - A value used instead of null values when indexing.

Returns:

this, for method chaining.

searchable

S searchable(Searchable searchable)

Parameters:

searchable - Whether this field should be searchable.

Returns:

this, for method chaining.

See Also:

Searchable

aggregable

S aggregable(Aggregable aggregable)

Parameters:

aggregable - Whether aggregations are enabled for this field.

Returns:

this, for method chaining.

See Also:

Aggregable