Package io.quarkus.hibernate.search.standalone.elasticsearch.runtime

Enum Class MappingStructure

java.lang.Object

java.lang.Enum<MappingStructure>

io.quarkus.hibernate.search.standalone.elasticsearch.runtime.MappingStructure

All Implemented Interfaces:

Serializable, Comparable<MappingStructure>, Constable

public enum MappingStructure
extends Enum<MappingStructure>

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
DOCUMENT	Entities indexed through Hibernate Search are the root of a document.
GRAPH	Entities indexed through Hibernate Search are nodes in an entity graph.

Method Summary

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

GRAPH

public static final MappingStructure GRAPH

Entities indexed through Hibernate Search are nodes in an entity graph. With this structure: * An indexed entity is independent of other entities it references through associations, which *can* be updated independently of the indexed entity; in particular they may be passed to SearchIndexingPlan.addOrUpdate(Object). * Therefore, when an entity changes, Hibernate Search may need to resolve other entities to reindex, which means in particular that associations between entities must be bi-directional: specifying the inverse side of associations through `@AssociationInverseSide` *is required*, unless reindexing is disabled for that association through `@IndexingDependency(reindexOnUpdate = ...)`. See also link:{hibernate-search-docs-url}#mapping-reindexing-associationinverseside[`@AssociationInverseSide`] link:{hibernate-search-docs-url}#mapping-reindexing-reindexonupdate[`@IndexingDependency(reindexOnUpdate = ...)`].

DOCUMENT

public static final MappingStructure DOCUMENT

Entities indexed through Hibernate Search are the root of a document. With this structure: * An indexed entity "owns" other entities it references through associations, which *cannot* be updated independently of the indexed entity; in particular they cannot be passed to SearchIndexingPlan.addOrUpdate(Object). * Therefore, when an entity changes, Hibernate Search doesn't need to resolve other entities to reindex, which means in particular that associations between entities can be uni-directional: specifying the inverse side of associations through `@AssociationInverseSide` *is not required*. See also link:{hibernate-search-docs-url}#mapping-reindexing-associationinverseside[`@AssociationInverseSide`].

Method Details

values

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