Package io.jmix.search.index.annotation

Annotation Interface DynamicAttributes

@Target(METHOD) @Retention(RUNTIME) @Repeatable(Container.class) public @interface DynamicAttributes
Annotation for marking methods in index definition interfaces that define dynamic attributes to be indexed. This annotation is used to configure various indexing behavior for dynamic attributes.

Container Annotation: `DynamicAttributes.Container` is a repeatable container that allows multiple `DynamicAttributes` annotations to be used on a single method.

Usage: This annotation, along with its attributes, provides flexibility for indexing dynamic attributes while ensuring exclusion and indexing modes can be explicitly defined when needed.

See Also:

  • Element Details

    • excludeCategories

      String[] excludeCategories
      Specifies dynamic attribute categories to be excluded from indexing for the annotated method.
      Default:
      {}

    • excludeAttributes

      String[] excludeAttributes
      Specifies dynamic attributes to be excluded from indexing for the annotated method.
      Default:
      {}

    • referenceAttributesIndexingMode

      ReferenceAttributesIndexingMode referenceAttributesIndexingMode
      Determines the indexing mode for reference attributes associated with the annotated method. Allows configuration of how reference attributes are handled during indexing, such as whether reference values are indexed based on instance names or excluded completely. Defaults to INSTANCE_NAME_ONLY.
      Default:
      INSTANCE_NAME_ONLY

    • analyzer

      String analyzer
      Specifies the name of the analyzer to be used for processing textual content associated with the annotated method. An analyzer is responsible for breaking down text into tokens and applying text normalization rules to make the text searchable in a specific manner.
      Default:
      ""