Package 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, PropertyMappingStandardFieldOptionsStep<S>, PropertyMappingVectorFieldOptionsStep

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	Description
default S	extractor(String extractorName)
S	extractors(ContainerExtractorPath extractorPath)
default S	noExtractors()	Indicates that no container extractors should be applied, not even the default ones.
default S	valueBinder(ValueBinder binder)	Define a value binder, responsible for creating a bridge.
S	valueBinder(ValueBinder binder, Map<String,Object> params)	Define a value binder, responsible for creating a bridge.
S	valueBridge(Class<? extends ValueBridge<?,?>> bridgeClass)
S	valueBridge(BeanReference<? extends ValueBridge<?,?>> bridgeReference)
default S	valueBridge(ValueBridge<?,?> bridgeInstance)

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

associationInverseSide, binder, binder, documentId, fullTextField, fullTextField, genericField, genericField, hostingType, indexedEmbedded, indexedEmbedded, indexingDependency, keywordField, keywordField, marker, marker, nonStandardField, nonStandardField, scaledNumberField, scaledNumberField, vectorField, vectorField, vectorField, vectorField

Method Details

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()

valueBridge

default S valueBridge(ValueBridge<?,?> bridgeInstance)

Parameters:

bridgeInstance - The bridge instance to use.

Returns:

this, for method chaining.

See Also:

• GenericField.valueBridge()

valueBinder

default S valueBinder(ValueBinder binder)

Define a value binder, responsible for creating a bridge. To pass some parameters to the bridge, use the method valueBinder(ValueBinder, Map) instead.

Parameters:

binder - A ValueBinder responsible for creating a bridge.

Returns:

this, for method chaining.

See Also:

• GenericField.valueBinder()
• ValueBinder

valueBinder

S valueBinder(ValueBinder binder,
 Map<String,Object> params)

Define a value binder, responsible for creating a bridge. With this method it is possible to pass a set of parameters to the binder.

Parameters:

binder - A ValueBinder responsible for creating a bridge.

params - The parameters to pass to the binder.

Returns:

this, for method chaining.

See Also:

• ValueBinder

extractor

default S extractor(String extractorName)

Parameters:

extractorName - The name of the container extractor to use.

Returns:

this, for method chaining.

See Also:

• GenericField.extraction()
• BuiltinContainerExtractors

noExtractors

default S noExtractors()

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

Returns:

this, for method chaining.

See Also:

• GenericField.extraction()

extractors

S extractors(ContainerExtractorPath extractorPath)

Parameters:

extractorPath - A ContainerExtractorPath.

Returns:

this, for method chaining.

See Also:

• GenericField.extraction()
• ContainerExtractorPath