Annotation Interface SearchExclude

@Target({ANNOTATION_TYPE,METHOD,FIELD,TYPE}) @Retention(RUNTIME) @Inherited @Documented public @interface SearchExclude
Marker annotation that indicates that a property is to be ignored when indexing a document for text search.

When a property is ignored, the document can't be matched using this property. More specifically, the property is ignored by MatchConstraint, LookAheadConstraint, ContainsConstraint, and QueryConstraint. I.e. if the property is also marked with @Facet, it can still be matched using a FacetConstraint. Matching using BetweenConstraint or ExistsConstraint is also not affected.

When this annotation is present on a type, all properties of the class will be ignored when indexing, unless they are individually annotated with SearchExclude(false) or SearchInclude.

Note that the property is not lost when the document is serialized or deserialized. If that is the intention, make the property transient instead, e.g. using an annotation like Transient or JsonIgnore.

Subclasses can re-enable indexing by specifying a value() of false on the overridden property or class.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    value
    Optional argument that defines whether this annotation is active (true) or not (false).

  • Element Details

    • value

      boolean value
      Optional argument that defines whether this annotation is active (true) or not (false).
      Default:
      true