Package org.hibernate.search.engine.search.common

Enum ValueConvert

java.lang.Object

java.lang.Enum<ValueConvert>

org.hibernate.search.engine.search.common.ValueConvert

All Implemented Interfaces:

Serializable, Comparable<ValueConvert>

public enum ValueConvert
extends Enum<ValueConvert>

Specifies whether values should be converted during search queries.

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO	Disables value conversion.
YES	Enables value conversion.

Method Summary

Modifier and Type	Method	Description
static ValueConvert	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ValueConvert[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YES

public static final ValueConvert YES

Enables value conversion.

For field values passed to the DSL (for example the parameter of a match predicate), the DSL converter defined in the mapping will be used. This generally means values passed to the DSL will be expected to have the same type as the entity property used to populate the index field.

For identifier values passed to the DSL (for example the parameter of an ID predicate), the identifier converter defined in the mapping will be used. This generally means values passed to the DSL will be expected to have the same type as the entity property used to generate document identifiers.

For fields values returned by the backend (for example in projections), the projection converter defined in the mapping will be used. This generally means the projected values will have the same type as the entity property used to populate the index field.

If no converter was defined in the mapping, this option won't have any effect.

Please refer to the reference documentation for more information.

NO

public static final ValueConvert NO

Disables value conversion.

For field values passed to the DSL (for example the parameter of a match predicate), no converter will be used. This generally means values passed to the DSL will be expected to have the same type as the index field.

For identifier values passed to the DSL (for example the parameter of an ID predicate), no converter will be used. This means values passed to the DSL will be expected to be strings that match document identifiers exactly.

For fields values returned by the backend (for example in projections), no converter will be used. This generally means the projected values will have the same type as the index field.

Please refer to the reference documentation for more information.

Method Detail

values

public static ValueConvert[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ValueConvert c : ValueConvert.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ValueConvert valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null