Uses of Annotation Type
org.hibernate.search.util.common.annotation.Incubating
Package
Description
-
Uses of Incubating in org.hibernate.search.backend.elasticsearch.schema.management
Modifier and TypeInterfaceDescriptioninterface
Extended version of anSchemaExport
that exposes any Elasticsearch-specific methods. -
Uses of Incubating in org.hibernate.search.backend.elasticsearch.search.query
Modifier and TypeInterfaceDescriptioninterface
A pluggable component that gets the chance to transform search requests (path, body, ...) before they are sent to Elasticsearch.interface
Modifier and TypeMethodDescriptioncom.google.gson.JsonObject
ElasticsearchSearchResult.responseBody()
-
Uses of Incubating in org.hibernate.search.backend.elasticsearch.search.query.dsl
Modifier and TypeMethodDescriptionElasticsearchSearchQueryOptionsStep.requestTransformer
(ElasticsearchSearchRequestTransformer transformer) Set theElasticsearchSearchRequestTransformer
for this search query. -
Uses of Incubating in org.hibernate.search.backend.elasticsearch.work.spi
-
Uses of Incubating in org.hibernate.search.backend.lucene.index
Modifier and TypeMethodDescriptionLuceneIndexManager.computeSizeInBytesAsync
(OperationSubmitter operationSubmitter) -
Uses of Incubating in org.hibernate.search.backend.lucene.schema.management
Modifier and TypeInterfaceDescriptioninterface
Extended version of anSchemaExport
that exposes any Lucene-specific methods. -
Uses of Incubating in org.hibernate.search.backend.lucene.work.spi
-
Uses of Incubating in org.hibernate.search.engine.backend
-
Uses of Incubating in org.hibernate.search.engine.backend.document.model.dsl
Modifier and TypeInterfaceDescriptioninterface
The final step in the definition of a named predicate in the index schema.Modifier and TypeMethodDescriptionIndexSchemaElement.namedPredicate
(String relativeNamedPredicateName, PredicateDefinition definition) Add a named predicate factory to this index schema element. -
Uses of Incubating in org.hibernate.search.engine.backend.document.model.dsl.spi
Modifier and TypeInterfaceDescriptioninterface
interface
Opens an extension point to accept implicit fields. -
Uses of Incubating in org.hibernate.search.engine.backend.schema.management.spi
Modifier and TypeMethodDescriptionvoid
IndexSchemaManager.exportExpectedSchema
(IndexSchemaCollector collector) Accepts a collector that will receive the schema export represented by this index schema manager. -
Uses of Incubating in org.hibernate.search.engine.backend.work.execution
Modifier and TypeClassDescriptionclass
Interface defining how operation should be submitted to the queue or executor. -
Uses of Incubating in org.hibernate.search.engine.cfg.spi
Modifier and TypeInterfaceDescriptioninterface
Allows integrators to provide their default configuration properties for various scopes that would override Hibernate Search specific ones.final class
Holds a configuration scope.final class
Names of configuration scope namespaces used to construct aConfigurationScope
. -
Uses of Incubating in org.hibernate.search.engine.common.execution.spi
Modifier and TypeClassDescriptionclass
interface
-
Uses of Incubating in org.hibernate.search.engine.common.schema.management
Modifier and TypeInterfaceDescriptioninterface
interface
An extension to the index schema export, allowing to access backend-specific methods of a schema export. -
Uses of Incubating in org.hibernate.search.engine.common.timing
Modifier and TypeInterfaceDescriptioninterface
Common interface providing a deadline through the methodDeadline.checkRemainingTimeMillis()
. -
Uses of Incubating in org.hibernate.search.engine.reporting
Modifier and TypeMethodDescriptiondefault long
FailureHandler.failureFloodingThreshold()
When this handler is used for handling mass indexing failures - returns the number of failures during one mass indexing beyond which the failure handler will no longer be notified. -
Uses of Incubating in org.hibernate.search.engine.search.aggregation.dsl
Modifier and TypeMethodDescriptionSearchAggregationFactory.toAbsolutePath
(String relativeFieldPath) Create a new aggregation factory whose root for all paths passed to the DSL will be the given object field. -
Uses of Incubating in org.hibernate.search.engine.search.predicate.definition
Modifier and TypeInterfaceDescriptioninterface
A component able to define a predicate using the Hibernate Search Predicate DSL.interface
The context passed toPredicateDefinition.create(PredicateDefinitionContext)
. -
Uses of Incubating in org.hibernate.search.engine.search.predicate.dsl
Modifier and TypeInterfaceDescriptioninterface
The initial and final step in named predicate definition.Modifier and TypeMethodDescriptionMatch documents if they match a combination of defined named predicate clauses.SearchPredicateFactory.toAbsolutePath
(String relativeFieldPath) Create a new predicate factory whose root for all paths passed to the DSL will be the given object field. -
Uses of Incubating in org.hibernate.search.engine.search.projection.definition
Modifier and TypeInterfaceDescriptioninterface
A component able to define a projection using the Hibernate Search Projection DSL.interface
The context passed toProjectionDefinition.create(SearchProjectionFactory, ProjectionDefinitionContext)
. -
Uses of Incubating in org.hibernate.search.engine.search.projection.definition.spi
Modifier and TypeClassDescriptionclass
final class
class
static final class
static final class
class
static final class
static final class
-
Uses of Incubating in org.hibernate.search.engine.search.projection.dsl
Modifier and TypeMethodDescriptionProject to highlights, i.e.SearchProjectionFactory.toAbsolutePath
(String relativeFieldPath) Create a new projection factory whose root for all paths passed to the DSL will be the given object field. -
Uses of Incubating in org.hibernate.search.engine.search.query.dsl
Modifier and TypeMethodDescriptionSearchQueryOptionsStep.highlighter
(String highlighterName, Function<? super SearchHighlighterFactory, ? extends HighlighterFinalStep> highlighterContributor) Configure a named highlighter.SearchQueryOptionsStep.highlighter
(String highlighterName, SearchHighlighter highlighter) Configure a named highlighter.SearchQueryOptionsStep.highlighter
(Function<? super SearchHighlighterFactory, ? extends HighlighterFinalStep> highlighterContributor) Configure the default highlighter.SearchQueryOptionsStep.highlighter
(SearchHighlighter highlighter) Configure the default highlighter. -
Uses of Incubating in org.hibernate.search.engine.search.query.spi
Modifier and TypeMethodDescriptionvoid
SearchQueryBuilder.highlighter
(String highlighterName, SearchHighlighter highlighter) void
SearchQueryBuilder.highlighter
(SearchHighlighter queryHighlighter) -
Uses of Incubating in org.hibernate.search.engine.search.sort.dsl
Modifier and TypeMethodDescriptionSearchSortFactory.toAbsolutePath
(String relativeFieldPath) Create a new sort factory whose root for all paths passed to the DSL will be the given object field. -
Uses of Incubating in org.hibernate.search.mapper.orm.automaticindexing.session
Modifier and TypeMethodDescriptionvoid
AutomaticIndexingSynchronizationConfigurationContext.operationSubmitter
(OperationSubmitter operationSubmitter) Deprecated.Set operation submitter to be applied while executing underlying plans. -
Uses of Incubating in org.hibernate.search.mapper.orm.coordination.outboxpolling
Modifier and TypeClassDescriptionclass
An extension to the search mapping, giving access to features specific to the outbox polling coordination strategy. -
Uses of Incubating in org.hibernate.search.mapper.orm.coordination.outboxpolling.cfg
Modifier and TypeClassDescriptionfinal class
enum
enum
-
Uses of Incubating in org.hibernate.search.mapper.orm.coordination.outboxpolling.cfg.spi
Modifier and TypeClassDescriptionfinal class
SPI-related settings. -
Uses of Incubating in org.hibernate.search.mapper.orm.coordination.outboxpolling.mapping
Modifier and TypeInterfaceDescriptioninterface
Exposes some utilities to handle aborted events, which are events that have been processed many times without success. -
Uses of Incubating in org.hibernate.search.mapper.orm.mapping
Modifier and TypeMethodDescriptionHibernateOrmMappingConfigurationContext.containerExtractors()
Starts the definition of container extractors available for use in mappings.void
SearchMapping.indexingPlanFilter
(SearchIndexingPlanFilter filter) Set a filter defining which types must be included/excluded when indexed within indexing plans (either automatically or manually). -
Uses of Incubating in org.hibernate.search.mapper.orm.massindexing
Modifier and TypeMethodDescriptionMassIndexer.environment
(MassIndexingEnvironment environment) Sets theMassIndexingEnvironment
, which can set up an environment (thread locals, ...) in mass indexing threads.MassIndexer.failureFloodingThreshold
(long threshold) Sets the threshold for failures that will be reported and sent toMassIndexingFailureHandler
per indexed type.MassIndexer.limitIndexedObjectsTo
(long maximum) Stops indexing after having indexed a set amount of objects. -
Uses of Incubating in org.hibernate.search.mapper.orm.schema.management
Modifier and TypeMethodDescriptionvoid
SearchSchemaManager.exportExpectedSchema
(Path targetDirectory) Exports the schema represented by this schema manager as a file tree created within the provided target directory.void
SearchSchemaManager.exportExpectedSchema
(SearchSchemaCollector collector) Accepts a collector that walks through schema exports created from indexes represented by this schema manager. -
Uses of Incubating in org.hibernate.search.mapper.orm.session
Modifier and TypeMethodDescriptionvoid
SearchSession.indexingPlanFilter
(SearchIndexingPlanFilter filter) Set a filter configuration and define which types must be included/excluded when indexed within indexing plans of the current session (either automatically or manually). -
Uses of Incubating in org.hibernate.search.mapper.pojo.bridge.binding
Modifier and TypeMethodDescriptionIdentifierBindingContext.bridgedElement()
PropertyBindingContext.bridgedElement()
RoutingBindingContext.bridgedElement()
TypeBindingContext.bridgedElement()
ValueBindingContext.bridgedElement()
-
Uses of Incubating in org.hibernate.search.mapper.pojo.bridge.builtin.annotation
Modifier and TypeClassDescription@interface
Mark the property as an alternative discriminator for use inAlternativeBinder
. -
Uses of Incubating in org.hibernate.search.mapper.pojo.bridge.builtin.programmatic
Modifier and TypeInterfaceDescriptioninterface
The binder that sets upAlternativeValueBridge
s.interface
The component responsible for binding one field per alternative, and creating anAlternativeValueBridge
.interface
A binder for markers that mark a property as the discriminator for alternatives for anAlternative bridge
.interface
A component that routes field values to one of multiple index fields based on a discriminator. -
Uses of Incubating in org.hibernate.search.mapper.pojo.bridge.mapping
Modifier and TypeMethodDescription<T> DefaultBinderDefinitionStep<?>
BridgesConfigurationContext.strictSubTypesOf
(Class<T> clazz) Define default binders for properties of a subtype of the given type.<T> DefaultBinderDefinitionStep<?>
BridgesConfigurationContext.subTypesOf
(Class<T> clazz) Define default binders for properties with the given type or a subtype. -
Uses of Incubating in org.hibernate.search.mapper.pojo.extractor
Modifier and TypeInterfaceDescriptioninterface
interface
ContainerExtractor<C,
V> An extractor of values from a container.interface
A context to assign names to container extractor implementations.interface
ValueProcessor<T,
V, C> A processor of values extracted from a container. -
Uses of Incubating in org.hibernate.search.mapper.pojo.mapping.definition.annotation
Modifier and TypeMethodDescriptionAnnotationMappingConfigurationContext.addJandexIndex
(org.jboss.jandex.IndexView jandexIndex) -
Uses of Incubating in org.hibernate.search.mapper.pojo.mapping.definition.programmatic
Modifier and TypeMethodDescriptionPropertyMappingIndexedEmbeddedStep.excludePaths
(String... paths) PropertyMappingIndexedEmbeddedStep.excludePaths
(Collection<String> paths) -
Uses of Incubating in org.hibernate.search.mapper.pojo.massindexing
Modifier and TypeInterfaceDescriptioninterface
An interface for pluggable components that set up and tear down the environment of mass indexing threads, for example, to initializeThreadLocals
.Modifier and TypeMethodDescriptiondefault long
MassIndexingFailureHandler.failureFloodingThreshold()
Returns the number of failures during one mass indexing beyond which the failure handler will no longer be notified. -
Uses of Incubating in org.hibernate.search.mapper.pojo.massindexing.spi
Modifier and TypeMethodDescriptionPojoMassIndexer.environment
(MassIndexingEnvironment environment) Sets theMassIndexingEnvironment
, which can set up an environment (thread locals, ...) in mass indexing threads.PojoMassIndexer.failureFloodingThreshold
(long threshold) Sets the threshold for failures that will be reported and sent toMassIndexingFailureHandler
per indexed type. -
Uses of Incubating in org.hibernate.search.mapper.pojo.model
Modifier and TypeInterfaceDescriptioninterface
An accessor allowing the retrieval of an element, for example a property, from a POJO.interface
A potentially composite element in the POJO model.interface
A model element representing a constructor parameter to bind.interface
An element in the POJO model.interface
A model element representing a property bound to a bridge.interface
A model element representing a type bound to a bridge.interface
A model element representing a value bound to a bridge. -
Uses of Incubating in org.hibernate.search.mapper.pojo.model.dependency
Modifier and TypeInterfaceDescriptioninterface
Modifier and TypeMethodDescriptionPojoPropertyIndexingDependencyConfigurationContext.fromOtherEntity
(Class<?> otherEntityType, String pathFromOtherEntityTypeToBridgedType) Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.PojoPropertyIndexingDependencyConfigurationContext.fromOtherEntity
(Class<?> otherEntityType, PojoModelPathValueNode pathFromOtherEntityTypeToBridgedType) Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.PojoPropertyIndexingDependencyConfigurationContext.fromOtherEntity
(ContainerExtractorPath extractorPathFromBridgedProperty, Class<?> otherEntityType, PojoModelPathValueNode pathFromOtherEntityTypeToBridgedPropertyExtractedType) Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.PojoTypeIndexingDependencyConfigurationContext.fromOtherEntity
(Class<?> otherEntityType, String pathFromOtherEntityTypeToBridgedType) Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.PojoTypeIndexingDependencyConfigurationContext.fromOtherEntity
(Class<?> otherEntityType, PojoModelPathValueNode pathFromOtherEntityTypeToBridgedType) Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.PojoOtherEntityIndexingDependencyConfigurationContext.use
(String pathFromOtherEntityTypeToUsedValue) Declare that the given path is read by the bridge at index time to populate the indexed document.PojoOtherEntityIndexingDependencyConfigurationContext.use
(PojoModelPathValueNode pathFromBridgedTypeToUsedValue) Declare that the given path is read by the bridge at index time to populate the indexed document. -
Uses of Incubating in org.hibernate.search.mapper.pojo.schema.management.spi
Modifier and TypeMethodDescriptionvoid
PojoScopeSchemaManager.exportExpectedSchema
(Path targetDirectory) void
PojoScopeSchemaManager.exportExpectedSchema
(SearchSchemaCollector collector) -
Uses of Incubating in org.hibernate.search.mapper.pojo.search.definition.binding
Modifier and TypeInterfaceDescriptioninterface
A component able to define a projection using the Hibernate Search Projection DSL.interface
The context passed toProjectionBinder.bind(ProjectionBindingContext)
.interface
The context returned byProjectionBindingContext.multi()
.Modifier and TypeMethodDescriptionProjectionBindingContext.constructorParameter()
ProjectionBindingMultiContext.containerElement()
<T> BeanHolder<? extends ProjectionDefinition<T>>
ProjectionBindingContext.createCompositeDefinition
(Class<T> projectedType) <T> BeanHolder<? extends ProjectionDefinition<T>>
ProjectionBindingContext.createObjectDefinition
(String fieldPath, Class<T> projectedType, TreeFilterDefinition filter) <T> BeanHolder<? extends ProjectionDefinition<List<T>>>
ProjectionBindingContext.createObjectDefinitionMulti
(String fieldPath, Class<T> projectedType, TreeFilterDefinition filter) Optional<? extends ProjectionBindingMultiContext>
ProjectionBindingContext.multi()
Inspects the type of theProjectionBindingContext.constructorParameter()
to determine if it may be bound to a multi-valued projection. -
Uses of Incubating in org.hibernate.search.mapper.pojo.work
Modifier and TypeInterfaceDescriptioninterface
Determines how the thread will block upon committing a transaction where indexed entities were modified.interface
final class
The names of built-in indexing plan synchronization strategies.interface
interface
Configurer implementers are responsible for specifying which types should be included/excluded from indexing.interface
A context that helps with the indexing plan filter configuration.Modifier and TypeMethodDescriptionvoid
IndexingPlanSynchronizationStrategyConfigurationContext.operationSubmitter
(OperationSubmitter operationSubmitter) Set operation submitter to be applied while executing underlying plans. -
Uses of Incubating in org.hibernate.search.mapper.pojo.work.spi
-
Uses of Incubating in org.hibernate.search.util.common.spi
Modifier and TypeInterfaceDescriptioninterface
Implemented by classes that can be rendered to a string representing a tree.interface
An appender for use inToStringTreeAppendable
.