org.hibernate.search.mapper.pojo.bridge

Interface IdentifierBridge<I>

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

IdentifierBridgeRef.UndefinedBridgeImplementationType

public interface IdentifierBridge<I>
extends AutoCloseable

A bridge between a POJO property of type I and a document identifier.

Author:

Yoann Rodiere

Method Summary

Modifier and Type	Method and Description
default void	bind(IdentifierBridgeBindingContext<I> context) Bind this bridge instance to the given context, i.e.
I	cast(Object value) Cast an input value to the expected type I.
default void	close() Close any resource before the bridge is discarded.
I	fromDocumentIdentifier(String documentIdentifier, IdentifierBridgeFromDocumentIdentifierContext context) Transform the given document identifier value back to the value of the POJO property.
default boolean	isCompatibleWith(IdentifierBridge<?> other)
String	toDocumentIdentifier(I propertyValue, IdentifierBridgeToDocumentIdentifierContext context) Transform the given POJO property value to the value of the document identifier.

Method Detail

bind

default void bind(IdentifierBridgeBindingContext<I> context)

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

This method is called exactly once for each bridge instance, before any other method. It allows the bridge to check the type of bridged elements using IdentifierBridgeBindingContext.getBridgedElement().

Parameters:

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

toDocumentIdentifier

String toDocumentIdentifier(I propertyValue,
                            IdentifierBridgeToDocumentIdentifierContext context)

Transform the given POJO property value to the value of the document identifier.

Must return a unique value for each value of propertyValue

Parameters:

propertyValue - The POJO property value to be transformed.

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

Returns:

The value of the document identifier.

fromDocumentIdentifier

I fromDocumentIdentifier(String documentIdentifier,
                         IdentifierBridgeFromDocumentIdentifierContext context)

Transform the given document identifier value back to the value of the POJO property.

Must be the exact inverse function of toDocumentIdentifier(Object, IdentifierBridgeToDocumentIdentifierContext), i.e. object.equals(fromDocumentIdentifier(toDocumentIdentifier(object, sessionContext))) must always be true.

Parameters:

documentIdentifier - The document identifier value to be transformed.

context - A sessionContext 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 value of the document identifier.

cast

I cast(Object value)

Cast an input value to the expected type I.

Called for values passed to the predicate DSL in particular.

Parameters:

value - The value to convert.

Returns:

The checked value.

Throws:

RuntimeException - If the value does not match the expected type.

isCompatibleWith

default boolean isCompatibleWith(IdentifierBridge<?> other)

close

default void close()

Close any resource before the bridge is discarded.

Specified by:

close in interface AutoCloseable