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

Interface PropertyMappingDocumentIdOptionsStep

All Superinterfaces:

PropertyMappingStep

public interface PropertyMappingDocumentIdOptionsStep
extends PropertyMappingStep

The step in a property-to-document-ID mapping where optional parameters can be set.

Method Summary

Modifier and Type	Method	Description
default PropertyMappingDocumentIdOptionsStep	identifierBinder(IdentifierBinder binder)	Define an identifier binder, responsible for creating a bridge.
PropertyMappingDocumentIdOptionsStep	identifierBinder(IdentifierBinder binder, Map<String,Object> params)	Define an identifier binder, responsible for creating a bridge.
PropertyMappingDocumentIdOptionsStep	identifierBridge(Class<? extends IdentifierBridge<?>> bridgeClass)
PropertyMappingDocumentIdOptionsStep	identifierBridge(BeanReference<? extends IdentifierBridge<?>> bridgeReference)
default PropertyMappingDocumentIdOptionsStep	identifierBridge(IdentifierBridge<?> 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

Method Detail

identifierBridge

PropertyMappingDocumentIdOptionsStep identifierBridge(Class<? extends IdentifierBridge<?>> bridgeClass)

Parameters:

bridgeClass - The class of the bridge to use.

Returns:

this, for method chaining.

See Also:

IdentifierBridge

identifierBridge

PropertyMappingDocumentIdOptionsStep identifierBridge(BeanReference<? extends IdentifierBridge<?>> 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:

IdentifierBridge

identifierBridge

default PropertyMappingDocumentIdOptionsStep identifierBridge(IdentifierBridge<?> bridgeInstance)

Parameters:

bridgeInstance - A bridge instance to use.

Returns:

this, for method chaining.

See Also:

IdentifierBridge

identifierBinder

default PropertyMappingDocumentIdOptionsStep identifierBinder(IdentifierBinder binder)

Define an identifier binder, responsible for creating a bridge. To pass some parameters to the bridge, use the method identifierBinder(IdentifierBinder, Map) instead.

Parameters:

binder - A IdentifierBinder responsible for creating a bridge.

Returns:

this, for method chaining.

See Also:

IdentifierBinder

identifierBinder

PropertyMappingDocumentIdOptionsStep identifierBinder(IdentifierBinder binder,
                                                      Map<String,Object> params)

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

Parameters:

binder - A IdentifierBinder responsible for creating a bridge.

params - The parameters to pass to the binder.

Returns:

this, for method chaining.

See Also:

IdentifierBinder