org.hibernate.search.annotations.IndexedEmbedded Maven / Gradle / Ivy
Show all versions of hibernate-search-v5migrationhelper-engine Show documentation
/*
* SPDX-License-Identifier: Apache-2.0
* Copyright Red Hat Inc. and Hibernate Authors
*/
package org.hibernate.search.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.hibernate.search.annotations.impl.IndexedEmbeddedAnnotationProcessor;
import org.hibernate.search.engine.environment.bean.BeanRetrieval;
import org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.PropertyMapping;
import org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.PropertyMappingAnnotationProcessorRef;
/**
* Specifies that an association ({@code @*To*}, {@code @Embedded}, {@code @CollectionOfEmbedded}) is to be indexed in
* the root entity index. This allows queries involving associated objects properties.
*
* @deprecated Use Hibernate Search 6's {@link org.hibernate.search.mapper.pojo.mapping.definition.annotation.IndexedEmbedded}
* instead.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD, ElementType.METHOD })
@Documented
@Deprecated
@PropertyMapping(processor = @PropertyMappingAnnotationProcessorRef(type = IndexedEmbeddedAnnotationProcessor.class,
retrieval = BeanRetrieval.CONSTRUCTOR))
public @interface IndexedEmbedded {
/**
* Field name prefix.
*
* @return the field name prefix. Default to ".", indicating that {@code propertyname.} will be used.
*/
String prefix() default ".";
/**
* List which paths of the object graph should be included
* in the index, and need to match the field names used to store them in the index, so they will
* also match the field names used to specify full text queries.
*
* Defined paths are going to be indexed even if they exceed the {@code depth} threshold.
* When {@code includePaths} is not empty, the default value for {@code depth} is 0.
*
* Defined paths are implicitly prefixed with the {@link IndexedEmbedded#prefix()}.
*
* @return the paths to include. Default to empty array
*/
String[] includePaths() default { };
/**
* Stop indexing embedded elements when {@code depth} is reached.
* {@code depth=1} means the associated element is indexed, but not its embedded elements.
*
*
The default value depends on the value of the {@code includePaths} attribute: if no paths
* are defined, the default is {@code Integer.MAX_VALUE}; if any {@code includePaths} are
* defined, the default {@code depth} is interpreted as 0 if not specified to a different value
* than it's default.
*
* Note that when defining any path to the {@code includePaths} attribute the default is zero also
* when explicitly set to {@code Integer.MAX_VALUE}.
*
* @return the depth size. Default value is {@link Integer#MAX_VALUE}
*/
int depth() default Integer.MAX_VALUE;
/**
* Overrides the target type of an association, in case a collection overrides the type of the collection generics.
* @return the target type of the association. Default to {@code void.class}
*/
Class targetElement() default void.class;
/**
* Returns {@code true}, if the id of the embedded object should be included into the index,
* {@code false} otherwise. The default is {@code false}.
*
* Note
:
* If the id property is explicitly listed via {@link #includePaths()}, then the id is included even if this value
* is {@code false}.
*
*
* @return Returns {@code true}, if the id of the embedded object should be included into the index,
* {@code false} otherwise.
*/
boolean includeEmbeddedObjectId() default false;
}