Package io.jmix.search.index.annotation

Enum Class ReferenceAttributesIndexingMode

java.lang.Object

java.lang.Enum<ReferenceAttributesIndexingMode>

io.jmix.search.index.annotation.ReferenceAttributesIndexingMode

All Implemented Interfaces:

Serializable, Comparable<ReferenceAttributesIndexingMode>, Constable

public enum ReferenceAttributesIndexingMode
extends Enum<ReferenceAttributesIndexingMode>

Enum representing the indexing mode for reference attributes in an entity or data structure.

This enum is used to configure how reference attributes are handled during the indexing process.

It provides two modes:

• NONE: Disables indexing of reference attributes. No reference attribute values will be indexed.
• INSTANCE_NAME_ONLY: Indexes only the instance name of reference attributes. Useful for indexing a textual representative of a reference without considering the full details of the reference.

This enum is typically used in annotations or configurations related to indexing.

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
INSTANCE_NAME_ONLY
NONE

Method Summary

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

NONE

public static final ReferenceAttributesIndexingMode NONE

INSTANCE_NAME_ONLY

public static final ReferenceAttributesIndexingMode INSTANCE_NAME_ONLY

Method Details

values

public static ReferenceAttributesIndexingMode[] 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 ReferenceAttributesIndexingMode 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