org.hibernate.search.engine.backend.document.model.dsl

Enum ObjectFieldStorage

java.lang.Object

java.lang.Enum<ObjectFieldStorage>

org.hibernate.search.engine.backend.document.model.dsl.ObjectFieldStorage

All Implemented Interfaces:

Serializable, Comparable<ObjectFieldStorage>

public enum ObjectFieldStorage
extends Enum<ObjectFieldStorage>

Defines the storage strategy for an object field.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Use the backend-specific default.
FLATTENED Flatten multi-valued object fields.
NESTED Store object fields as nested documents.

Method Summary

Modifier and Type	Method and Description
static ObjectFieldStorage	valueOf(String name) Returns the enum constant of this type with the specified name.
static ObjectFieldStorage[]	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

DEFAULT

public static final ObjectFieldStorage DEFAULT

Use the backend-specific default.

FLATTENED

public static final ObjectFieldStorage FLATTENED

Flatten multi-valued object fields.

This storage mode is generally more efficient, but has the disadvantage of losing structural information by making the leaf fields multi-valued instead of the object fields.

For instance this structure:

• firstName = Bruce
• lastName = Wayne
• sidekicks =
  • (first element)
    • firstName = Dick
    • lastName = Grayson
  • (second element)
    • firstName = Barbara
    • lastName = Gordon

Will be stored as:

• firstName = Bruce
• lastName = Wayne
• sidekicks.firstName =
  • (first element) Dick
  • (second element) Barbara
• sidekicks.lastName =
  • (first element) Grayson
  • (second element) Gordon

As a result, a search for sidekicks.firstname:Barbara AND sidekicks.lastname=Grayson would return the above document even though Barbara Grayson does not exist.

NESTED

public static final ObjectFieldStorage NESTED

Store object fields as nested documents.

This storage mode is generally less efficient, but has the advantage of keeping structural information. Note however that access to that information when querying requires special care. See in particular the "nested" predicate.

Method Detail

values

public static ObjectFieldStorage[] 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 (ObjectFieldStorage c : ObjectFieldStorage.values())
    System.out.println(c);

Returns:

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

valueOf

public static ObjectFieldStorage 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