Package org.infinispan.api.annotations.indexing.option

Enum Class Structure

java.lang.Object

java.lang.Enum<Structure>

org.infinispan.api.annotations.indexing.option.Structure

All Implemented Interfaces:

Serializable, Comparable<Structure>, Constable

public enum Structure
extends Enum<Structure>

Defines how the structure of an object field is preserved upon indexing.

Simplified version for Infinispan of ObjectStructure

Since:

14.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FLATTENED	Flatten multi-valued object fields.
NESTED	Store object fields as nested documents.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FLATTENED

public static final Structure FLATTENED

Flatten multi-valued object fields.

This structure is generally more efficient, but has the disadvantage of dropping the original structure by making the leaf fields multi-valued instead of the object fields.

NESTED

public static final Structure NESTED

Store object fields as nested documents.

This structure is generally less efficient, but has the advantage of preserving the original structure. Note however that access to that information when querying requires special care.

Method Details

values

public static Structure[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Structure valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null