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

Interface TypeBinder<A extends Annotation>

Type Parameters:

A - The type of annotations accepted by the initialize(Annotation) method.

All Known Subinterfaces:

GeoPointBinder

All Known Implementing Classes:

TypeBinderRef.UndefinedBinderImplementationType

public interface TypeBinder<A extends Annotation>

A binder from a POJO type to index fields.

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

See Also:

TypeBridge

Method Summary

Modifier and Type	Method and Description
void	bind(TypeBindingContext context) Binds a type to index fields.
default void	initialize(A annotation) Initializes the parameters of this binder with the attributes of the given annotation.

Method Detail

initialize

default void initialize(A annotation)

Initializes the parameters of this binder with the attributes of the given annotation.

Parameters:

annotation - An annotation to extract parameters from.

bind

void bind(TypeBindingContext context)

Binds a type to index fields.

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 TypeBridge.write(DocumentElement, Object, TypeBridgeWriteContext) method, using TypeBindingContext.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.