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

Interface TypeMappingIndexedStep

public interface TypeMappingIndexedStep

The step in a mapping definition where a type's indexing can be configured more precisely.

Method Summary

Modifier and Type	Method	Description
TypeMappingIndexedStep	backend(String backendName)
TypeMappingIndexedStep	enabled(boolean enabled)
TypeMappingIndexedStep	index(String indexName)
default TypeMappingIndexedStep	routingBinder(RoutingBinder binder)	Define a routing binder, responsible for creating a bridge.
TypeMappingIndexedStep	routingBinder(RoutingBinder binder, Map<String,Object> params)	Define a routing binder, responsible for creating a bridge.

Method Detail

backend

TypeMappingIndexedStep backend(String backendName)

Parameters:

backendName - The name of the backend.

Returns:

this, for method chaining.

See Also:

Indexed.backend()

index

TypeMappingIndexedStep index(String indexName)

Parameters:

indexName - The name of the index.

Returns:

this, for method chaining.

See Also:

Indexed.index()

enabled

TypeMappingIndexedStep enabled(boolean enabled)

Parameters:

enabled - true to map the type to an index (the default), false to disable the mapping to an index. Useful to disable indexing when subclassing an indexed type.

Returns:

this, for method chaining.

See Also:

Indexed.enabled()

routingBinder

default TypeMappingIndexedStep routingBinder(RoutingBinder binder)

Define a routing binder, responsible for creating a bridge. To pass some parameters to the bridge, use the method routingBinder(RoutingBinder, Map) instead.

Parameters:

binder - A RoutingBinder responsible for creating a bridge.

Returns:

this, for method chaining.

See Also:

Indexed.routingBinder()

routingBinder

TypeMappingIndexedStep routingBinder(RoutingBinder binder,
                                     Map<String,Object> params)

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

Parameters:

binder - A RoutingBinder responsible for creating a bridge.

params - The parameters to pass to the binder.

Returns:

this, for method chaining.

See Also:

Indexed.routingBinder()