Skip navigation links
  • Overview
  • Package
  • Class
  • Use
  • Tree
  • Deprecated
  • Index
  • Help

Deprecated API

Contents

  • Interfaces
  • Classes
  • Enums
  • Annotation Types
  • Fields
  • Methods
  • Deprecated Interfaces
    Interface
    Description
    org.hibernate.search.backend.IndexingMonitor
    See the deprecation note on MassIndexerProgressMonitor.
    org.hibernate.search.batchindexing.MassIndexerProgressMonitor
    Instead of using Hibernate Search 5 APIs, get a org.hibernate.search.mapper.orm.session.SearchSession using org.hibernate.search.mapper.orm.Search#session(org.hibernate.Session), create a mass indexer with org.hibernate.search.mapper.orm.session.SearchSession#massIndexer(Class[]), and implement the interface org.hibernate.search.mapper.orm.massindexing.MassIndexingMonitor in your monitor. Refer to the migration guide for more information.
    org.hibernate.search.engine.ProjectionConstants
    Instead of using Hibernate Search 5 APIs, get a org.hibernate.search.mapper.orm.session.SearchSession using org.hibernate.search.mapper.orm.Search#session(org.hibernate.Session), create a SearchQuery with org.hibernate.search.mapper.orm.session.SearchSession#search(Class), and define your projections using SearchQuerySelectStep.select(Function). Refer to the migration guide for more information.
    org.hibernate.search.query.dsl.AllContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.BooleanJunction
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.DiscreteFacetContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.EntityContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.FacetContext
    Instead of using Hibernate Search 5 APIs, get a org.hibernate.search.mapper.orm.session.SearchSession using org.hibernate.search.mapper.orm.Search#session(org.hibernate.Session), create a SearchQuery with org.hibernate.search.mapper.orm.session.SearchSession#search(Class), and define your facets (now called aggregations) using SearchQueryOptionsStep.aggregation(AggregationKey, Function). You can then fetch the query result using SearchFetchable.fetch(Integer) and get each aggregation using SearchResult.aggregation(AggregationKey). Refer to the migration guide for more information.
    org.hibernate.search.query.dsl.FacetContinuationContext
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.FacetFieldContext
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.FacetParameterContext
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.FacetRangeAboveBelowContext
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.FacetRangeAboveContext
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.FacetRangeBelowContinuationContext
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.FacetRangeEndContext
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.FacetRangeLimitContext
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.FacetRangeStartContext
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.FacetTermination
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.FieldCustomization
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.FuzzyContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.MustJunction
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.PhraseContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.PhraseMatchingContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.PhraseTermination
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.QueryBuilder
    Instead of using Hibernate Search 5 APIs, get a org.hibernate.search.mapper.orm.session.SearchSession using org.hibernate.search.mapper.orm.Search#session(org.hibernate.Session), create a SearchQuery with org.hibernate.search.mapper.orm.session.SearchSession#search(Class), and define your predicates using SearchQueryWhereStep.where(Function). Refer to the migration guide for more information.
    org.hibernate.search.query.dsl.QueryContextBuilder
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.QueryCustomization
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.RangeContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.RangeMatchingContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.RangeTerminationExcludable
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.SimpleQueryStringContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.SimpleQueryStringDefinitionTermination
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.SimpleQueryStringMatchingContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.SimpleQueryStringTermination
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.sort.SortAdditionalSortFieldContext
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortContext
    Instead of using Hibernate Search 5 APIs, get a org.hibernate.search.mapper.orm.session.SearchSession using org.hibernate.search.mapper.orm.Search#session(org.hibernate.Session), create a SearchQuery with org.hibernate.search.mapper.orm.session.SearchSession#search(Class), and define your sorts using SearchQueryOptionsStep.sort(Function). Refer to the migration guide for more information.
    org.hibernate.search.query.dsl.sort.SortDistanceFieldAndReferenceContext
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortDistanceFieldContext
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortDistanceNoFieldContext
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortFieldContext
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortLatLongContext
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortMissingValueContext
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortNativeContext
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortOrder
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortOrderTermination
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortScoreContext
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.sort.SortTermination
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.SpatialContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.SpatialMatchingContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.SpatialTermination
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.TermContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.TermFuzzy
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.Termination
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.TermMatchingContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.TermTermination
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.WildcardContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.dsl.WithinContext
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.engine.spi.FacetManager
    Instead of using Hibernate Search 5 APIs, get a org.hibernate.search.mapper.orm.session.SearchSession using org.hibernate.search.mapper.orm.Search#session(org.hibernate.Session), create a SearchQuery with org.hibernate.search.mapper.orm.session.SearchSession#search(Class), and define your facets (now called aggregations) using SearchQueryOptionsStep.aggregation(AggregationKey, Function). You can then fetch the query result using SearchFetchable.fetch(Integer) and get each aggregation using SearchResult.aggregation(AggregationKey). Refer to the migration guide for more information.
    org.hibernate.search.query.engine.spi.HSQuery
    This class will be removed without replacement. Use actual API instead.
    org.hibernate.search.query.engine.spi.TupleTransformer
    This class will be removed without replacement. Use actual API instead.
    org.hibernate.search.query.engine.spi.V5MigrationSearchSession
    This class will be removed without replacement. Use actual API instead.
    org.hibernate.search.query.facet.Facet
    See the deprecation note on FacetContext.
    org.hibernate.search.query.facet.FacetingRequest
    See the deprecation note on FacetContext.
    org.hibernate.search.query.facet.RangeFacet
    See the deprecation note on FacetContext.
    org.hibernate.search.scope.spi.V5MigrationSearchScope
    This class will be removed without replacement. Use actual API instead.
    org.hibernate.search.spatial.Coordinates
    Use GeoPoint instead. Refer to the migration guide for more information.
    org.hibernate.search.spi.SearchIntegrator
    This class will be removed without replacement. Use actual API instead.
  • Deprecated Classes
    Class
    Description
    org.hibernate.search.util.AnalyzerUtils
    Will be removed without replacement.
    org.hibernate.search.util.StringHelper
    Will be removed without replacement.
  • Deprecated Enums
    Enum
    Description
    org.hibernate.search.annotations.Analyze
    No longer necessary in Hibernate Search 6. Replace Field with FullTextField to define a field with an analyzer, or any other field annotation (e.g. KeywordField, GenericField, ...) to define a field without an analyzer.
    org.hibernate.search.annotations.Index
    Use Hibernate Search 6's field annotations (GenericField, KeywordField, FullTextField, ...) and enable/disable indexing with @GenericField(searchable = Searchable.YES) instead.
    org.hibernate.search.annotations.Norms
    Use Hibernate Search 6's text field annotations (KeywordField, FullTextField) and enable/disable norms with @FullTextField(norms = Norms.YES) instead.
    org.hibernate.search.annotations.Resolution
    DateBridge/CalendarBridge are no longer available in Hibernate Search 6. See the javadoc of DateBridge or CalendarBridge.
    org.hibernate.search.annotations.Store
    Use Hibernate Search 6's field annotations (GenericField, KeywordField, FullTextField, ...) and enable/disable storage with @GenericField(projectable = Projectable.YES) instead.
    org.hibernate.search.annotations.TermVector
    Use Hibernate Search 6's full-text field annotation (FullTextField) and enable/disable term vectors with @FullTextField(termVector = TermVector.YES) instead.
    org.hibernate.search.query.DatabaseRetrievalMethod
    This setting is ignored in Hibernate Search 6.
    org.hibernate.search.query.dsl.Unit
    See the deprecation note on QueryBuilder.
    org.hibernate.search.query.facet.FacetSortOrder
    See the deprecation note on FacetContext.
    org.hibernate.search.query.ObjectLookupMethod
    Instead of using Hibernate Search 5 APIs, get a org.hibernate.search.mapper.orm.session.SearchSession using org.hibernate.search.mapper.orm.Search#session(org.hibernate.Session), create a SearchQuery with org.hibernate.search.mapper.orm.session.SearchSession#search(Class), and define your loading options using SearchQueryOptionsStep.loading(Consumer). To set the equivalent to ObjectLookupMethod in Hibernate Search 6, use org.hibernate.search.mapper.orm.search.loading.dsl.SearchLoadingOptionsStep#cacheLookupStrategy(org.hibernate.search.mapper.orm.search.loading.EntityLoadingCacheLookupStrategy) Refer to the migration guide for more information.
  • Deprecated Annotation Types
    Annotation Type
    Description
    org.hibernate.search.annotations.Analyzer
    No longer necessary in Hibernate Search 6. Replace Field with FullTextField and pass the analyzer name directly to FullTextField.analyzer().
    org.hibernate.search.annotations.CalendarBridge
    DateBridge/CalendarBridge are no longer available in Hibernate Search 6. If you cannot move your properties to Java 8 date/time types, implement your own bridge and apply it with GenericField.valueBridge(). If you can move your properties to Java 8 date/time types, do so, remove this annotation and replace Field with GenericField. Then, either use a Java type with the appropriate resolution (LocalDate, ...) and match predicates, or use a type with more resolution than necessary but rely on range predicates (e.g. f.range().field("myField").between(LocalDate.now().atStartOfDay(), LocalDate.now().plusDays(1).atStartOfDay()) for a "day" resolution on a LocalDateTime field).
    org.hibernate.search.annotations.DateBridge
    DateBridge/CalendarBridge are no longer available in Hibernate Search 6. If you cannot move your properties to Java 8 date/time types, implement your own bridge and apply it with GenericField.valueBridge(). If you can move your properties to Java 8 date/time types, do so, remove this annotation and replace Field with GenericField. Then, either use a Java type with the appropriate resolution (LocalDate, ...) and match predicates, or use a type with more resolution than necessary but rely on range predicates (e.g. f.range().field("myField").between(LocalDate.now().atStartOfDay(), LocalDate.now().plusDays(1).atStartOfDay()) for a "day" resolution on a LocalDateTime field).
    org.hibernate.search.annotations.DocumentId
    Use Hibernate Search 6's DocumentId instead.
    org.hibernate.search.annotations.Facet
    Use Hibernate Search 6's field annotations (GenericField, KeywordField, FullTextField, ...) and enable faceting with @GenericField(aggregable = Aggregable.YES) instead.
    org.hibernate.search.annotations.Facets
    See the deprecation note on Facet.
    org.hibernate.search.annotations.Field
    Use Hibernate Search 6's field annotations instead:
    • FullTextField for text fields with an analyzer.
    • KeywordField for text fields with a normalizer.
    • GenericField for non-text fields.
    org.hibernate.search.annotations.Fields
    Use Hibernate Search 6's field annotations instead:
    • FullTextField for text fields with an analyzer.
    • KeywordField for text fields with a normalizer.
    • GenericField for non-text fields.
    org.hibernate.search.annotations.Indexed
    Use Hibernate Search 6's Indexed instead.
    org.hibernate.search.annotations.IndexedEmbedded
    Use Hibernate Search 6's IndexedEmbedded instead.
    org.hibernate.search.annotations.Latitude
    Use Hibernate Search 6's Latitude instead. See also the javadoc of Spatial.
    org.hibernate.search.annotations.Longitude
    Use Hibernate Search 6's Longitude instead. See also the javadoc of Spatial.
    org.hibernate.search.annotations.Normalizer
    No longer necessary in Hibernate Search 6. Replace Field with KeywordField and pass the normalizer name directly to KeywordField.normalizer().
    org.hibernate.search.annotations.NumericField
    This annotation does not do anything anymore and is not necessary. It can be removed safely.
    org.hibernate.search.annotations.NumericFields
    This annotation does not do anything anymore and is not necessary. It can be removed safely.
    org.hibernate.search.annotations.SortableField
    Use Hibernate Search 6's field annotations (GenericField, KeywordField, ...) and enable sorts with @GenericField(sortable = Sortable.YES) instead. Note that FullTextField cannot be marked as sortable, but you can define a KeywordField alongside your FullTextField, with a different name, and that field can be marked as sortable.
    org.hibernate.search.annotations.SortableFields
    See the deprecation note on SortableField
    org.hibernate.search.annotations.Spatial
    If the latitude/longitude of the element annotated with Spatial are mutable, annotate these properties annotated with Latitude/Longitude, and use GeoPointBinding instead of Spatial. If the latitude/longitude of the element annotated with Spatial are immutable, you can alternatively implement GeoPoint instead of Coordinates and simply use GenericField on properties of this type.
    org.hibernate.search.annotations.Spatials
    See the deprecation note on Spatial.
  • Deprecated Fields
    Field
    Description
    org.hibernate.search.engine.ProjectionConstants.DOCUMENT
    See the javadoc of this class for how to create projections in Hibernate Search 6. The equivalent projection in Hibernate Search 6 is LuceneSearchProjectionFactory.document(). You will need to pass LuceneExtension.get() to SearchProjectionFactory.extension(SearchProjectionFactoryExtension) in order to get access to this Lucene-specific feature.
    org.hibernate.search.engine.ProjectionConstants.EXPLANATION
    See the javadoc of this class for how to create projections in Hibernate Search 6. The equivalent projection in Hibernate Search 6 is LuceneSearchProjectionFactory.explanation(). You will need to pass LuceneExtension.get() to SearchProjectionFactory.extension(SearchProjectionFactoryExtension) in order to get access to this Lucene-specific feature.
    org.hibernate.search.engine.ProjectionConstants.ID
    See the javadoc of this class for how to create projections in Hibernate Search 6. The equivalent projection in Hibernate Search 6 is SearchProjectionFactory.entityReference(); call .id() on the reference to get the entity identifier.
    org.hibernate.search.engine.ProjectionConstants.OBJECT_CLASS
    See the javadoc of this class for how to create projections in Hibernate Search 6. The equivalent projection in Hibernate Search 6 is SearchProjectionFactory.entityReference(); call .type() on the reference to get the entity type.
    org.hibernate.search.engine.ProjectionConstants.SCORE
    See the javadoc of this class for how to create projections in Hibernate Search 6. The equivalent projection in Hibernate Search 6 is SearchProjectionFactory.score().
    org.hibernate.search.engine.ProjectionConstants.SPATIAL_DISTANCE
    See the javadoc of this class for how to create projections in Hibernate Search 6. The equivalent projection in Hibernate Search 6 is SearchProjectionFactory.distance(String, GeoPoint).
    org.hibernate.search.engine.ProjectionConstants.THIS
    See the javadoc of this class for how to create projections in Hibernate Search 6. The equivalent projection in Hibernate Search 6 is SearchProjectionFactory.entity().
  • Deprecated Methods
    Method
    Description
    org.hibernate.search.query.dsl.EntityContext.overridesForField(String, String)
    See the deprecation note on QueryBuilder. Also, analyzer overrides are done on a per-predicate basis in Hibernate Search 6. See MatchPredicateOptionsStep.analyzer(String), CommonQueryStringPredicateOptionsStep.analyzer(String), etc.
    org.hibernate.search.query.dsl.QueryBuilder.all()
    See the javadoc of this class for how to create predicates in Hibernate Search 6. The equivalent predicate in Hibernate Search 6 is SearchPredicateFactory.matchAll().
    org.hibernate.search.query.dsl.QueryBuilder.bool()
    See the javadoc of this class for how to create predicates in Hibernate Search 6. The equivalent predicate in Hibernate Search 6 is SearchPredicateFactory.bool().
    org.hibernate.search.query.dsl.QueryBuilder.facet()
    See the deprecation note on FacetContext.
    org.hibernate.search.query.dsl.QueryBuilder.keyword()
    See the javadoc of this class for how to create predicates in Hibernate Search 6. The equivalent predicate in Hibernate Search 6 is SearchPredicateFactory.match(). For wildcard predicates, use SearchPredicateFactory.wildcard().
    org.hibernate.search.query.dsl.QueryBuilder.phrase()
    See the javadoc of this class for how to create predicates in Hibernate Search 6. The equivalent predicate in Hibernate Search 6 is SearchPredicateFactory.phrase().
    org.hibernate.search.query.dsl.QueryBuilder.range()
    See the javadoc of this class for how to create predicates in Hibernate Search 6. The equivalent predicate in Hibernate Search 6 is SearchPredicateFactory.range().
    org.hibernate.search.query.dsl.QueryBuilder.simpleQueryString()
    See the javadoc of this class for how to create predicates in Hibernate Search 6. The equivalent predicate in Hibernate Search 6 is SearchPredicateFactory.simpleQueryString().
    org.hibernate.search.query.dsl.QueryBuilder.sort()
    See the deprecation note on SortContext.
    org.hibernate.search.query.dsl.QueryBuilder.spatial()
    See the javadoc of this class for how to create predicates in Hibernate Search 6. The equivalent predicate in Hibernate Search 6 is SearchPredicateFactory.spatial().

Copyright © 2006-2024 Red Hat, Inc. and others. Licensed under the GNU Lesser General Public License (LGPL), version 2.1 or later.