org.hibernate.search.mapper.pojo.mapping.definition.programmatic

Interface PropertyMappingFieldOptionsStep<S extends PropertyMappingFieldOptionsStep<?>>

Type Parameters:

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

All Superinterfaces:

PropertyMappingStep

All Known Subinterfaces:

PropertyMappingFullTextFieldOptionsStep, PropertyMappingGenericFieldOptionsStep, PropertyMappingKeywordFieldOptionsStep, PropertyMappingNonFullTextFieldOptionsStep<S>, PropertyMappingScaledNumberFieldOptionsStep

public interface PropertyMappingFieldOptionsStep<S extends PropertyMappingFieldOptionsStep<?>>
extends PropertyMappingStep

The step in a property-to-index-field mapping where optional parameters can be set.

Method Summary

Modifier and Type	Method and Description
S	projectable(Projectable projectable)
S	searchable(Searchable searchable)
S	valueBinder(ValueBinder binder)
S	valueBridge(BeanReference<? extends ValueBridge<?,?>> bridgeReference)
S	valueBridge(Class<? extends ValueBridge<?,?>> bridgeClass)
default S	withExtractor(String extractorName)
S	withExtractors(ContainerExtractorPath extractorPath)
default S	withoutExtractors() Indicates that no container extractors should be applied, not even the default ones.

Methods inherited from interface org.hibernate.search.mapper.pojo.mapping.definition.programmatic.PropertyMappingStep

associationInverseSide, binder, bridge, bridge, documentId, fullTextField, fullTextField, genericField, genericField, indexedEmbedded, indexingDependency, keywordField, keywordField, marker, property, scaledNumberField, scaledNumberField

Method Detail

projectable

S projectable(Projectable projectable)

Parameters:

projectable - Whether projections are enabled for this field.

Returns:

this, for method chaining.

See Also:

GenericField.projectable(), Projectable

searchable

S searchable(Searchable searchable)

Parameters:

searchable - Whether this field should be searchable.

Returns:

this, for method chaining.

See Also:

GenericField.searchable(), Searchable

valueBridge

S valueBridge(Class<? extends ValueBridge<?,?>> bridgeClass)

Parameters:

bridgeClass - The class of the bridge to use.

Returns:

this, for method chaining.

See Also:

GenericField.valueBridge()

valueBridge

S valueBridge(BeanReference<? extends ValueBridge<?,?>> bridgeReference)

Parameters:

bridgeReference - A BeanReference pointing to the bridge to use. See the static "ofXXX()" methods of BeanReference for details about the various type of references (by name, by type, ...).

Returns:

this, for method chaining.

See Also:

GenericField.valueBridge()

valueBinder

S valueBinder(ValueBinder binder)

Parameters:

binder - A ValueBinder responsible for creating a bridge.

Returns:

this, for method chaining.

See Also:

GenericField.valueBinder(), ValueBinder

withExtractor

default S withExtractor(String extractorName)

Parameters:

extractorName - The name of the container extractor to use.

Returns:

this, for method chaining.

See Also:

GenericField.extraction(), BuiltinContainerExtractors

withoutExtractors

default S withoutExtractors()

Indicates that no container extractors should be applied, not even the default ones.

Returns:

this, for method chaining.

See Also:

GenericField.extraction()

withExtractors

S withExtractors(ContainerExtractorPath extractorPath)

Parameters:

extractorPath - A ContainerExtractorPath.

Returns:

this, for method chaining.

See Also:

GenericField.extraction(), ContainerExtractorPath