Module io.ebean.annotation
Package io.ebean.annotation

Annotation Type DocProperty

@Target(FIELD) @Retention(RUNTIME) public @interface DocProperty
Specify the entity type maps to a document store (like ElasticSearch).

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    DocProperty.Option
    Index options for a property.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    analyzer
    The analyzer to use.
    float
    boost
    Set a boost value specific to this property.
    boolean
    code
    Set this to true to indicate that this property should be un-analysed.
    String
    copyTo
    Set a copyTo field.
    boolean
    docValues
    Set this to false such that doc values are not stored separately for this property.
    boolean
    enabled
    Set to false to disable the field from indexing, it will only be get/set in _source.
    boolean
    includeInAll
    Set this to false to exclude this from the _all property.
    boolean
    norms
    Set to false such that norms are not stored.
    String
    nullValue
    Set a value to use instead of null.
    DocProperty.Option
    options
    The index options for this property.
    String
    searchAnalyzer
    The analyzer to use for searches.
    boolean
    sortable
    Set this to true to get an additional un-analysed 'raw' field to use for sorting etc.
    boolean
    store
    Set to true to have the property additionally stored separately from _source.

  • Element Details

    • code

      boolean code
      Set this to true to indicate that this property should be un-analysed.
      Default:
      false

    • sortable

      boolean sortable
      Set this to true to get an additional un-analysed 'raw' field to use for sorting etc.
      Default:
      false

    • store

      boolean store
      Set to true to have the property additionally stored separately from _source.
      Default:
      false

    • boost

      float boost
      Set a boost value specific to this property.
      Default:
      1.0f

    • nullValue

      String nullValue
      Set a value to use instead of null.
      Default:
      ""

    • includeInAll

      boolean includeInAll
      Set this to false to exclude this from the _all property.
      Default:
      true

    • analyzer

      String analyzer
      The analyzer to use.
      Default:
      ""

    • searchAnalyzer

      String searchAnalyzer
      The analyzer to use for searches.
      Default:
      ""

    • options

      DocProperty.Option options
      The index options for this property.
      Default:
      DEFAULT

    • docValues

      boolean docValues
      Set this to false such that doc values are not stored separately for this property.
      Default:
      true

    • copyTo

      String copyTo
      Set a copyTo field.
      Default:
      ""

    • enabled

      boolean enabled
      Set to false to disable the field from indexing, it will only be get/set in _source.
      Default:
      true

    • norms

      boolean norms
      Set to false such that norms are not stored.
      Default:
      true