Package org.hibernate.search.engine.backend.types.converter.spi

Interface ToDocumentIdentifierValueConverter<I>

Type Parameters:

I - The type of source identifier values.

All Known Implementing Classes:

StringToDocumentIdentifierValueConverter

public interface ToDocumentIdentifierValueConverter<I>

A converter from a source identifier value to a target value that should be used as a document identifier.

Method Summary

Modifier and Type	Method	Description
String	convert(I value, ToDocumentIdentifierValueConvertContext context)
String	convertUnknown(Object value, ToDocumentIdentifierValueConvertContext context)	Convert an input value of unknown type that may not have the required type I.
default boolean	isCompatibleWith(ToDocumentIdentifierValueConverter<?> other)

Method Detail

convert

String convert(I value,
               ToDocumentIdentifierValueConvertContext context)

Parameters:

value - The source value to convert.

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 converted index field value.

convertUnknown

String convertUnknown(Object value,
                      ToDocumentIdentifierValueConvertContext context)

Convert an input value of unknown type that may not have the required type I.

Called when passing values to the predicate DSL in particular.

Parameters:

value - The source value to convert.

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 converted index field value.

isCompatibleWith

default boolean isCompatibleWith(ToDocumentIdentifierValueConverter<?> other)

Parameters:

other - Another ToDocumentIdentifierValueConverter, never null.

Returns:

true if the given object behaves exactly the same as this object, i.e. its convertUnknown(Object, ToDocumentIdentifierValueConvertContext) method is guaranteed to always return the same value as this object's when given the same input. false otherwise, or when in doubt.