Package org.hibernate.search.annotations

Annotation Type IndexedEmbedded

@Retention(RUNTIME) @Target({FIELD,METHOD}) @Documented @Deprecated @PropertyMapping(processor=@PropertyMappingAnnotationProcessorRef(type=org.hibernate.search.annotations.impl.IndexedEmbeddedAnnotationProcessor.class,retrieval=CONSTRUCTOR)) public @interface IndexedEmbedded
Deprecated.
Use Hibernate Search 6's IndexedEmbedded instead.
Specifies that an association (@*To*, @Embedded, @CollectionOfEmbedded) is to be indexed in the root entity index. This allows queries involving associated objects properties.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    depth
    Deprecated.
    Stop indexing embedded elements when depth is reached.
    boolean
    includeEmbeddedObjectId
    Deprecated.
    Returns true, if the id of the embedded object should be included into the index, false otherwise.
    String[]
    includePaths
    Deprecated.
    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.
    String
    prefix
    Deprecated.
    Field name prefix.
    Class<?>
    targetElement
    Deprecated.
    Overrides the target type of an association, in case a collection overrides the type of the collection generics.

  • Element Details

    • prefix

      String prefix
      Deprecated.
      Field name prefix.
      Returns:
      the field name prefix. Default to ".", indicating that propertyname. will be used.
      Default:
      "."

    • includePaths

      String[] includePaths
      Deprecated.

      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 depth threshold. When includePaths is not empty, the default value for depth is 0.

      Defined paths are implicitly prefixed with the prefix().

      Returns:
      the paths to include. Default to empty array
      Default:
      {}

    • depth

      int depth
      Deprecated.
      Stop indexing embedded elements when depth is reached. depth=1 means the associated element is indexed, but not its embedded elements.

      The default value depends on the value of the includePaths attribute: if no paths are defined, the default is Integer.MAX_VALUE; if any includePaths are defined, the default depth is interpreted as 0 if not specified to a different value than it's default.

      Note that when defining any path to the includePaths attribute the default is zero also when explicitly set to Integer.MAX_VALUE.

      Returns:
      the depth size. Default value is Integer.MAX_VALUE
      Default:
      2147483647

    • targetElement

      Class<?> targetElement
      Deprecated.
      Overrides the target type of an association, in case a collection overrides the type of the collection generics.
      Returns:
      the target type of the association. Default to void.class
      Default:
      void.class

    • includeEmbeddedObjectId

      boolean includeEmbeddedObjectId
      Deprecated.
      Returns true, if the id of the embedded object should be included into the index, false otherwise. The default is false.

      Note
      : If the id property is explicitly listed via includePaths(), then the id is included even if this value is false.

      Returns:
      Returns true, if the id of the embedded object should be included into the index, false otherwise.
      Default:
      false