Package org.hibernate.search.annotations

Annotation Type ClassBridge

@Retention(RUNTIME) @Target(TYPE) @Documented public @interface ClassBridge
This annotation allows a user to apply an implementation class to a Lucene document to manipulate it in any way the user sees fit.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<?>
    impl
    User supplied class to manipulate document in whatever mysterious ways they wish to.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Analyzer
    analyzer
    Define an analyzer for the field, default to the inherited analyzer.
    Boost
    boost
    A float value of the amount of Lucene defined boost to apply to a field.
    Index
    index
    Defines how the Field should be indexed defaults to tokenized.
    String
    name
    Field name, default to the JavaBean property name.
    Parameter[]
    params
    Array of fields to work with.
    Store
    store
    Should the value be stored in the document.
    TermVector
    termVector
    Define term vector storage requirements, default to NO.

  • Element Details

    • name

      String name
      Field name, default to the JavaBean property name.
      Default:
      ""

    • store

      Store store
      Should the value be stored in the document. defaults to no.
      Default:
      NO

    • analyzer

      Analyzer analyzer
      Define an analyzer for the field, default to the inherited analyzer.
      Default:
      @org.hibernate.search.annotations.Analyzer

    • index

      Index index
      Defines how the Field should be indexed defaults to tokenized.
      Default:
      TOKENIZED

    • termVector

      TermVector termVector
      Define term vector storage requirements, default to NO.
      Default:
      NO

    • boost

      Boost boost
      A float value of the amount of Lucene defined boost to apply to a field.
      Default:
      @org.hibernate.search.annotations.Boost(1.0f)

    • impl

      Class<?> impl
      User supplied class to manipulate document in whatever mysterious ways they wish to.

    • params

      Parameter[] params
      Array of fields to work with. The impl class above will work on these fields.
      Default:
      {}