All Classes and Interfaces

Class
Description
 
 
 
 
 
 
AbstractIndexModel<S extends AbstractIndexModel<?,R,F>,R extends IndexCompositeNode<?,?,?>,F extends IndexField<?,?>>
 
 
 
 
 
 
 
 
 
 
An abstract base for PredicateFinalStep implementations.
 
AbstractSearchIndexScope<S extends SearchQueryIndexScope<?>,M extends AbstractIndexModel<?,? extends C,? extends N>,N extends SearchIndexNodeContext<? super S>,C extends SearchIndexCompositeNodeContext<? super S>>
 
 
 
An abstract base for implementations of SearchQuery.
 
 
 
 
An abstract base for orchestrator implementations, implementing a thread-safe shutdown.
Whether the field can be used in projections.
A classloader which keeps an ordered list of aggregated classloaders.
The step in an aggregation definition where a filter can be set to select nested objects from which values will be extracted for this aggregation.
The final step in an aggregation definition, where the aggregation can be retrieved.
A key allowing to retrieve an aggregation from the search result.
 
 
A source of property values for Hibernate Search with knowledge of the full set of properties.
Constants for the names of built-in analyzers.
A backend as viewed by Hibernate Search users.
A build context for backends.
 
 
 
Provides visibility from the lower layers of Hibernate Search (engine, backend) to the mapping defined in the upper layers.
 
Warning this class consists of generated code.
Provides visibility from the lower layers of Hibernate Search (engine, backend) to the session defined in the upper layers (mapping).
Configuration properties common to all Hibernate Search backends regardless of the underlying technology.
 
 
A start context for backends.
A work ready to be submitted to a BatchingExecutor, and eventually processed in a batch by a BatchedWorkProcessor.
A processor of batched works submitted to a BatchingExecutor.
An executor of works that accepts works from multiple threads, puts them in a queue, and processes them in batches in a single background thread.
 
An object responsible for defining beans that can then be resolved during Hibernate Search bootstrap.
 
An object holding a bean instance, and allowing to release it.
Indicates a bean was not found by a BeanProvider.
The interface to be implemented by components providing beans to Hibernate Search.
A reference to a bean, allowing the retrieval of that bean when passed a BeanResolver.
The main entry point for components looking to resolve a bean reference into a (usually user-provided) bean.
Defines where beans are retrieved from.
 
 
The initial and final step in a boolean predicate definition, where clauses can be added.
An object where the clauses and options of a boolean predicate can be set.
Utility class to load instances of other classes by using a fully qualified name, or from a class type.
Indicates a problem performing class loading.
A resolver of Java classes.
 
 
The step in a "multi-step" composite projection definition where a single inner projection has been defined and the result of the composite projection can be defined.
The step in a "multi-step" composite projection definition where 2 inner projections have been defined and the result of the composite projection can be defined.
The step in a "multi-step" composite projection definition where 3 inner projections have been defined and the result of the composite projection can be defined.
The step in a "multi-step" composite projection definition where one or more inner projections have been defined and the result of the composite projection can be defined.
A step in a "multi-step" composite projection definition where one can define inner projections to get values from.
The final step in a composite projection definition where optional parameters can be set.
The step in a composite projection definition where the projection (optionally) can be marked as multi-valued (returning Lists), and where optional parameters can be set.
 
The initial and final step in a composite sort definition, where sort elements can be added.
 
A utility that checks usage of property keys by wrapping a ConfigurationPropertySource and requiring special hooks to be called before and after bootstrap.
 
A source of property values for Hibernate Search.
 
A failure collector with an implicit context.
 
Common interface providing a deadline through the method Deadline.checkRemainingTimeMillis().
Default implementation of ClassResolver relying on an AggregatedClassLoader.
 
Default implementation of ClassResolver relying on an AggregatedClassLoader.
Default implementation of ClassResolver relying on an AggregatedClassLoader.
 
Deprecated.
SPIs should simply pass around a string representing the tenant ID instead of using this class.
 
The step in a sort definition where the behavior on missing values can be set.
The initial and final step in a "distance" sort definition, where optional parameters can be set.
 
The initial and final step in a "distance to field" projection definition, where optional parameters can be set.
The initial step in a "distance to field" projection definition, where the projection (optionally) can be marked as multi-valued (returning Lists), and where optional parameters can be set.
Distance units.
Defines how to handle index commits after a document is written to the index, i.e.
 
An element of a document.
A reference to an indexed document.
 
The initial and final step in a "document reference" projection definition, where optional parameters can be set.
 
Defines how to handle index refreshes after a document is written to the index, i.e.
A converter for values passed to the DSL.
A utility class holding the state of the extension contexts found in several DSLs.
Configuration properties for the Hibernate Search engine.
Default values for the different settings if no values are given.
Configuration property keys without the prefix.
Configuration properties for the Hibernate Search engine that are considered SPI (and not API).
Default values for the different settings if no values are given.
Configuration property keys without the prefix.
Contextual information about a failure to index entities.
 
The initial and final step in an "entity" projection definition, where optional parameters can be set.
 
The initial and final step in an "entity reference" projection definition, where optional parameters can be set.
 
 
The initial step in an "exists" predicate definition, where the target field can be set.
The final step in an "exists" predicate definition, where optional parameters can be set.
A base interface for subtypes of SearchAggregationFactory allowing to easily override the self type and predicate factory type for all relevant methods.
A base interface for subtypes of SearchFetchable allowing to easily override the result type for all relevant methods.
A base interface for subtypes of SearchPredicateFactory allowing to easily override the self type for all relevant methods.
A base interface for subtypes of SearchProjectionFactory allowing to easily override the self type for all relevant methods.
A base interface for subtypes of SearchQuery allowing to easily override the result type for all relevant methods.
A base interface for subtypes of SearchScroll allowing to easily override the result type for all relevant methods.
A base interface for subtypes of SearchSortFactory allowing to easily override the self type and predicate factory type for all relevant methods.
A failure collector without any context.
Contextual information about a failing background operation.
 
A handler for failures occurring during background operations, which may not have been reported to the caller due to being executed asynchronously.
 
 
 
 
The initial and final step in a "field" projection definition, where optional parameters can be set.
The initial step in a "field" projection definition, where the projection (optionally) can be marked as multi-valued (returning Lists), and where optional parameters can be set.
 
The step in a sort definition where the behavior on missing values can be set.
The initial and final step in a "field" sort definition, where optional parameters can be set.
Deprecated.
Implement FromDocumentValueConverter instead.
 
An extension to FromDocumentValueConvertContext, allowing to access non-standard context specific to a given mapper.
 
A converter from a source value in the document model to a different value.
A generic superinterface for Predicate DSL steps that involve collecting clauses and options of a boolean predicate.
A generic superinterface for "simple boolean predicate" DSL steps that involve collecting clauses.
A bounding box in the geocentric coordinate system.
A point in the geocentric coordinate system.
A polygon in the geocentric coordinate system.
The initial and final step in an "id" projection definition, where optional parameters can be set.
 
Opens an extension point to accept implicit fields.
The binding context associated to a specific node in the entity tree.
A composite element in the index.
 
 
A descriptor of an index, exposing in particular the available fields and their characteristics.
The binding context associated to a specific non-root node in the entity tree.
 
A tracker for paths actually affected by an indexed embedded definition.
The binding context associated to the root node in the entity tree.
 
 
A field in the index.
 
 
A reference to an "object" field of an indexed document, allowing to add new values to this field for a given document.
The type of a field in the index.
The step in an index field type definition where DSL converters (applied when using the search DSL) and projection converters (applied when projecting in a search query) can be set.
 
A factory for types of index fields.
An extension to the index field type DSL, allowing to create non-standard types in an index schema.
The final step in an index field type definition, where the type can be retrieved.
The final step in an index field type definition, where optional parameters can be set.
 
An indexer scoped to a single index.
A set of works to be executed on a single index.
An index manager as viewed by Hibernate Search users.
 
The object responsible for applying works and searches to a full-text index.
A start context for index managers.
 
 
 
An "object" field in the index, i.e.
A reference to an "object" field of an indexed document, allowing to add new values to this field for a given document.
The type of an "object" field in the index, exposing its various capabilities.
 
 
 
An element of the index schema, allowing the definition of child fields.
The final step in the definition of a field in the index schema, where a reference to the field can be retrieved.
The final step in the definition of a field in the index schema, where a reference to the field can be retrieved, optionally setting some parameters beforehand.
The final step in the definition of a field template in the index schema, where options can be set.
A manager for the schema of a single index, i.e.
The final step in the definition of a named predicate in the index schema.
An object field in the index schema, allowing the definition of child fields, customization of some characteristics of this object field such as multi-valued-ness, and the retrieval of a field reference to be used when indexing.
The scope of an index-related operation, aware of the targeted indexes and of the underlying technology (backend).
 
An extension to the index scope, providing an extended index scope offering backend-specific utilities.
Configuration properties common to all Hibernate Search indexes regardless of the underlying technology.
 
A "value" field in the index, i.e.
The type of a "value" field in the index, exposing its various capabilities and accepted Java types.
The entry point for explicit index operations on a single index.
 
The result of the loading of the entities by the ProjectionHitMapper.
A representation of an entity type that can be mapped to an index.
 
The object responsible for applying works and searches to a full-text index.
A builder for MappedIndexManager instances, which will be the interface between the mapping and the index when indexing and searching.
A factory for MappedIndexManager instances, which will be the interface between the mapping and the index when indexing and searching.
 
 
 
An exception thrown by Mapper.prepareBuild() when detecting that failures were collected and deciding to abort early to avoid a snowball effect creating too many failures, which would make the failure report unclear.
A build context for mappings.
 
The context passed to the mapper during the very last step of bootstrap.
An object responsible for finalizing a mapping.
Interface used by the engine to manipulate mappings
An object responsible for initiating a mapping by contributing its basic configuration (indexed types, type metadata), then creating the mapper based on the configuration processed by the engine.
Tagging interface for objects used as a key to retrieve mappings at different states: when finalizing the mapping in SearchIntegrationFinalizer.finalizeMapping(MappingKey, MappingFinalizer).
 
A pre-stop context for mappings.
A start context for mappings.
 
The initial and final step in "match all" predicate definition, where optional parameters can be set.
 
The final step in a "match id" predicate definition, where more IDs to match can be set.
The step in a "match id" predicate definition where the IDs to match can be set.
The final step in a "match id" predicate definition, where optional parameters can be set.
 
The initial and final step in "match none" predicate definition.
 
The step in a "match" predicate definition where the value to match can be set (see the superinterface MatchPredicateMatchingStep), or optional parameters for the last targeted field(s) can be set, or more target fields can be added.
The initial step in a "match" predicate definition, where the target field can be set.
The step in a "match" predicate definition where the value to match can be set.
The final step in a "match" predicate definition, where optional parameters can be set.
The step in a "minimum should match" constraint definition where a condition can be defined as necessary for the following requirements to be enforced.
The step in a "minimum should match" constraint definition where the constraint definition can be ended, or more conditions can be added.
The step in a "minimum should match" constraint definition where the minimum required number or percentage of should clauses to match can be set.
 
 
The step in a predicate definition where the boost of the last added field(s) can be set.
 
 
The initial and final step in named predicate definition.
 
An object where the clauses of a nested predicate can be set.
The step in a nested predicate definition where clauses can be added.
Deprecated.
Deprecated.
Deprecated.
 
Whether index-time scoring information for the field should be stored or not.
The initial and final step in "not" predicate definition.
 
Defines how the structure of an object field is preserved upon indexing.
Interface defining how operation should be submitted to the queue or executor.
 
 
 
 
The step in a "phrase" predicate definition where the phrase to match can be set (see the superinterface PhrasePredicateMatchingStep), or optional parameters for the last targeted field(s) can be set, or more target fields can be added.
The initial step in a "phrase" predicate definition, where the target field can be set.
The step in a "phrase" predicate definition where the phrase to match can be set.
The final step in a "phrase" predicate definition, where optional parameters can be set.
A component able to define a predicate using the Hibernate Search Predicate DSL.
The final step in a predicate definition, where the predicate can be retrieved.
The step in a predicate definition where score-related options can be set.
 
Whether or not we want to be able to obtain the value of the field as a projection.
A variation on Collector suitable for projections on field values.
Provides an accumulator for a given type of values to accumulate (T).
A variation on Collector suitable for composing the result of inner projections in a composite projection.
A converter from a value obtained from the backend to a projected value.
The final step in a projection definition, where the projection can be retrieved.
Contract binding result hits and the mapper.
 
 
 
 
 
The initial step in a "range" aggregation definition, where the target field can be set.
The final step in a "range" aggregation definition, where optional parameters can be set.
The step in a "range" aggregation definition where optional parameters can be set, (see the superinterface RangeAggregationOptionsStep), or more ranges can be added.
The step in a "range" aggregation definition where the ranges can be set.
 
The step in a "range" predicate definition where the limits of the range to match can be set (see the superinterface RangePredicateMatchingStep), or optional parameters for the last targeted field(s) can be set, or more target fields can be added.
The initial step in a "range" predicate definition, where the target field can be set.
The step in a "range" predicate definition where the range to match can be set.
The final step in a "range" predicate definition, where optional parameters can be set.
 
The step in a "regexp" predicate definition where the pattern to match can be set (see the superinterface RegexpPredicateMatchingStep), or optional parameters for the last targeted field(s) can be set, or more target fields can be added.
The initial step in a "regexp" predicate definition, where the target field can be set.
The step in a "regexp" predicate definition where the pattern to match can be set.
The final step in a "regexp" predicate definition, where optional parameters can be set.
 
A resolver of Java resources.
 
 
 
 
 
The initial and final step in a "scaled number" index field type definition, where optional parameters can be set.
The initial and final step in a "score" projection definition, where optional parameters can be set.
 
The initial and final step in a "score" sort definition, where optional parameters can be set.
Whether or not we want to be able to search the document using this field.
A search aggregation, i.e.
A search aggregation builder, i.e.
A factory for search aggregation builders.
Represents the current context in the search DSL, including in particular the search scope and the aggregation builder factory.
A factory for search aggregations.
An extension to the search aggregation DSL, allowing the use of non-standard aggregations in a query.
 
A component allowing to fetch search results.
Information about a composite index element targeted by search; either the index root or an object field.
Information about the type of a composite (non-value) index element targeted by search, be it in a projection, a predicate, a sort, ...
Information about an identifier targeted by search.
Information about an index node targeted by search, be it the index root, a value field or an object field.
Information about the type of an composite index element targeted by search, be it in a projection, a predicate, a sort, ...
 
Information about indexes targeted by search, be it in a projection, a predicate, a sort, ...
Information about a value (non-object) field targeted by search, be it in a projection, a predicate, a sort, ...
Information about the type of a value (non-object) field targeted by search, be it in a projection, a predicate, a sort, ...
 
 
 
The environment of a search integration, i.e.
 
 
 
An execution context for queries, providing components allowing to load data from an external source (relational database, ...).
A builder for SearchLoadingContext, allowing to change the parameters of object loading while a query is being built.
A query predicate that can be used to filter queries.
A search predicate builder, i.e.
A factory for search predicate builders.
Represents the current context in the search DSL, including in particular the search scope and the predicate builder factory.
A factory for search predicates.
An extension to the search predicate DSL, allowing the use of non-standard predicates in a query.
The second and later step when attempting to apply multiple extensions to a SearchPredicateFactory.
The initial step when attempting to apply multiple extensions to a SearchPredicateFactory.
 
A query projection that can be used to obtain particular values of an indexed document.
A search projection builder, i.e.
A factory for search projection builders.
Represents the current context in the search DSL, including in particular the search scope and the projection builder factory.
A factory for search projections.
An extension to the search projection DSL, allowing the use of non-standard projections in a query.
The second and later step when attempting to apply multiple extensions to a SearchProjectionFactory.
The initial step when attempting to apply multiple extensions to a SearchProjectionFactory.
 
A search query, allowing to fetch search results.
A builder for search queries.
An extension to the search query DSL, allowing to set non-standard options on a query.
A factory for query elements (predicates, sorts, projections, aggregations, ...) targeting index nodes (root, value fields, object fields).
 
An extension to the search query, allowing to wrap a query.
The final step in a query definition, where the query can be executed or retrieved as an object.
Defines the "service program contract" for SearchQuery.
 
The final step in a query definition, where optional parameters such as sorts can be set, and where the query can be executed or retrieved as an object.
The initial step in a query definition, where the element used to represent query hits, i.e.
The step in a query definition where the predicate, i.e.
 
The total for a search result, pertaining to all matched documents, independently from the offset/limit used when fetching hits.
An ongoing query execution delivering hits continuously from a single snapshot of the index.
 
A search sort that can be used to sort search query results.
A search sort builder, i.e.
A factory for search sort builders.
Represents the current context in the search DSL, including in particular the search scope, the sort builder factory and the knowledge of previous sorts chained using SortThenStep.then().
A factory for search sorts.
An extension to the search sort DSL, allowing the use of non-standard sorts in a query.
The second and later step when attempting to apply multiple extensions to a SearchSortFactory.
The initial step when attempting to apply multiple extensions to a SearchSortFactory.
 
A resolver of Java services.
An object where the clauses and options of a simple boolean predicate (and, or) can be set.
The initial and final step in a "simple boolean predicate" definition, where clauses can be added and options can be set.
The initial and final step in a "simple boolean predicate" definition, where options can be set.
 
 
 
The step in a "simple query string" predicate definition where the query string to match can be set (see the superinterface SimpleQueryStringPredicateMatchingStep), or optional parameters for the last targeted field(s) can be set, or more target fields can be added.
The initial step in a "simple query string" predicate definition, where the target field can be set.
The step in an "simple query string" predicate definition where the query string to match can be set.
The final step in an "simple query string" predicate definition, where optional parameters can be set.
 
 
 
 
A task that can be scheduled for a run and is guaranteed to never run concurrently, regardless of the thread pool it's submitted to.
 
 
Whether a field can be used in sorts.
The step in a sort definition where a filter can be set to select nested objects from which values will be extracted for this sort.
The final step in a sort definition, where the sort can be retrieved.
Defines how to pick the value to sort on for multi-valued fields.
The step in a sort definition where the SortMode can be set.
 
The step in a sort definition where the order can be set.
The step in a sort definition where another sort can be chained.
 
The initial step of all spatial predicate definitions.
 
 
 
The step in a "within" predicate definition where the area to match can be set.
The step in a "within" predicate definition where the area to match can be set (see the superinterface SpatialWithinPredicateAreaStep), or optional parameters for the last targeted field(s) can be set, or more target fields can be added.
The initial step in a "within" predicate definition, where the target field can be set.
The final step in a "within" predicate definition, where optional parameters can be set.
The initial and final step in a "standard" index field type definition, where optional parameters can be set.
 
 
 
 
The initial and final step in a "string" index field type definition, where optional parameters can be set.
 
 
 
The initial step in a "terms" aggregation definition, where the target field can be set.
The final step in a "terms" aggregation definition, where optional parameters can be set.
 
The step in a "terms" predicate definition where the terms to match can be set (see the superinterface TermsPredicateMatchingStep), or optional parameters for the last targeted field(s) can be set, or more target fields can be added.
The initial step in a "terms" predicate definition, where the target field can be set.
The step in a "terms" predicate definition where the terms to match can be set.
The final step in a "terms" predicate definition, where optional parameters can be set.
Defines the term vector storing strategy.
 
The thread provider, used to customize thread groups and names.
 
 
 
Deprecated.
Implement ToDocumentValueConverter instead.
 
An extension to ToDocumentValueConvertContext, allowing to access non-standard context specific to a given mapper.
 
A converter from a source value to a target value in the document model.
A provider of type metadata contributors, taking into account explicit contributions, implicit discovery and inheritance.
 
 
Specifies whether values should be converted during search queries.
 
 
The step in a "wildcard" predicate definition where the pattern to match can be set (see the superinterface WildcardPredicateMatchingStep), or optional parameters for the last targeted field(s) can be set, or more target fields can be added.
The initial step in a "wildcard" predicate definition, where the target field can be set.
The step in a "wildcard" predicate definition where the pattern to match can be set.
The final step in a "wildcard" predicate definition, where optional parameters can be set.