# Package org.hibernate.search.annotations

- Enum Summary
  Enum | Description
  --- | ---
  Analyze | Defines whether the field content should be analyzed.
  EncodingType | Determines how to encode the indexed value.
  FacetEncodingType | Determines how to encode the indexed value.
  FieldCacheType | Deprecated Remove the annotation.
  FilterCacheModeType | Cache mode strategy for `FullTextFilterDef`s.
  Index | Defines how an `Field` should be indexed.
  Norms | Defines whether the norms should be stored in the index
  Resolution | Date indexing resolution.
  SpatialMode | Defines the index structure mode used for spatial information
  Store | Whether or not the value is stored in the document
  TermVector | Defines the term vector storing strategy

- Annotation Types Summary
  Annotation Type | Description
  --- | ---
  Analyzer | Define an Analyzer for a given entity, method, field or Field The order of precedence is as such: - @Field - field / method - entity - default Either describe an explicit implementation through the `impl` parameter or use an external @AnalyzerDef definition through the `def` parameter
  AnalyzerDef | Reusable analyzer definition.
  AnalyzerDefs | Reusable analyzer definitions.
  AnalyzerDiscriminator | Allows to dynamically select a named analyzer through a `Discriminator` implementation.
  Boost | Deprecated Index-time boosting will not be possible anymore starting from Lucene 7.
  CacheFromIndex | Deprecated Remove the annotation.
  CalendarBridge | Defines the temporal resolution and encoding type of a `Calendar` field.
  CharFilterDef | Define a `CharFilterFactory` and its parameters
  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.
  ClassBridges |
  ContainedIn | Describe the owning entity as being part of the target entity's indexed object graph.
  DateBridge | Defines the temporal resolution and encoding type of a `java.util.Date` field.
  DocumentId | Declare a field as the document id.
  DynamicBoost | Deprecated Index-time boosting will not be possible anymore starting from Lucene 7.
  Facet | Extension annotation for `@Field` enabling it for faceting.
  Facets | Container annotation to allow the declaration of multiple `@Facet` annotations.
  Factory | Marks a method as a factory method for a given type.
  Field | Annotation used for marking a property as indexable.
  FieldBridge | Specifies a custom field bridge implementation
  Fields | Mark a property as indexable into different fields Useful if the field is used for sorting and searching
  FullTextFilterDef | Defines a FullTextFilter that can be optionally applied to every FullText Queries While not related to a specific indexed entity, the annotation has to be set on one of them
  FullTextFilterDefs | A list of FullTextFilterDef
  Indexed |
  IndexedEmbedded | Specifies that an association (`@*To*`, `@Embedded`, `@CollectionOfEmbedded`) is to be indexed in the root entity index.
  Key | Deprecated Custom filter cache keys are a deprecated feature scheduled to be removed in Hibernate Search 6.
  Latitude | Mark the property hosting the latitude of a specific spatial coordinate.
  Longitude | Mark the property hosting the latitude of a specific spatial coordinate.
  Normalizer | Define a Normalizer for a `@Field` Either describe an explicit implementation through the `impl` parameter or use an external `@NormalizerDef` definition through the `definition` parameter
  NormalizerDef | Reusable normalizer definition.
  NormalizerDefs | Reusable normalizer definitions.
  NumericField | Extension annotation for `@Field` supporting Lucene's numeric field feature.
  NumericFields | Numeric extension for Fields annotation
  Parameter | Parameter (basically key/value pattern)
  ProvidedId | Deprecated with no replacement: this annotation will be removed.
  SortableField | Makes a property sortable.
  SortableFields | Defines several sortable fields.
  Spatial | Defines a spatial property.
  Spatials |
  TikaBridge | Defines a bridge for integrating with Apache Tika.
  TokenFilterDef | Define a `TokenFilterFactory` and its parameters.
  TokenizerDef | Define a `TokenizerFactory` and its parameters.

Copyright © 2006-2017 Red Hat, Inc. All Rights Reserved