org.hibernate.search.mapper.pojo.bridge

Interface PropertyBridge

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

PropertyBridgeRef.UndefinedBridgeImplementationType

public interface PropertyBridge
extends AutoCloseable

A bridge between a POJO property and an element of the index schema.

The PropertyBridge interface is a more powerful version of ValueBridge that can use reflection to get information about the property being bridged, and can contribute more than one index field, in particular.

Author:

Yoann Rodiere

Method Summary

Modifier and Type	Method and Description
void	bind(PropertyBridgeBindingContext context) Bind this bridge instance to the given context, i.e.
default void	close() Close any resource before the bridge is discarded.
void	write(DocumentElement target, Object bridgedElement, PropertyBridgeWriteContext context) Write to fields in the given DocumentElement, using the given bridgedElement as input and transforming it as necessary.

Method Detail

bind

void bind(PropertyBridgeBindingContext context)

Bind this bridge instance to the given context, i.e. to an object property in the POJO model and to an element in the index schema.

This method is called exactly once for each bridge instance, before any other method. It allows the bridge to:

• Declare its expectations regarding the index schema (field names and field types, storage options, ...) and retrieve references to the index fields that will later be used in the write(DocumentElement, Object, PropertyBridgeWriteContext) method using PropertyBridgeBindingContext.getIndexSchemaElement().
• Check the type of bridged elements using PropertyBridgeBindingContext.getBridgedElement().
• Declare its dependencies, i.e. the properties that will later be used in the write(DocumentElement, Object, PropertyBridgeWriteContext) method using PropertyBridgeBindingContext.getDependencies().
• Optionally (advanced use) use reflection to retrieve accessors to the bridged element that will later be used in the write(DocumentElement, Object, PropertyBridgeWriteContext) method using PropertyBridgeBindingContext.getBridgedElement().

Parameters:

context - An entry point allowing to perform the operations listed above.

write

void write(DocumentElement target,
           Object bridgedElement,
           PropertyBridgeWriteContext context)

Write to fields in the given DocumentElement, using the given bridgedElement as input and transforming it as necessary.

Writing to the DocumentElement should be done using IndexFieldReferences retrieved when the bind(PropertyBridgeBindingContext) method was called.

Warning: Reading from bridgedElement should be done with care. Any read that was not declared in the bind(PropertyBridgeBindingContext) method (by declaring dependencies using PropertyBridgeBindingContext.getDependencies() or (advanced use) creating an accessor using PropertyBridgeBindingContext.getBridgedElement()) may lead to out-of-sync indexes, because Hibernate Search will consider the read property irrelevant to indexing and will not reindex entities when that property changes.

Parameters:

target - The DocumentElement to write to.

bridgedElement - The element this bridge is applied to, from which data should be read.

context - A context that can be extended

close

default void close()

Close any resource before the bridge is discarded.

Specified by:

close in interface AutoCloseable