Uses of Annotation Interface
org.hibernate.search.util.common.annotation.Incubating

Packages that use Incubating

Package	Description
org.hibernate.search.backend.elasticsearch.schema.management
org.hibernate.search.backend.elasticsearch.search.query
org.hibernate.search.backend.elasticsearch.search.query.dsl
org.hibernate.search.backend.elasticsearch.work.spi
org.hibernate.search.backend.lucene.index
org.hibernate.search.backend.lucene.schema.management
org.hibernate.search.backend.lucene.search.projection.dsl
org.hibernate.search.backend.lucene.work.spi
org.hibernate.search.engine.backend
org.hibernate.search.engine.backend.analysis
org.hibernate.search.engine.backend.analysis.spi
org.hibernate.search.engine.backend.document.model.dsl
org.hibernate.search.engine.backend.document.model.dsl.spi
org.hibernate.search.engine.backend.index
org.hibernate.search.engine.backend.metamodel
org.hibernate.search.engine.backend.schema.management.spi
org.hibernate.search.engine.backend.types
org.hibernate.search.engine.backend.types.converter.spi
org.hibernate.search.engine.backend.types.dsl
org.hibernate.search.engine.backend.work.execution
org.hibernate.search.engine.cfg.spi
org.hibernate.search.engine.common.execution.spi
org.hibernate.search.engine.common.schema.management
org.hibernate.search.engine.common.timing
org.hibernate.search.engine.environment.classpath.spi
org.hibernate.search.engine.mapper.mapping.building.spi
org.hibernate.search.engine.reporting
org.hibernate.search.engine.search.aggregation.dsl
org.hibernate.search.engine.search.common
org.hibernate.search.engine.search.common.spi
org.hibernate.search.engine.search.predicate.definition
org.hibernate.search.engine.search.predicate.dsl
org.hibernate.search.engine.search.predicate.spi
org.hibernate.search.engine.search.projection
org.hibernate.search.engine.search.projection.definition
org.hibernate.search.engine.search.projection.definition.spi
org.hibernate.search.engine.search.projection.dsl
org.hibernate.search.engine.search.query.dsl
org.hibernate.search.engine.search.query.spi
org.hibernate.search.engine.search.reference
org.hibernate.search.engine.search.reference.aggregation
org.hibernate.search.engine.search.reference.object
org.hibernate.search.engine.search.reference.predicate
org.hibernate.search.engine.search.reference.projection
org.hibernate.search.engine.search.reference.sort
org.hibernate.search.engine.search.sort.dsl
org.hibernate.search.jakarta.batch.jberet
org.hibernate.search.mapper.orm.automaticindexing.session
org.hibernate.search.mapper.orm.mapping
org.hibernate.search.mapper.orm.massindexing
org.hibernate.search.mapper.orm.outboxpolling
org.hibernate.search.mapper.orm.outboxpolling.cfg
org.hibernate.search.mapper.orm.outboxpolling.cfg.spi
org.hibernate.search.mapper.orm.outboxpolling.mapping
org.hibernate.search.mapper.orm.schema.management
org.hibernate.search.mapper.orm.scope
org.hibernate.search.mapper.orm.session
org.hibernate.search.mapper.pojo.bridge
org.hibernate.search.mapper.pojo.bridge.binding
org.hibernate.search.mapper.pojo.bridge.binding.spi
org.hibernate.search.mapper.pojo.bridge.builtin.annotation
org.hibernate.search.mapper.pojo.bridge.builtin.programmatic
org.hibernate.search.mapper.pojo.bridge.mapping
org.hibernate.search.mapper.pojo.extractor
org.hibernate.search.mapper.pojo.mapping.definition.annotation
org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.spi
org.hibernate.search.mapper.pojo.mapping.definition.programmatic
org.hibernate.search.mapper.pojo.massindexing
org.hibernate.search.mapper.pojo.massindexing.spi
org.hibernate.search.mapper.pojo.model
org.hibernate.search.mapper.pojo.model.dependency
org.hibernate.search.mapper.pojo.model.spi
org.hibernate.search.mapper.pojo.schema.management.spi
org.hibernate.search.mapper.pojo.search.definition.binding
org.hibernate.search.mapper.pojo.standalone.bootstrap.spi
org.hibernate.search.mapper.pojo.standalone.cfg
org.hibernate.search.mapper.pojo.standalone.cfg.spi
org.hibernate.search.mapper.pojo.standalone.entity
org.hibernate.search.mapper.pojo.standalone.loading
org.hibernate.search.mapper.pojo.standalone.loading.binding
org.hibernate.search.mapper.pojo.standalone.loading.dsl
org.hibernate.search.mapper.pojo.standalone.mapping
org.hibernate.search.mapper.pojo.standalone.mapping.metadata
org.hibernate.search.mapper.pojo.standalone.massindexing
org.hibernate.search.mapper.pojo.standalone.schema.management
org.hibernate.search.mapper.pojo.standalone.scope
org.hibernate.search.mapper.pojo.standalone.session
org.hibernate.search.mapper.pojo.standalone.work
org.hibernate.search.mapper.pojo.tenancy
org.hibernate.search.mapper.pojo.tenancy.spi
org.hibernate.search.mapper.pojo.work
org.hibernate.search.mapper.pojo.work.spi
org.hibernate.search.util.common.spi

Uses of Incubating in org.hibernate.search.backend.elasticsearch.schema.management

Classes in org.hibernate.search.backend.elasticsearch.schema.management with annotations of type Incubating

Modifier and Type	Interface	Description
interface	ElasticsearchIndexSchemaExport	Extended version of an SchemaExport that exposes any Elasticsearch-specific methods.

Uses of Incubating in org.hibernate.search.backend.elasticsearch.search.query

Classes in org.hibernate.search.backend.elasticsearch.search.query with annotations of type Incubating

Modifier and Type	Interface	Description
interface	ElasticsearchSearchRequestTransformer	A pluggable component that gets the chance to transform search requests (path, body, ...)
interface	ElasticsearchSearchRequestTransformerContext	The context passed to ElasticsearchSearchRequestTransformer.transform(ElasticsearchSearchRequestTransformerContext).

Methods in org.hibernate.search.backend.elasticsearch.search.query with annotations of type Incubating

Modifier and Type	Method	Description
com.google.gson.JsonObject	ElasticsearchSearchResult.responseBody()

Uses of Incubating in org.hibernate.search.backend.elasticsearch.search.query.dsl

Methods in org.hibernate.search.backend.elasticsearch.search.query.dsl with annotations of type Incubating

Modifier and Type	Method	Description
ElasticsearchSearchQueryOptionsStep<SR,H,LOS>	ElasticsearchSearchQueryOptionsStep.requestTransformer(ElasticsearchSearchRequestTransformer transformer)	Set the ElasticsearchSearchRequestTransformer for this search query.

Uses of Incubating in org.hibernate.search.backend.elasticsearch.work.spi

Classes in org.hibernate.search.backend.elasticsearch.work.spi with annotations of type Incubating

Modifier and Type	Interface	Description
interface	ElasticsearchWorkExecutorProvider

Uses of Incubating in org.hibernate.search.backend.lucene.index

Methods in org.hibernate.search.backend.lucene.index with annotations of type Incubating

Modifier and Type	Method	Description
CompletionStage<Long>	LuceneIndexManager.computeSizeInBytesAsync(OperationSubmitter operationSubmitter)

Uses of Incubating in org.hibernate.search.backend.lucene.schema.management

Classes in org.hibernate.search.backend.lucene.schema.management with annotations of type Incubating

Modifier and Type	Interface	Description
interface	LuceneIndexSchemaExport	Extended version of an SchemaExport that exposes any Lucene-specific methods.

Uses of Incubating in org.hibernate.search.backend.lucene.search.projection.dsl

Classes in org.hibernate.search.backend.lucene.search.projection.dsl with annotations of type Incubating

Modifier and Type	Interface	Description
interface	DocumentTree	Represents an indexed document tree.

Methods in org.hibernate.search.backend.lucene.search.projection.dsl with annotations of type Incubating

Modifier and Type	Method	Description
ProjectionFinalStep<DocumentTree>	LuceneSearchProjectionFactory.documentTree()	Project to a DocumentTree containing all the stored fields and nested documents.

Uses of Incubating in org.hibernate.search.backend.lucene.work.spi

Classes in org.hibernate.search.backend.lucene.work.spi with annotations of type Incubating

Modifier and Type	Interface	Description
interface	LuceneWorkExecutorProvider

Uses of Incubating in org.hibernate.search.engine.backend

Methods in org.hibernate.search.engine.backend with annotations of type Incubating

Modifier and Type	Method	Description
Optional<String>	Backend.name()

Uses of Incubating in org.hibernate.search.engine.backend.analysis

Classes in org.hibernate.search.engine.backend.analysis with annotations of type Incubating

Modifier and Type	Interface	Description
interface	AnalysisDescriptor	A descriptor of an abstract analysis concept.
interface	AnalysisToken	Represents a token produced by the analysis.
interface	AnalyzerDescriptor	A descriptor of an analyzer, exposing in particular the name of the analyzer.
interface	NormalizerDescriptor	A descriptor of a normalizer, exposing in particular the name of the normalizer.

Uses of Incubating in org.hibernate.search.engine.backend.analysis.spi

Classes in org.hibernate.search.engine.backend.analysis.spi with annotations of type Incubating

Modifier and Type	Interface	Description
interface	AnalysisDescriptorRegistry

Uses of Incubating in org.hibernate.search.engine.backend.document.model.dsl

Classes in org.hibernate.search.engine.backend.document.model.dsl with annotations of type Incubating

Modifier and Type	Interface	Description
interface	IndexSchemaNamedPredicateOptionsStep	The final step in the definition of a named predicate in the index schema.

Methods in org.hibernate.search.engine.backend.document.model.dsl with annotations of type Incubating

Modifier and Type	Method	Description
IndexSchemaNamedPredicateOptionsStep	IndexSchemaElement.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

Classes in org.hibernate.search.engine.backend.document.model.dsl.spi with annotations of type Incubating

Modifier and Type	Interface	Description
interface	ImplicitFieldCollector
interface	ImplicitFieldContributor	Opens an extension point to accept implicit fields.

Uses of Incubating in org.hibernate.search.engine.backend.index

Methods in org.hibernate.search.engine.backend.index with annotations of type Incubating

Modifier and Type	Method	Description
List<? extends AnalysisToken>	IndexManager.analyze(String analyzerName, String terms)	Applies the analyzer to a given string to produce a list of tokens.
CompletionStage<List<? extends AnalysisToken>>	IndexManager.analyzeAsync(String analyzerName, String terms, OperationSubmitter operationSubmitter)	Applies the analyzer to a given string to produce a list of tokens in an async manner.
AnalysisToken	IndexManager.normalize(String normalizerName, String terms)	Applies the normalizer to a given string to produce a normalized token.
CompletionStage<AnalysisToken>	IndexManager.normalizeAsync(String normalizerName, String terms, OperationSubmitter operationSubmitter)	Applies the normalizer to a given string to produce a normalized token in an async manner.

Uses of Incubating in org.hibernate.search.engine.backend.metamodel

Methods in org.hibernate.search.engine.backend.metamodel with annotations of type Incubating

Modifier and Type	Method	Description
Optional<? extends AnalyzerDescriptor>	IndexDescriptor.analyzer(String name)	Looks up the configured analyzers available to the index represented by this descriptor.
Collection<? extends AnalyzerDescriptor>	IndexDescriptor.analyzers()
boolean	IndexValueFieldTypeDescriptor.multivaluable()
Optional<? extends NormalizerDescriptor>	IndexDescriptor.normalizer(String name)	Looks up the configured normalizers available to the index represented by this descriptor.
Collection<? extends NormalizerDescriptor>	IndexDescriptor.normalizers()

Uses of Incubating in org.hibernate.search.engine.backend.schema.management.spi

Methods in org.hibernate.search.engine.backend.schema.management.spi with annotations of type Incubating

Modifier and Type	Method	Description
void	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.types

Classes in org.hibernate.search.engine.backend.types with annotations of type Incubating

Modifier and Type	Class	Description
enum	VectorSimilarity	Defines a function to calculate the vector similarity, i.e. distance between two vectors.

Uses of Incubating in org.hibernate.search.engine.backend.types.converter.spi

Classes in org.hibernate.search.engine.backend.types.converter.spi with annotations of type Incubating

Modifier and Type	Class	Description
final class	DefaultStringConverters

Methods in org.hibernate.search.engine.backend.types.converter.spi with annotations of type Incubating

Modifier and Type	Method	Description
ToDocumentValueConverter<V,? extends F>	DslConverter.delegate()

Uses of Incubating in org.hibernate.search.engine.backend.types.dsl

Classes in org.hibernate.search.engine.backend.types.dsl with annotations of type Incubating

Modifier and Type	Interface	Description
interface	VectorFieldTypeOptionsStep<S extends VectorFieldTypeOptionsStep<?,F>,F>	The initial and final step in a "vector" index field type definition, where optional parameters can be set.

Methods in org.hibernate.search.engine.backend.types.dsl with annotations of type Incubating

Modifier and Type	Method	Description
VectorFieldTypeOptionsStep<?,byte[]>	IndexFieldTypeFactory.asByteVector()	Define a field type intended for use in vector search and whose values are represented as a byte[] in Hibernate Search.
VectorFieldTypeOptionsStep<?,float[]>	IndexFieldTypeFactory.asFloatVector()	Define a field type intended for use in vector search and whose values are represented as a float[] in Hibernate Search.
<F> VectorFieldTypeOptionsStep<?,F>	IndexFieldTypeFactory.asVector(Class<F> valueType)	Define a vector field type whose values are represented as a given type in Hibernate Search.
S	IndexFieldTypeConverterStep.formatter(FromDocumentValueConverter<? super F,String> formatter)	Define how values returned when projecting on fields of this type should be formatted to string before being returned to the user, when ValueModel.STRING is used.
S	IndexFieldTypeConverterStep.parser(ToDocumentValueConverter<String,? extends F> parser)	Define how string values passed to the predicate and sort DSL should be converted to the type of field values, when ValueModel.STRING is used, or when parsing query strings (local backends only, e.g.

Uses of Incubating in org.hibernate.search.engine.backend.work.execution

Classes in org.hibernate.search.engine.backend.work.execution with annotations of type Incubating

Modifier and Type	Class	Description
class	OperationSubmitter	Interface defining how operation should be submitted to the queue or executor.

Uses of Incubating in org.hibernate.search.engine.cfg.spi

Classes in org.hibernate.search.engine.cfg.spi with annotations of type Incubating

Modifier and Type	Interface	Description
interface	ConfigurationProvider	Allows integrators to provide their default configuration properties for various scopes that would override Hibernate Search specific ones.
final class	ConfigurationScope	Holds a configuration scope.
final class	ConfigurationScopeNamespaces	Names of configuration scope namespaces used to construct a ConfigurationScope.
final class	FormatUtils

Uses of Incubating in org.hibernate.search.engine.common.execution.spi

Classes in org.hibernate.search.engine.common.execution.spi with annotations of type Incubating

Modifier and Type	Class	Description
class	DelegatingSimpleScheduledExecutor
interface	SimpleScheduledExecutor

Uses of Incubating in org.hibernate.search.engine.common.schema.management

Classes in org.hibernate.search.engine.common.schema.management with annotations of type Incubating

Modifier and Type	Interface	Description
interface	SchemaExport
interface	SchemaExportExtension<T>	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

Classes in org.hibernate.search.engine.common.timing with annotations of type Incubating

Modifier and Type	Interface	Description
interface	Deadline	Common interface providing a deadline through the method Deadline.checkRemainingTimeMillis().

Uses of Incubating in org.hibernate.search.engine.environment.classpath.spi

Methods in org.hibernate.search.engine.environment.classpath.spi with annotations of type Incubating

Modifier and Type	Method	Description
<S> Collection<S>	ClassResolver.loadJavaServices(Class<S> serviceType)	Discovers and instantiates implementations of the given Java service contract.
URL	ClassResolver.locateResource(String resourceName)	Locate a resource by name
Package	ClassResolver.packageForName(String packageName)	Locate a pacakge by name.

Uses of Incubating in org.hibernate.search.engine.mapper.mapping.building.spi

Methods in org.hibernate.search.engine.mapper.mapping.building.spi with annotations of type Incubating

Modifier and Type	Method	Description
void	IndexedEntityBindingContext.idParser(ToDocumentValueConverter<String,String> parser)

Uses of Incubating in org.hibernate.search.engine.reporting

Methods in org.hibernate.search.engine.reporting with annotations of type Incubating

Modifier and Type	Method	Description
default 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

Classes in org.hibernate.search.engine.search.aggregation.dsl with annotations of type Incubating

Modifier and Type	Interface	Description
interface	AvgAggregationFieldStep<SR,PDF extends SearchPredicateFactory<SR>>	The initial step in an "avg" aggregation definition, where the target field can be set.
interface	AvgAggregationOptionsStep<SR,S extends AvgAggregationOptionsStep<SR,?,PDF,F>,PDF extends SearchPredicateFactory<SR>,F>	The final step in a "avg" aggregation definition, where optional parameters can be set.
interface	CountAggregationFieldStep<SR,PDF extends SearchPredicateFactory<SR>>	The initial step in a "count" aggregation definition, where the target field can be set.
interface	CountAggregationOptionsStep<SR,S extends CountAggregationOptionsStep<SR,?,PDF>,PDF extends SearchPredicateFactory<SR>>	The final step in a "count" aggregation definition, where optional parameters can be set.
interface	CountDistinctAggregationFieldStep<SR,PDF extends SearchPredicateFactory<SR>>	The initial step in a "count distinct" aggregation definition, where the target field can be set.
interface	CountDistinctAggregationOptionsStep<SR,S extends CountDistinctAggregationOptionsStep<SR,?,PDF>,PDF extends SearchPredicateFactory<SR>>	The final step in a "count distinct" aggregation definition, where optional parameters can be set.
interface	MaxAggregationFieldStep<SR,PDF extends SearchPredicateFactory<SR>>	The initial step in a "min" aggregation definition, where the target field can be set.
interface	MaxAggregationOptionsStep<SR,S extends MaxAggregationOptionsStep<SR,?,PDF,F>,PDF extends SearchPredicateFactory<SR>,F>	The final step in a "max" aggregation definition, where optional parameters can be set.
interface	MinAggregationFieldStep<SR,PDF extends SearchPredicateFactory<SR>>	The initial step in a "min" aggregation definition, where the target field can be set.
interface	MinAggregationOptionsStep<SR,S extends MinAggregationOptionsStep<SR,?,PDF,F>,PDF extends SearchPredicateFactory<SR>,F>	The final step in a "min" aggregation definition, where optional parameters can be set.
interface	SumAggregationFieldStep<SR,PDF extends SearchPredicateFactory<SR>>	The initial step in a "sum" aggregation definition, where the target field can be set.
interface	SumAggregationOptionsStep<SR,S extends SumAggregationOptionsStep<SR,?,PDF,F>,PDF extends SearchPredicateFactory<SR>,F>	The final step in a "sum" aggregation definition, where optional parameters can be set.

Methods in org.hibernate.search.engine.search.aggregation.dsl with annotations of type Incubating

Modifier and Type	Method	Description
AvgAggregationFieldStep<SR,?>	SearchAggregationFactory.avg()	Perform the avg metric aggregation.
CountAggregationFieldStep<SR,?>	SearchAggregationFactory.count()	Perform the count metric aggregation.
CountDistinctAggregationFieldStep<SR,?>	SearchAggregationFactory.countDistinct()	Perform the count distinct metric aggregation.
default <F> AvgAggregationOptionsStep<SR,?,PDF,F>	AvgAggregationFieldStep.field(AvgAggregationFieldReference<SR,F> fieldReference)	Target the given field in the avg aggregation.
default CountAggregationOptionsStep<SR,?,PDF>	CountAggregationFieldStep.field(CountAggregationFieldReference<SR> fieldReference)	Target the given field in the avg aggregation.
default CountDistinctAggregationOptionsStep<SR,?,PDF>	CountDistinctAggregationFieldStep.field(CountAggregationFieldReference<SR> fieldReference)	Target the given field in the avg aggregation.
default <F> MaxAggregationOptionsStep<SR,?,PDF,F>	MaxAggregationFieldStep.field(MaxAggregationFieldReference<SR,F> fieldReference)	Target the given field in the avg aggregation.
default <F> MinAggregationOptionsStep<SR,?,PDF,F>	MinAggregationFieldStep.field(MinAggregationFieldReference<SR,F> fieldReference)	Target the given field in the avg aggregation.
default <F> SumAggregationOptionsStep<SR,?,PDF,F>	SumAggregationFieldStep.field(SumAggregationFieldReference<SR,F> fieldReference)	Target the given field in the avg aggregation.
MaxAggregationFieldStep<SR,?>	SearchAggregationFactory.max()	Perform the max metric aggregation.
MinAggregationFieldStep<SR,?>	SearchAggregationFactory.min()	Perform the min metric aggregation.
SumAggregationFieldStep<SR,?>	SearchAggregationFactory.sum()	Perform the sum metric aggregation.
String	SearchAggregationFactory.toAbsolutePath(String relativeFieldPath)
<T> AggregationFinalStep<T>	SearchAggregationFactory.withParameters(Function<? super NamedValues,? extends AggregationFinalStep<T>> aggregationCreator)	Delegating aggregation that creates the actual aggregation at query create time and provides access to query parameters.
SearchAggregationFactory<SR>	SearchAggregationFactory.withRoot(String objectFieldPath)	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.common

Classes in org.hibernate.search.engine.search.common with annotations of type Incubating

Modifier and Type	Interface	Description
interface	NamedValues

Uses of Incubating in org.hibernate.search.engine.search.common.spi

Classes in org.hibernate.search.engine.search.common.spi with annotations of type Incubating

Modifier and Type	Class	Description
class	MapNamedValues
protected static interface	MapNamedValues.NamedValueIncorrectType
protected static interface	MapNamedValues.NamedValueMissing

Methods in org.hibernate.search.engine.search.common.spi with annotations of type Incubating

Modifier and Type	Method	Description
ProjectionConverter<F,?>	SearchIndexValueFieldTypeContext.formatterProjectionConverter()
DslConverter<?,String>	SearchIndexIdentifierContext.parserDslConverter()
DslConverter<?,F>	SearchIndexValueFieldTypeContext.parserDslConverter()

Uses of Incubating in org.hibernate.search.engine.search.predicate.definition

Classes in org.hibernate.search.engine.search.predicate.definition with annotations of type Incubating

Modifier and Type	Interface	Description
interface	PredicateDefinition	A component able to define a predicate using the Hibernate Search Predicate DSL.
interface	PredicateDefinitionContext<SR>	The context passed to PredicateDefinition.create(PredicateDefinitionContext<SR>).

Uses of Incubating in org.hibernate.search.engine.search.predicate.dsl

Classes in org.hibernate.search.engine.search.predicate.dsl with annotations of type Incubating

Modifier and Type	Interface	Description
interface	NamedPredicateOptionsStep	The initial and final step in named predicate definition.

Methods in org.hibernate.search.engine.search.predicate.dsl with annotations of type Incubating

Modifier and Type	Method	Description
default S	CommonQueryStringPredicateFieldMoreStep.field(FR fieldReference)	Target the given field in the query string predicate, as an alternative to the already-targeted fields.
default N	CommonQueryStringPredicateFieldStep.field(FR fieldReference)	Target the given field in the query string predicate.
default N	ExistsPredicateFieldStep.field(ExistsPredicateFieldReference<? super SR> fieldReference)	Target the given field in the "exists" predicate.
default S	PhrasePredicateFieldMoreStep.field(PhrasePredicateFieldReference<? super SR,?> fieldReference)	Target the given field in the phrase predicate, as an alternative to the already-targeted fields.
default N	PhrasePredicateFieldStep.field(PhrasePredicateFieldReference<? super SR,?> fieldReference)	Target the given field in the phrase predicate.
default S	PrefixPredicateFieldMoreStep.field(PrefixPredicateFieldReference<SR> fieldReference)	Target the given field in the prefix predicate.
default N	PrefixPredicateFieldStep.field(PrefixPredicateFieldReference<SR> fieldReference)	Target the given field in the prefix predicate.
default S	RegexpPredicateFieldMoreStep.field(RegexpPredicateFieldReference<SR> fieldReference)	Target the given field in the regexp predicate.
default N	RegexpPredicateFieldStep.field(RegexpPredicateFieldReference<SR> fieldReference)	Target the given field in the regexp predicate.
default S	TermsPredicateFieldMoreStep.field(TermsPredicateFieldReference<SR> fieldReference)	Target the given field in the terms predicate.
default N	TermsPredicateFieldStep.field(TermsPredicateFieldReference<SR> fieldReference)	Target the given field in the terms predicate.
default S	CommonQueryStringPredicateFieldMoreStep.fields(FR... fieldReferences)	Target the given fields in the query string predicate, as an alternative to the already-targeted fields.
default N	CommonQueryStringPredicateFieldStep.fields(FR... fieldReferences)	Target the given fields in the query string predicate.
default S	PhrasePredicateFieldMoreStep.fields(PhrasePredicateFieldReference<? super SR,?>... fields)	Target the given fields in the phrase predicate, as an alternative to the already-targeted fields.
default N	PhrasePredicateFieldStep.fields(PhrasePredicateFieldReference<? super SR,?>... fields)	Target the given fields in the phrase predicate.
default S	PrefixPredicateFieldMoreStep.fields(PrefixPredicateFieldReference<SR>... fields)	Target the given fields in the prefix predicate.
default N	PrefixPredicateFieldStep.fields(PrefixPredicateFieldReference<SR>... fields)	Target the given fields in the prefix predicate.
default S	RegexpPredicateFieldMoreStep.fields(RegexpPredicateFieldReference<SR>... fields)	Target the given fields in the regexp predicate.
default N	RegexpPredicateFieldStep.fields(RegexpPredicateFieldReference<SR>... fields)	Target the given fields in the regexp predicate.
default S	TermsPredicateFieldMoreStep.fields(TermsPredicateFieldReference<SR>... fields)	Target the given fields in the terms predicate.
default N	TermsPredicateFieldStep.fields(TermsPredicateFieldReference<SR>... fields)	Target the given fields in the terms predicate.
default S	WildcardPredicateFieldMoreStep.fields(WildcardPredicateFieldReference<SR>... fields)	Target the given fields in the wildcard predicate.
default N	WildcardPredicateFieldStep.fields(WildcardPredicateFieldReference<SR>... fields)	Target the given fields in the wildcard predicate.
NamedPredicateOptionsStep	SearchPredicateFactory.named(String path)	Match documents if they match a combination of defined named predicate clauses.
KnnPredicateOptionsStep<SR>	KnnPredicateOptionsStep.requiredMinimumScore(float score)
String	SearchPredicateFactory.toAbsolutePath(String relativeFieldPath)
PredicateFinalStep	SearchPredicateFactory.withParameters(Function<? super NamedValues,? extends PredicateFinalStep> predicateCreator)	Delegating predicate that creates the actual predicate at query create time and provides access to query parameters.
SearchPredicateFactory<SR>	SearchPredicateFactory.withRoot(String objectFieldPath)	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.predicate.spi

Classes in org.hibernate.search.engine.search.predicate.spi with annotations of type Incubating

Modifier and Type	Interface	Description
interface	KnnPredicateBuilder
final class	NamedValuesBasedPredicateDefinitionContext<SR>

Uses of Incubating in org.hibernate.search.engine.search.projection

Classes in org.hibernate.search.engine.search.projection with annotations of type Incubating

Modifier and Type	Interface	Description
interface	ProjectionCollector<E,V,A,R>	A variation on Collector suitable for projections on field values.
interface	ProjectionCollectorProviderFactory	Defines the factory that can create projection collector providers based on a container type R and container element type U.

Uses of Incubating in org.hibernate.search.engine.search.projection.definition

Classes in org.hibernate.search.engine.search.projection.definition with annotations of type Incubating

Modifier and Type	Interface	Description
interface	ProjectionDefinition<P>	A component able to define a projection using the Hibernate Search Projection DSL.
interface	ProjectionDefinitionContext	The context passed to ProjectionDefinition.create(SearchProjectionFactory, ProjectionDefinitionContext).

Uses of Incubating in org.hibernate.search.engine.search.projection.definition.spi

Classes in org.hibernate.search.engine.search.projection.definition.spi with annotations of type Incubating

Modifier and Type	Class	Description
class	AbstractProjectionDefinition<P>
final class	ConstantProjectionDefinition<T>
class	DistanceProjectionDefinition<F>
static final class	DistanceProjectionDefinition.MultiValued	Deprecated.
static final class	DistanceProjectionDefinition.SingleValued	Deprecated.
static final class	DistanceProjectionDefinition.WrappedValued<C>
class	FieldProjectionDefinition<P,F>
static final class	FieldProjectionDefinition.AccumulatedValued<C,F>
static final class	FieldProjectionDefinition.MultiValued<F>	Deprecated.
static final class	FieldProjectionDefinition.SingleValued<F>	Deprecated.
class	ObjectProjectionDefinition<P,T>
static final class	ObjectProjectionDefinition.MultiValued<T>	Deprecated.
static final class	ObjectProjectionDefinition.SingleValued<T>	Deprecated.
static final class	ObjectProjectionDefinition.WrappedValued<C,T>

Uses of Incubating in org.hibernate.search.engine.search.projection.dsl

Methods in org.hibernate.search.engine.search.projection.dsl with annotations of type Incubating

Modifier and Type	Method	Description
default CompositeProjectionOptionsStep<?,T[]>	CompositeProjectionValueStep.array(Class<T> type)	Defines the projection as multivalued, i.e. returning T[] instead of T.
default DistanceToFieldProjectionOptionsStep<?,T[]>	DistanceToFieldProjectionValueStep.array(Class<T> type)	Defines the projection as multivalued, i.e. returning T[] instead of T.
default FieldProjectionOptionsStep<?,T[]>	FieldProjectionValueStep.array(Class<T> type)	Defines the projection as multivalued, i.e. returning T[] instead of T.
default ProjectionFinalStep<String[]>	HighlightProjectionOptionsStep.array()	Changes the collection accumulating the values to String[] instead of List.
<R> CompositeProjectionOptionsStep<?,R>	CompositeProjectionValueStep.collector(ProjectionCollector.Provider<T,R> collector)	Defines how to accumulate composite projection values.
<R> DistanceToFieldProjectionOptionsStep<?,R>	DistanceToFieldProjectionValueStep.collector(ProjectionCollector.Provider<T,R> collector)	Defines how to accumulate distance projection values.
<R> FieldProjectionOptionsStep<?,R>	FieldProjectionValueStep.collector(ProjectionCollector.Provider<T,R> collector)	Defines how to accumulate field projection values.
<R> ProjectionFinalStep<R>	HighlightProjectionOptionsStep.collector(ProjectionCollector.Provider<String,R> collector)	Defines the collector to apply to the highlighted strings.
default DistanceToFieldProjectionValueStep<?,Double>	SearchProjectionFactory.distance(DistanceProjectionFieldReference<? super SR> fieldReference, GeoPoint center)	Project on the distance from the center to a GeoPoint field.
default <T> FieldProjectionValueStep<?,T>	SearchProjectionFactory.field(FieldProjectionFieldReference<? super SR,T> fieldReference)	Project to the value of a field in the indexed document.
HighlightProjectionOptionsStep	SearchProjectionFactory.highlight(String fieldPath)	Project to highlights, i.e. sequences of text that matched the query, extracted from the given field's value.
default HighlightProjectionOptionsStep	SearchProjectionFactory.highlight(HighlightProjectionFieldReference<? super SR> fieldReference)	Project to highlights, i.e. sequences of text that matched the query, extracted from the given field's value.
default CompositeProjectionOptionsStep<?,List<T>>	CompositeProjectionValueStep.list()	Defines the projection as multivalued, i.e. returning List<T> instead of T.
default DistanceToFieldProjectionOptionsStep<?,List<T>>	DistanceToFieldProjectionValueStep.list()	Defines the projection as multivalued, i.e. returning List<T> instead of T.
default FieldProjectionOptionsStep<?,List<T>>	FieldProjectionValueStep.list()	Defines the projection as multivalued, i.e. returning List<T> instead of T.
default ProjectionFinalStep<String>	HighlightProjectionOptionsStep.nullable()	Defines the projection as single-valued, i.e. returning String instead of List<String>.
default CompositeProjectionInnerStep	SearchProjectionFactory.object(ObjectFieldReference<? super SR> objectFieldReference)	Starts the definition of an object projection, which will yield one value per object in a given object field, the value being the result of combining multiple given projections (usually on fields within the object field).
default CompositeProjectionOptionsStep<?,Optional<T>>	CompositeProjectionValueStep.optional()	Defines the projection as single-valued wrapped in an Optional, i.e. returning Optional<T> instead of T.
default DistanceToFieldProjectionOptionsStep<?,Optional<T>>	DistanceToFieldProjectionValueStep.optional()	Defines the projection as single-valued wrapped in an Optional, i.e. returning Optional<T> instead of T.
default FieldProjectionOptionsStep<?,Optional<T>>	FieldProjectionValueStep.optional()	Defines the projection as single-valued wrapped in an Optional, i.e. returning Optional<T> instead of T.
default ProjectionFinalStep<Optional<String>>	HighlightProjectionOptionsStep.optional()	Defines the projection as single-valued wrapped in an Optional, i.e. returning Optional<String> instead of List<String>.
default CompositeProjectionOptionsStep<?,Set<T>>	CompositeProjectionValueStep.set()	Defines the projection as multivalued, i.e. returning Set<T> instead of T.
default DistanceToFieldProjectionOptionsStep<?,Set<T>>	DistanceToFieldProjectionValueStep.set()	Defines the projection as multivalued, i.e. returning Set<T> instead of T.
default FieldProjectionOptionsStep<?,Set<T>>	FieldProjectionValueStep.set()	Defines the projection as multivalued, i.e. returning Set<T> instead of T.
default ProjectionFinalStep<Set<String>>	HighlightProjectionOptionsStep.set()	Changes the collection accumulating the values to Set instead of List.
default CompositeProjectionOptionsStep<?,SortedSet<T>>	CompositeProjectionValueStep.sortedSet()	Defines the projection as multivalued, i.e. returning SortedSet<T> instead of T.
default CompositeProjectionOptionsStep<?,SortedSet<T>>	CompositeProjectionValueStep.sortedSet(Comparator<T> comparator)	Defines the projection as multivalued, i.e. returning SortedSet<T> instead of T.
default DistanceToFieldProjectionOptionsStep<?,SortedSet<T>>	DistanceToFieldProjectionValueStep.sortedSet()	Defines the projection as multivalued, i.e. returning SortedSet<T> instead of T.
default DistanceToFieldProjectionOptionsStep<?,SortedSet<T>>	DistanceToFieldProjectionValueStep.sortedSet(Comparator<T> comparator)	Defines the projection as multivalued, i.e. returning SortedSet<T> instead of T.
default FieldProjectionOptionsStep<?,SortedSet<T>>	FieldProjectionValueStep.sortedSet()	Defines the projection as multivalued, i.e. returning SortedSet<T> instead of T.
default FieldProjectionOptionsStep<?,SortedSet<T>>	FieldProjectionValueStep.sortedSet(Comparator<T> comparator)	Defines the projection as multivalued, i.e. returning SortedSet<T> instead of T.
default ProjectionFinalStep<SortedSet<String>>	HighlightProjectionOptionsStep.sortedSet()	Changes the collection accumulating the values to SortedSet instead of List.
default ProjectionFinalStep<SortedSet<String>>	HighlightProjectionOptionsStep.sortedSet(Comparator<String> comparator)	Changes the collection accumulating the values to SortedSet instead of List.
String	SearchProjectionFactory.toAbsolutePath(String relativeFieldPath)
<T> ProjectionFinalStep<T>	SearchProjectionFactory.withParameters(Function<? super NamedValues,? extends ProjectionFinalStep<T>> projectionCreator)	Delegating projection that creates the actual projection at query create time and provides access to query parameters.
SearchProjectionFactory<SR,R,E>	SearchProjectionFactory.withRoot(String objectFieldPath)	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

Methods in org.hibernate.search.engine.search.query.dsl with annotations of type Incubating

Modifier and Type	Method	Description
S	SearchQueryOptionsStep.highlighter(String highlighterName, Function<? super SearchHighlighterFactory,? extends HighlighterFinalStep> highlighterContributor)	Configure a named highlighter.
S	SearchQueryOptionsStep.highlighter(String highlighterName, SearchHighlighter highlighter)	Configure a named highlighter.
S	SearchQueryOptionsStep.highlighter(Function<? super SearchHighlighterFactory,? extends HighlighterFinalStep> highlighterContributor)	Configure the default highlighter.
S	SearchQueryOptionsStep.highlighter(SearchHighlighter highlighter)	Configure the default highlighter.
S	SearchQueryOptionsStep.param(String parameterName, Object value)	Add query parameter.

Uses of Incubating in org.hibernate.search.engine.search.query.spi

Classes in org.hibernate.search.engine.search.query.spi with annotations of type Incubating

Modifier and Type	Class	Description
class	QueryParameters

Methods in org.hibernate.search.engine.search.query.spi with annotations of type Incubating

Modifier and Type	Method	Description
void	SearchQueryBuilder.highlighter(String highlighterName, SearchHighlighter highlighter)
void	SearchQueryBuilder.highlighter(SearchHighlighter queryHighlighter)
void	SearchQueryBuilder.param(String parameterName, Object value)

Uses of Incubating in org.hibernate.search.engine.search.reference

Classes in org.hibernate.search.engine.search.reference with annotations of type Incubating

Modifier and Type	Interface	Description
interface	FieldReference<SR>	The most common interface for the field reference hierarchy.
interface	FieldReferences	A set of util methods to create generic field references, mostly for testing purposes or trivial cases where just a few references are required.
interface	RootReferenceScope<SR,T>

Uses of Incubating in org.hibernate.search.engine.search.reference.aggregation

Classes in org.hibernate.search.engine.search.reference.aggregation with annotations of type Incubating

Modifier and Type	Interface	Description
interface	AggregationFieldReference<SR>
final record	AnyAggregationReference<SR,T>	A generic aggregated-field reference that can be manually created and passed to any aggregation-DSL methods that require a field reference.
interface	AvgAggregationFieldReference<SR,T>
interface	CountAggregationFieldReference<SR>
interface	CountDistinctAggregationFieldReference<SR>
interface	MaxAggregationFieldReference<SR,T>
interface	MinAggregationFieldReference<SR,T>
interface	RangeAggregationFieldReference<SR,T>
interface	SumAggregationFieldReference<SR,T>
interface	TermsAggregationFieldReference<SR,T>
interface	TypedAggregationFieldReference<SR,T>

Uses of Incubating in org.hibernate.search.engine.search.reference.object

Classes in org.hibernate.search.engine.search.reference.object with annotations of type Incubating

Modifier and Type	Interface	Description
interface	FlattenedFieldReference<SR>
interface	NestedFieldReference<SR>
interface	ObjectFieldReference<SR>

Uses of Incubating in org.hibernate.search.engine.search.reference.predicate

Classes in org.hibernate.search.engine.search.reference.predicate with annotations of type Incubating

Modifier and Type	Class	Description
final record	AnyPredicateReference<SR,T>	A generic predicate-field reference that can be manually created and passed to any predicate-DSL methods that require a field reference.
interface	ExistsPredicateFieldReference<SR>
interface	KnnPredicateFieldReference<SR,T>
interface	MatchPredicateFieldReference<SR,T>
interface	NestedPredicateFieldReference<SR>
interface	PhrasePredicateFieldReference<SR,T>
interface	PredicateFieldReference<SR>
interface	PrefixPredicateFieldReference<SR>
interface	QueryStringPredicateFieldReference<SR,T>
interface	RangePredicateFieldReference<SR,T>
interface	RegexpPredicateFieldReference<SR>
interface	SimpleQueryStringPredicateFieldReference<SR,T>
interface	SpatialPredicateFieldReference<SR>
interface	TermsPredicateFieldReference<SR>
interface	TypedPredicateFieldReference<SR,T>
interface	WildcardPredicateFieldReference<SR>

Uses of Incubating in org.hibernate.search.engine.search.reference.projection

Classes in org.hibernate.search.engine.search.reference.projection with annotations of type Incubating

Modifier and Type	Class	Description
final record	AnyProjectionReference<SR,T>	A generic projected-field reference that can be manually created and passed to any projection-DSL methods that require a field reference.
interface	DistanceProjectionFieldReference<SR>
interface	FieldProjectionFieldReference<SR,T>
interface	HighlightProjectionFieldReference<SR>
interface	ObjectProjectionFieldReference<SR>
interface	ProjectionFieldReference<SR>
interface	TypedProjectionFieldReference<SR,T>

Uses of Incubating in org.hibernate.search.engine.search.reference.sort

Classes in org.hibernate.search.engine.search.reference.sort with annotations of type Incubating

Modifier and Type	Class	Description
final record	AnySortReference<SR,T>	A generic sort-field reference that can be manually created and passed to any sort-DSL methods that require a field reference.
interface	DistanceSortFieldReference<SR>
interface	FieldSortFieldReference<SR,T>
interface	ScoreSortFieldReference<SR,T>
interface	SortFieldReference<SR>
interface	TypedSortFieldReference<SR,T>

Uses of Incubating in org.hibernate.search.engine.search.sort.dsl

Methods in org.hibernate.search.engine.search.sort.dsl with annotations of type Incubating

Modifier and Type	Method	Description
default DistanceSortOptionsStep<SR,?,? extends SearchPredicateFactory<SR>>	SearchSortFactory.distance(DistanceSortFieldReference<? super SR> fieldReference, double latitude, double longitude)	Order elements by the distance from the location stored in the specified field to the location specified.
default DistanceSortOptionsStep<SR,?,? extends SearchPredicateFactory<SR>>	SearchSortFactory.distance(DistanceSortFieldReference<? super SR> fieldReference, GeoPoint location)	Order elements by the distance from the location stored in the specified field to the location specified.
<T> FieldSortOptionsGenericStep<SR,T,?,?,? extends SearchPredicateFactory<SR>>	SearchSortFactory.field(FieldSortFieldReference<? super SR,T> fieldReference)	Order elements by the value of a specific field.
String	SearchSortFactory.toAbsolutePath(String relativeFieldPath)
SortThenStep<SR>	SearchSortFactory.withParameters(Function<? super NamedValues,? extends SortFinalStep> sortCreator)	Delegating sort that creates the actual sort at query create time and provides access to query parameters.
SearchSortFactory<SR>	SearchSortFactory.withRoot(String objectFieldPath)	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.jakarta.batch.jberet

Classes in org.hibernate.search.jakarta.batch.jberet with annotations of type Incubating

Modifier and Type	Interface	Description
interface	HibernateSearchJakartaBatchMapperExtension	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of Incubating in org.hibernate.search.mapper.orm.automaticindexing.session

Methods in org.hibernate.search.mapper.orm.automaticindexing.session with annotations of type Incubating

Modifier and Type	Method	Description
void	AutomaticIndexingSynchronizationConfigurationContext.operationSubmitter(OperationSubmitter operationSubmitter)	Deprecated. Set operation submitter to be applied while executing underlying plans.

Uses of Incubating in org.hibernate.search.mapper.orm.mapping

Methods in org.hibernate.search.mapper.orm.mapping with annotations of type Incubating

Modifier and Type	Method	Description
ContainerExtractorConfigurationContext	HibernateOrmMappingConfigurationContext.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

Methods in org.hibernate.search.mapper.orm.massindexing with annotations of type Incubating

Modifier and Type	Method	Description
MassIndexer	MassIndexer.environment(MassIndexingEnvironment environment)	Sets the MassIndexingEnvironment, which can set up an environment (thread locals, ...) in mass indexing threads.
MassIndexer	MassIndexer.failFast(boolean failFast)	Enables the fail-fast option for this mass indexer.
MassIndexer	MassIndexer.failureFloodingThreshold(long threshold)	Sets the threshold for failures that will be reported and sent to MassIndexingFailureHandler per indexed type.
MassIndexer	MassIndexer.limitIndexedObjectsTo(long maximum)	Stops indexing after having indexed a set amount of objects.

Uses of Incubating in org.hibernate.search.mapper.orm.outboxpolling

Classes in org.hibernate.search.mapper.orm.outboxpolling with annotations of type Incubating

Modifier and Type	Class	Description
class	OutboxPollingExtension	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.outboxpolling.cfg

Classes in org.hibernate.search.mapper.orm.outboxpolling.cfg with annotations of type Incubating

Modifier and Type	Class	Description
final class	HibernateOrmMapperOutboxPollingSettings
enum	OutboxEventProcessingOrder
enum	PayloadType
enum	UuidGenerationStrategy

Uses of Incubating in org.hibernate.search.mapper.orm.outboxpolling.cfg.spi

Classes in org.hibernate.search.mapper.orm.outboxpolling.cfg.spi with annotations of type Incubating

Modifier and Type	Class	Description
final class	HibernateOrmMapperOutboxPollingSpiSettings	SPI-related settings.

Uses of Incubating in org.hibernate.search.mapper.orm.outboxpolling.mapping

Classes in org.hibernate.search.mapper.orm.outboxpolling.mapping with annotations of type Incubating

Modifier and Type	Interface	Description
interface	OutboxPollingSearchMapping	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.schema.management

Methods in org.hibernate.search.mapper.orm.schema.management with annotations of type Incubating

Modifier and Type	Method	Description
void	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.scope

Classes in org.hibernate.search.mapper.orm.scope with annotations of type Incubating

Modifier and Type	Interface	Description
interface	HibernateOrmRootReferenceScope<SR,T>

Uses of Incubating in org.hibernate.search.mapper.orm.session

Methods in org.hibernate.search.mapper.orm.session with annotations of type Incubating

Modifier and Type	Method	Description
void	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).
<SR, T> SearchQuerySelectStep<SR,?,EntityReference,T,SearchLoadingOptionsStep,?,?>	SearchSession.search(HibernateOrmRootReferenceScope<SR,T> scope)	Initiate the building of a search query.

Uses of Incubating in org.hibernate.search.mapper.pojo.bridge

Methods in org.hibernate.search.mapper.pojo.bridge with annotations of type Incubating

Modifier and Type	Method	Description
default String	ValueBridge.format(F value)	Format the value to a String.
default I	IdentifierBridge.parseIdentifierLiteral(String value)	Transform the given document identifier string value back to the value of the POJO property.

Uses of Incubating in org.hibernate.search.mapper.pojo.bridge.binding

Methods in org.hibernate.search.mapper.pojo.bridge.binding with annotations of type Incubating

Modifier and Type	Method	Description
PojoModelValue<I>	IdentifierBindingContext.bridgedElement()
PojoModelProperty	PropertyBindingContext.bridgedElement()
PojoModelType	RoutingBindingContext.bridgedElement()
PojoModelType	TypeBindingContext.bridgedElement()
PojoModelValue<V>	ValueBindingContext.bridgedElement()

Uses of Incubating in org.hibernate.search.mapper.pojo.bridge.binding.spi

Methods in org.hibernate.search.mapper.pojo.bridge.binding.spi with annotations of type Incubating

Modifier and Type	Method	Description
SearchableProjectableIndexFieldTypeOptionsStep<?,?>	FieldModelContributorContext.searchableProjectableIndexFieldTypeOptionsStep()
VectorFieldTypeOptionsStep<?,?>	FieldModelContributorContext.vectorTypeOptionsStep()

Uses of Incubating in org.hibernate.search.mapper.pojo.bridge.builtin.annotation

Classes in org.hibernate.search.mapper.pojo.bridge.builtin.annotation with annotations of type Incubating

Modifier and Type	Class	Description
@interface	AlternativeDiscriminator	Mark the property as an alternative discriminator for use in AlternativeBinder.

Uses of Incubating in org.hibernate.search.mapper.pojo.bridge.builtin.programmatic

Classes in org.hibernate.search.mapper.pojo.bridge.builtin.programmatic with annotations of type Incubating

Modifier and Type	Interface	Description
interface	AlternativeBinder	The binder that sets up AlternativeValueBridges.
interface	AlternativeBinderDelegate<D,P>	The component responsible for binding one field per alternative, and creating an AlternativeValueBridge.
interface	AlternativeDiscriminatorBinder	A binder for markers that mark a property as the discriminator for alternatives for an Alternative bridge.
interface	AlternativeValueBridge<D,P>	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

Methods in org.hibernate.search.mapper.pojo.bridge.mapping with annotations of type Incubating

Modifier and Type	Method	Description
<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

Classes in org.hibernate.search.mapper.pojo.extractor with annotations of type Incubating

Modifier and Type	Interface	Description
interface	ContainerExtractionContext	A handler passed to ContainerExtractor.extract(Object, ValueProcessor, Object, Object, ContainerExtractionContext).
interface	ContainerExtractor<C,V>	An extractor of values from a container.
interface	ContainerExtractorConfigurationContext	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

Classes in org.hibernate.search.mapper.pojo.mapping.definition.annotation with annotations of type Incubating

Modifier and Type	Class	Description
class	AnnotatedTypeSource	A source of types to be processed for annotations by Hibernate Search.
@interface	SearchEntity	Given a type, marks this type as an entity type.
@interface	VectorField	Maps an entity property to a vector field in the index.

Methods in org.hibernate.search.mapper.pojo.mapping.definition.annotation with annotations of type Incubating

Modifier and Type	Method	Description
AnnotationMappingConfigurationContext	AnnotationMappingConfigurationContext.addJandexIndex(org.jboss.jandex.IndexView jandexIndex)

Uses of Incubating in org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.spi

Classes in org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.spi with annotations of type Incubating

Modifier and Type	Class	Description
final class	MappingAnnotationProcessorUtils

Uses of Incubating in org.hibernate.search.mapper.pojo.mapping.definition.programmatic

Classes in org.hibernate.search.mapper.pojo.mapping.definition.programmatic with annotations of type Incubating

Modifier and Type	Interface	Description
interface	PropertyMappingVectorFieldOptionsStep	The step in a property-to-index-field mapping where optional parameters can be set, when the index field is a vector field.
interface	TypeMappingSearchEntityStep	The step in a mapping definition where a type's entity metadata can be configured more precisely.

Methods in org.hibernate.search.mapper.pojo.mapping.definition.programmatic with annotations of type Incubating

Modifier and Type	Method	Description
default PropertyMappingIndexedEmbeddedStep	PropertyMappingIndexedEmbeddedStep.excludePaths(String... paths)
PropertyMappingIndexedEmbeddedStep	PropertyMappingIndexedEmbeddedStep.excludePaths(Collection<String> paths)
TypeMappingSearchEntityStep	TypeMappingStep.searchEntity()	Marks a type as an entity type.
PropertyMappingVectorFieldOptionsStep	PropertyMappingStep.vectorField()	Maps the property to a vector field in the index with the same name as this property.
PropertyMappingVectorFieldOptionsStep	PropertyMappingStep.vectorField(int dimension)	Maps the property to a vector field in the index with the same name as this property.
PropertyMappingVectorFieldOptionsStep	PropertyMappingStep.vectorField(int dimension, String relativeFieldName)	Maps the property to a vector field in the index with a custom name.
PropertyMappingVectorFieldOptionsStep	PropertyMappingStep.vectorField(String relativeFieldName)	Maps the property to a vector field in the index with a custom name.

Uses of Incubating in org.hibernate.search.mapper.pojo.massindexing

Classes in org.hibernate.search.mapper.pojo.massindexing with annotations of type Incubating

Modifier and Type	Class	Description
final class	DefaultMassIndexingMonitor	A simple builder class that allows configuring the built-in logging mass indexer monitor.
interface	MassIndexingEnvironment	An interface for pluggable components that set up and tear down the environment of mass indexing threads, for example, to initialize ThreadLocals.
interface	MassIndexingType
interface	MassIndexingTypeGroupMonitor	A component that monitors progress of mass indexing within a type group.
interface	MassIndexingTypeGroupMonitorContext
interface	MassIndexingTypeGroupMonitorCreateContext

Methods in org.hibernate.search.mapper.pojo.massindexing with annotations of type Incubating

Modifier and Type	Method	Description
default long	MassIndexingFailureHandler.failureFloodingThreshold()	Returns the number of failures during one mass indexing beyond which the failure handler will no longer be notified.
default MassIndexingTypeGroupMonitor	MassIndexingMonitor.typeGroupMonitor(MassIndexingTypeGroupMonitorCreateContext context)	Creates a type-group-specific monitor.

Uses of Incubating in org.hibernate.search.mapper.pojo.massindexing.spi

Methods in org.hibernate.search.mapper.pojo.massindexing.spi with annotations of type Incubating

Modifier and Type	Method	Description
PojoMassIndexer	PojoMassIndexer.environment(MassIndexingEnvironment environment)	Sets the MassIndexingEnvironment, which can set up an environment (thread locals, ...) in mass indexing threads.
PojoMassIndexer	PojoMassIndexer.failFast(boolean failFast)	Enables the fail-fast option for this mass indexer.
PojoMassIndexer	PojoMassIndexer.failureFloodingThreshold(long threshold)	Sets the threshold for failures that will be reported and sent to MassIndexingFailureHandler per indexed type.

Uses of Incubating in org.hibernate.search.mapper.pojo.model

Classes in org.hibernate.search.mapper.pojo.model with annotations of type Incubating

Modifier and Type	Interface	Description
interface	PojoElementAccessor<T>	An accessor allowing the retrieval of an element, for example a property, from a POJO.
interface	PojoModelCompositeElement	A potentially composite element in the POJO model.
interface	PojoModelConstructorParameter	A model element representing a constructor parameter to bind.
interface	PojoModelElement	An element in the POJO model.
interface	PojoModelProperty	A model element representing a property bound to a bridge.
interface	PojoModelType	A model element representing a type bound to a bridge.
interface	PojoModelValue<T>	A model element representing a value bound to a bridge.

Uses of Incubating in org.hibernate.search.mapper.pojo.model.dependency

Classes in org.hibernate.search.mapper.pojo.model.dependency with annotations of type Incubating

Modifier and Type	Interface	Description
interface	PojoOtherEntityIndexingDependencyConfigurationContext

Methods in org.hibernate.search.mapper.pojo.model.dependency with annotations of type Incubating

Modifier and Type	Method	Description
default PojoOtherEntityIndexingDependencyConfigurationContext	PojoPropertyIndexingDependencyConfigurationContext.fromOtherEntity(Class<?> otherEntityType, String pathFromOtherEntityTypeToBridgedType)	Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.
default PojoOtherEntityIndexingDependencyConfigurationContext	PojoPropertyIndexingDependencyConfigurationContext.fromOtherEntity(Class<?> otherEntityType, PojoModelPathValueNode pathFromOtherEntityTypeToBridgedType)	Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.
PojoOtherEntityIndexingDependencyConfigurationContext	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.
default PojoOtherEntityIndexingDependencyConfigurationContext	PojoTypeIndexingDependencyConfigurationContext.fromOtherEntity(Class<?> otherEntityType, String pathFromOtherEntityTypeToBridgedType)	Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.
PojoOtherEntityIndexingDependencyConfigurationContext	PojoTypeIndexingDependencyConfigurationContext.fromOtherEntity(Class<?> otherEntityType, PojoModelPathValueNode pathFromOtherEntityTypeToBridgedType)	Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.
default PojoOtherEntityIndexingDependencyConfigurationContext	PojoOtherEntityIndexingDependencyConfigurationContext.use(String pathFromOtherEntityTypeToUsedValue)	Declare that the given path is read by the bridge at index time to populate the indexed document.
PojoOtherEntityIndexingDependencyConfigurationContext	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.model.spi

Methods in org.hibernate.search.mapper.pojo.model.spi with annotations of type Incubating

Modifier and Type	Method	Description
static String	PojoBootstrapIntrospector.decapitalize(String name)
default boolean	PojoMethodParameterModel.enclosingInstanceCanBeNull()	Starting with JDk 25, there is an additional check within the constructor itself, that by default prevents passing null as a value for an enclosing instance.
static String	PojoBootstrapIntrospector.noPrefix(String methodName)

Uses of Incubating in org.hibernate.search.mapper.pojo.schema.management.spi

Methods in org.hibernate.search.mapper.pojo.schema.management.spi with annotations of type Incubating

Modifier and Type	Method	Description
void	PojoScopeSchemaManager.exportExpectedSchema(Path targetDirectory)
void	PojoScopeSchemaManager.exportExpectedSchema(SearchSchemaCollector collector)

Uses of Incubating in org.hibernate.search.mapper.pojo.search.definition.binding

Classes in org.hibernate.search.mapper.pojo.search.definition.binding with annotations of type Incubating

Modifier and Type	Interface	Description
interface	ProjectionBinder	A component able to define a projection using the Hibernate Search Projection DSL.
interface	ProjectionBindingContext	The context passed to ProjectionBinder.bind(ProjectionBindingContext).
interface	ProjectionBindingMultiContext	Deprecated. Use ProjectionBindingContext/ProjectionBindingContext.containerElement() instead.

Methods in org.hibernate.search.mapper.pojo.search.definition.binding with annotations of type Incubating

Modifier and Type	Method	Description
PojoModelConstructorParameter	ProjectionBindingContext.constructorParameter()
Optional<PojoModelValue<?>>	ProjectionBindingContext.containerElement()
PojoModelValue<?>	ProjectionBindingMultiContext.containerElement()	Deprecated.
<T> BeanHolder<? extends ProjectionDefinition<T>>	ProjectionBindingContext.createCompositeDefinition(Class<T> projectedType)
default <T> BeanHolder<? extends ProjectionDefinition<T>>	ProjectionBindingContext.createObjectDefinition(String fieldPath, Class<T> projectedType, TreeFilterDefinition filter)
<C, T> BeanHolder<? extends ProjectionDefinition<C>>	ProjectionBindingContext.createObjectDefinition(String fieldPath, Class<T> projectedType, TreeFilterDefinition filter, ProjectionCollector.Provider<T,C> collector)
default <T> BeanHolder<? extends ProjectionDefinition<List<T>>>	ProjectionBindingContext.createObjectDefinitionMulti(String fieldPath, Class<T> projectedType, TreeFilterDefinition filter)	Deprecated. Use ProjectionBindingContext.createObjectDefinition(String, Class, TreeFilterDefinition, ProjectionCollector.Provider) instead.
Optional<? extends ProjectionBindingMultiContext>	ProjectionBindingContext.multi()	Deprecated. Use ProjectionBindingContext.containerElement() and various bind methods of this context instead.
ProjectionCollectorProviderFactory	ProjectionBindingContext.projectionCollectorProviderFactory()

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.bootstrap.spi

Classes in org.hibernate.search.mapper.pojo.standalone.bootstrap.spi with annotations of type Incubating

Modifier and Type	Interface	Description
interface	StandalonePojoIntegrationBooter
final class	StandalonePojoIntegrationBooterBehavior

Methods in org.hibernate.search.mapper.pojo.standalone.bootstrap.spi with annotations of type Incubating

Modifier and Type	Method	Description
StandalonePojoIntegrationBooter.Builder	StandalonePojoIntegrationBooter.Builder.introspectorCustomizer(Function<PojoBootstrapIntrospector,PojoBootstrapIntrospector> customize)

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.cfg

Classes in org.hibernate.search.mapper.pojo.standalone.cfg with annotations of type Incubating

Modifier and Type	Class	Description
final class	StandalonePojoMapperSettings

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.cfg.spi

Classes in org.hibernate.search.mapper.pojo.standalone.cfg.spi with annotations of type Incubating

Modifier and Type	Class	Description
final class	StandalonePojoMapperSpiSettings

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.entity

Classes in org.hibernate.search.mapper.pojo.standalone.entity with annotations of type Incubating

Modifier and Type	Interface	Description
interface	SearchIndexedEntity<E>	A descriptor of an indexed entity type, exposing in particular the index manager for this entity.

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.loading

Classes in org.hibernate.search.mapper.pojo.standalone.loading with annotations of type Incubating

Modifier and Type	Interface	Description
interface	LoadingTypeGroup<E>	A group of entity types for entity loading.
interface	MassEntityLoader<I>	A loader for mass loading of entities, used in particular during mass indexing.
interface	MassEntitySink<E>	A sink for use by a MassIdentifierLoader.
interface	MassIdentifierLoader	A loader for mass loading of entity identifiers, used in particular during mass indexing.
interface	MassIdentifierSink<I>	A sink for use by a MassIdentifierLoader.
interface	MassLoadingOptions
interface	MassLoadingStrategy<E,I>	A strategy for mass loading, used in particular during mass indexing.
interface	SelectionEntityLoader<E>	A loader for loading a small selection of entities, used in particular during search.
interface	SelectionLoadingOptions
interface	SelectionLoadingStrategy<E>	A strategy for selection loading, used in particular during search.

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.loading.binding

Classes in org.hibernate.search.mapper.pojo.standalone.loading.binding with annotations of type Incubating

Modifier and Type	Interface	Description
interface	EntityLoadingBinder	A binder for loading of a specific entity type.
interface	EntityLoadingBindingContext	A context allowing the binding of an entity type to loading strategies.

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.loading.dsl

Classes in org.hibernate.search.mapper.pojo.standalone.loading.dsl with annotations of type Incubating

Modifier and Type	Interface	Description
interface	SelectionLoadingOptionsStep	The DSL entry point passed to consumers in SearchSessionBuilder.loading(Consumer), allowing the definition of context for use by selection loading strategies: connections, third-party sessions, ...

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.mapping

Classes in org.hibernate.search.mapper.pojo.standalone.mapping with annotations of type Incubating

Modifier and Type	Interface	Description
interface	CloseableSearchMapping
interface	SearchMapping	The Hibernate Search mapping between the POJO model and the backend(s).
final class	SearchMappingBuilder
interface	StandalonePojoMappingConfigurationContext
interface	StandalonePojoMappingConfigurer	An object responsible for configuring the Hibernate Search mapping.

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.mapping.metadata

Classes in org.hibernate.search.mapper.pojo.standalone.mapping.metadata with annotations of type Incubating

Modifier and Type	Interface	Description
interface	EntityConfigurationContext<E>	Deprecated. Implement EntityLoadingBinder and use EntityLoadingBindingContext instead.
interface	EntityConfigurer<E>	Deprecated. Implement EntityLoadingBinder instead.

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.massindexing

Classes in org.hibernate.search.mapper.pojo.standalone.massindexing with annotations of type Incubating

Modifier and Type	Interface	Description
interface	MassIndexer	A MassIndexer is useful to rebuild the indexes from the data contained in the database.

Methods in org.hibernate.search.mapper.pojo.standalone.massindexing with annotations of type Incubating

Modifier and Type	Method	Description
MassIndexer	MassIndexer.environment(MassIndexingEnvironment environment)	Sets the MassIndexingEnvironment, which can set up an environment (thread locals, ...) in mass indexing threads.
MassIndexer	MassIndexer.failFast(boolean failFast)	Enables the fail-fast option for this mass indexer.
MassIndexer	MassIndexer.failureFloodingThreshold(long threshold)	Sets the threshold for failures that will be reported and sent to MassIndexingFailureHandler per indexed type.

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.schema.management

Classes in org.hibernate.search.mapper.pojo.standalone.schema.management with annotations of type Incubating

Modifier and Type	Class	Description
enum	SchemaManagementStrategyName
interface	SearchSchemaManager	The entry point for explicit schema management operations: creating indexes, dropping them, validating them, ...

Methods in org.hibernate.search.mapper.pojo.standalone.schema.management with annotations of type Incubating

Modifier and Type	Method	Description
void	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.pojo.standalone.scope

Classes in org.hibernate.search.mapper.pojo.standalone.scope with annotations of type Incubating

Modifier and Type	Interface	Description
interface	SearchScope<SR,E>	Represents a set of types and the corresponding indexes.
interface	SearchScopeProvider	A provider of SearchScope instances.
interface	StandalonePojoRootReferenceScope<SR,T>

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.session

Classes in org.hibernate.search.mapper.pojo.standalone.session with annotations of type Incubating

Modifier and Type	Interface	Description
interface	SearchSession	A Hibernate Search session, bound to a particular tenant identifier (if any), and with its own overridden settings regarding commits, refresh, etc.
interface	SearchSessionBuilder

Methods in org.hibernate.search.mapper.pojo.standalone.session with annotations of type Incubating

Modifier and Type	Method	Description
<SR, T> SearchQuerySelectStep<SR,?,EntityReference,T,?,?,?>	SearchSession.search(StandalonePojoRootReferenceScope<SR,T> scope)	Initiate the building of a search query.

Uses of Incubating in org.hibernate.search.mapper.pojo.standalone.work

Classes in org.hibernate.search.mapper.pojo.standalone.work with annotations of type Incubating

Modifier and Type	Interface	Description
interface	SearchIndexer	An interface for indexing entities in the context of a session.
interface	SearchIndexingPlan	An interface for indexing entities in the context of a session.
interface	SearchWorkspace	The entry point for explicit, large-scale index operations.

Uses of Incubating in org.hibernate.search.mapper.pojo.tenancy

Classes in org.hibernate.search.mapper.pojo.tenancy with annotations of type Incubating

Modifier and Type	Interface	Description
interface	TenantIdentifierConverter	Converts the tenant identifier value to a string that can be used for storing in the index.

Uses of Incubating in org.hibernate.search.mapper.pojo.tenancy.spi

Classes in org.hibernate.search.mapper.pojo.tenancy.spi with annotations of type Incubating

Modifier and Type	Class	Description
class	StringTenantIdentifierConverter	A simple string-string tenant identifier converter implementation to support applications that were using string tenant identifiers with Hibernate Search.

Uses of Incubating in org.hibernate.search.mapper.pojo.work

Classes in org.hibernate.search.mapper.pojo.work with annotations of type Incubating

Modifier and Type	Interface	Description
interface	IndexingPlanSynchronizationStrategy	Determines how the thread will block upon committing a transaction where indexed entities were modified.
interface	IndexingPlanSynchronizationStrategyConfigurationContext
final class	IndexingPlanSynchronizationStrategyNames	The names of built-in indexing plan synchronization strategies.
interface	SearchIndexingPlanExecutionReport
interface	SearchIndexingPlanFilter	Configurer implementers are responsible for specifying which types should be included/excluded from indexing.
interface	SearchIndexingPlanFilterContext	A context that helps with the indexing plan filter configuration.

Methods in org.hibernate.search.mapper.pojo.work with annotations of type Incubating

Modifier and Type	Method	Description
void	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

Classes in org.hibernate.search.mapper.pojo.work.spi with annotations of type Incubating

Modifier and Type	Class	Description
class	ConfiguredIndexingPlanSynchronizationStrategy

Methods in org.hibernate.search.mapper.pojo.work.spi with annotations of type Incubating

Modifier and Type	Method	Description
ConfiguredSearchIndexingPlanFilter	PojoWorkSessionContext.configuredIndexingPlanFilter()

Uses of Incubating in org.hibernate.search.util.common.spi

Classes in org.hibernate.search.util.common.spi with annotations of type Incubating

Modifier and Type	Interface	Description
interface	ToStringTreeAppendable	Implemented by classes that can be rendered to a string representing a tree.
interface	ToStringTreeAppender	An appender for use in ToStringTreeAppendable.