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

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

routingKeyBinder

TypeMappingStep routingKeyBinder(RoutingKeyBinder binder)

Parameters:

binder - A RoutingKeyBinder responsible for creating a bridge.

Returns:

this, for method chaining.

See Also:

RoutingKeyBinder

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.