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

Interface RoutingKeyBinder

All Known Implementing Classes:

RoutingKeyBinderRef.UndefinedBinderImplementationType

public interface RoutingKeyBinder

A binder from a POJO type to a routing key.

This binder takes advantage of provided metadata to pick, configure and create a RoutingKeyBridge.

See Also:

RoutingKeyBridge

Method Summary

Modifier and Type	Method and Description
void	bind(RoutingKeyBindingContext context) Binds a type to routing keys.

Method Detail

bind

void bind(RoutingKeyBindingContext context)

Binds a type to routing keys.

The context passed in parameter provides various information about the type being bound. Implementations are expected to take advantage of that information and to call one of the setBridge(...) methods on the context to set the bridge.

Implementations are also expected to declare dependencies, i.e. the properties that will later be used in the RoutingKeyBridge.toRoutingKey(String, Object, Object, RoutingKeyBridgeToRoutingKeyContext) method, using RoutingKeyBindingContext.getDependencies(). Failing that, Hibernate Search will not reindex entities properly when an indexed property is modified.

Parameters:

context - A context object providing information about the type being bound, and expecting a call to one of its setBridge(...) methods.