org.hibernate.search.mapper.pojo.mapping.definition.programmatic

Interface IndexingDependencyOptionsStep

All Superinterfaces:

PropertyMappingStep

public interface IndexingDependencyOptionsStep
extends PropertyMappingStep

The step in an "indexing dependency" definition where optional parameters can be set.

Method Summary

Modifier and Type	Method and Description
IndexingDependencyOptionsStep	derivedFrom(PojoModelPathValueNode pojoModelPath)
IndexingDependencyOptionsStep	reindexOnUpdate(ReindexOnUpdate reindexOnUpdate)
default IndexingDependencyOptionsStep	withExtractor(String extractorName)
IndexingDependencyOptionsStep	withExtractors(ContainerExtractorPath extractorPath)
default IndexingDependencyOptionsStep	withoutExtractors() Indicates that no container extractors should be applied, not even the default ones.

Methods inherited from interface org.hibernate.search.mapper.pojo.mapping.definition.programmatic.PropertyMappingStep

associationInverseSide, binder, bridge, bridge, documentId, fullTextField, fullTextField, genericField, genericField, indexedEmbedded, indexingDependency, keywordField, keywordField, marker, property, scaledNumberField, scaledNumberField

Method Detail

reindexOnUpdate

IndexingDependencyOptionsStep reindexOnUpdate(ReindexOnUpdate reindexOnUpdate)

Parameters:

reindexOnUpdate - How indexed entities using the annotated property should be reindexed when the value, or any nested value, is updated.

Returns:

this, for method chaining.

See Also:

IndexingDependency.reindexOnUpdate(), ReindexOnUpdate

derivedFrom

IndexingDependencyOptionsStep derivedFrom(PojoModelPathValueNode pojoModelPath)

Parameters:

pojoModelPath - A path to other values that are used to generate the value of this property.

Returns:

this, for method chaining.

See Also:

IndexingDependency.derivedFrom(), PojoModelPathValueNode, PojoModelPath.ofValue(String), PojoModelPath.ofValue(String, ContainerExtractorPath), PojoModelPath.builder()

withExtractor

default IndexingDependencyOptionsStep withExtractor(String extractorName)

Parameters:

extractorName - The name of the container extractor to use.

Returns:

this, for method chaining.

See Also:

IndexingDependency.extraction(), BuiltinContainerExtractors

withoutExtractors

default IndexingDependencyOptionsStep withoutExtractors()

Indicates that no container extractors should be applied, not even the default ones.

Returns:

this, for method chaining.

See Also:

IndexingDependency.extraction()

withExtractors

IndexingDependencyOptionsStep withExtractors(ContainerExtractorPath extractorPath)

Parameters:

extractorPath - A ContainerExtractorPath.

Returns:

this, for method chaining.

See Also:

IndexingDependency.extraction(), ContainerExtractorPath