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

Interface TypeMappingStep

public interface TypeMappingStep

The step in a mapping definition where a type can be mapped, and where properties of that type can be referenced to map them more precisely.

Method Summary

Modifier and Type	Method and Description
TypeMappingStep	binder(TypeBinder<?> binder)
TypeMappingStep	bridge(BeanReference<? extends TypeBridge> bridgeReference)
TypeMappingStep	bridge(Class<? extends TypeBridge> bridgeClass)
TypeMappingStep	indexed() Maps an entity type to an index.
TypeMappingStep	indexed(String indexName) Maps an entity type to an index.
TypeMappingStep	indexed(String backendName, String indexName) Maps an entity type to an index.
PropertyMappingStep	property(String propertyName) Starts the definition of the mapping of a specific property.
TypeMappingStep	routingKeyBinder(RoutingKeyBinder<?> binder)
TypeMappingStep	routingKeyBridge(BeanReference<? extends RoutingKeyBridge> bridgeReference)
TypeMappingStep	routingKeyBridge(Class<? extends RoutingKeyBridge> bridgeClass)

Method Detail

indexed

TypeMappingStep indexed()

Maps an entity type to an index.

Returns:

this, for method chaining.

See Also:

Indexed

indexed

TypeMappingStep indexed(String indexName)

Maps an entity type to an index.

Parameters:

indexName - The name of the index.

Returns:

this, for method chaining.

See Also:

Indexed, Indexed.index()

indexed

TypeMappingStep indexed(String backendName,
                        String indexName)

Maps an entity type to an index.

Parameters:

backendName - The name of the backend.

indexName - The name of the index.

Returns:

this, for method chaining.

See Also:

Indexed, Indexed.backend(), Indexed.index()

routingKeyBridge

TypeMappingStep routingKeyBridge(Class<? extends RoutingKeyBridge> bridgeClass)

Parameters:

bridgeClass - The class of the bridge to use.

Returns:

this, for method chaining.

See Also:

RoutingKeyBridge

routingKeyBridge

TypeMappingStep routingKeyBridge(BeanReference<? extends RoutingKeyBridge> 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:

RoutingKeyBridge

routingKeyBinder

TypeMappingStep routingKeyBinder(RoutingKeyBinder<?> binder)

Parameters:

binder - A RoutingKeyBinder responsible for creating a bridge.

Returns:

this, for method chaining.

See Also:

RoutingKeyBinder

bridge

TypeMappingStep bridge(Class<? extends TypeBridge> bridgeClass)

Parameters:

bridgeClass - The class of the bridge to use.

Returns:

this, for method chaining.

See Also:

TypeBridge

bridge

TypeMappingStep bridge(BeanReference<? extends TypeBridge> 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:

TypeBridge

binder

TypeMappingStep binder(TypeBinder<?> binder)

Parameters:

binder - A TypeBinder responsible for creating a bridge.

Returns:

this, for method chaining.

See Also:

TypeBinder

property

PropertyMappingStep property(String propertyName)

Starts the definition of the mapping of a specific property.

Parameters:

propertyName - The name of a property in this type.

Returns:

A DSL step where the property mapping can be defined in more details.