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

Class DefaultStringConverters.Converter<F>

java.lang.Object

org.hibernate.search.engine.backend.types.converter.spi.DefaultStringConverters.Converter<F>

All Implemented Interfaces:

FromDocumentValueConverter<F,String>, ToDocumentValueConverter<String,F>

Enclosing class:

DefaultStringConverters

public static class DefaultStringConverters.Converter<F>
extends Object
implements ToDocumentValueConverter<String,F>, FromDocumentValueConverter<F,String>

Method Summary

Modifier and Type	Method	Description
String	fromDocumentValue(F value, FromDocumentValueConvertContext context)
boolean	isCompatibleWith(ToDocumentValueConverter<?,?> other)
F	toDocumentValue(String value, ToDocumentValueConvertContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.engine.backend.types.converter.FromDocumentValueConverter

isCompatibleWith

Method Details

toDocumentValue

public F toDocumentValue(String value,
 ToDocumentValueConvertContext context)

Specified by:

toDocumentValue in interface ToDocumentValueConverter<String,F>

Parameters:

value - The source value to convert to the document model.

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(ToDocumentValueConverter<?,?> other)

Specified by:

isCompatibleWith in interface ToDocumentValueConverter<String,F>

Parameters:

other - Another ToDocumentValueConverter, never null.

Returns:

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

fromDocumentValue

public String fromDocumentValue(F value,
 FromDocumentValueConvertContext context)

Specified by:

fromDocumentValue in interface FromDocumentValueConverter<F,String>

Parameters:

value - The value to convert from the document model.

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