Package org.hibernate.search.mapper.pojo.bridge

Interface RoutingKeyBridge

All Superinterfaces:

AutoCloseable

public interface RoutingKeyBridge
extends AutoCloseable

A bridge from a POJO entity to a document routing key.

Method Summary

Modifier and Type	Method	Description
default void	close()	Close any resource before the bridge is discarded.
String	toRoutingKey(String tenantIdentifier, Object entityIdentifier, Object bridgedElement, RoutingKeyBridgeToRoutingKeyContext context)	Generate a routing key using the given tenantIdentifier, entityIdentifier and bridgedElement as input and transforming them as necessary.

Method Detail

toRoutingKey

String toRoutingKey(String tenantIdentifier,
                    Object entityIdentifier,
                    Object bridgedElement,
                    RoutingKeyBridgeToRoutingKeyContext context)

Generate a routing key using the given tenantIdentifier, entityIdentifier and bridgedElement as input and transforming them as necessary.

Warning: Reading from bridgedElement should be done with care. Any read that was not declared during binding (by declaring dependencies using RoutingKeyBindingContext.dependencies() or (advanced use) creating an accessor using RoutingKeyBindingContext.bridgedElement()) 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:

tenantIdentifier - The tenant identifier currently in use (null if none).

entityIdentifier - The value of the POJO property used to generate the document identifier, i.e. the same value that was passed to IdentifierBridge.toDocumentIdentifier(Object, org.hibernate.search.mapper.pojo.bridge.runtime.IdentifierBridgeToDocumentIdentifierContext).

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

context - A context that can be extended to a more useful type, giving access to such things as a Hibernate ORM Session (if using the Hibernate ORM mapper).

Returns:

The resulting routing key. Never null.

close

default void close()

Close any resource before the bridge is discarded.

Specified by:

close in interface AutoCloseable