Package org.infinispan.api.annotations.indexing

Annotation Interface Indexed

@Documented @Target(TYPE) @Retention(RUNTIME) @TypeMapping(processor=@TypeMappingAnnotationProcessorRef(type=IndexedProcessor.class,retrieval=CONSTRUCTOR)) public @interface Indexed
Maps an entity type to an index.

Simplified version for Infinispan of Indexed

Since:
14.0

  • Element Details

    • index

      String index
      Returns:
      The name of the index. Defaults to the entity name.
      Default:
      ""

    • enabled

      boolean enabled
      Returns:
      true to map the type to an index (the default), false to disable the mapping to an index. Useful to disable indexing when subclassing an indexed type.
      Default:
      true

    • keyEntity

      String keyEntity
      Enables indexes / queries by keys.
      Returns:
      The fully qualified name of the type of entities used as keys
      Default:
      ""

    • keyPropertyName

      String keyPropertyName
      Used only if keyEntity() is provided.
      Returns:
      The property name to use in the queries to indicate the key of the entry
      Default:
      "key"

    • keyIncludeDepth

      int keyIncludeDepth
      Used only if keyEntity() is provided.
      Returns:
      The number of levels of indexed-key that will have all their fields included by default. By default, three levels will be included.
      See Also:
      Default:
      3