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

Class StringToDocumentIdentifierValueConverter

java.lang.Object

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

All Implemented Interfaces:

ToDocumentIdentifierValueConverter<String>

public final class StringToDocumentIdentifierValueConverter
extends Object
implements ToDocumentIdentifierValueConverter<String>

Constructor Summary

Constructors

Constructor	Description
StringToDocumentIdentifierValueConverter()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringToDocumentIdentifierValueConverter

public StringToDocumentIdentifierValueConverter()

Method Detail

convert

public String convert(String value,
                      ToDocumentIdentifierValueConvertContext context)

Specified by:

convert in interface ToDocumentIdentifierValueConverter<String>

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

public String convertUnknown(Object value,
                             ToDocumentIdentifierValueConvertContext context)

Description copied from interface: ToDocumentIdentifierValueConverter

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.

Specified by:

convertUnknown in interface ToDocumentIdentifierValueConverter<String>

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

public boolean isCompatibleWith(ToDocumentIdentifierValueConverter<?> other)

Specified by:

isCompatibleWith in interface ToDocumentIdentifierValueConverter<String>

Parameters:

other - Another ToDocumentIdentifierValueConverter, never null.

Returns:

true if the given object behaves exactly the same as this object, i.e. its ToDocumentIdentifierValueConverter.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.