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

Interface PropertyMappingIndexedEmbeddedStep

All Superinterfaces:

PropertyMappingStep

public interface PropertyMappingIndexedEmbeddedStep
extends PropertyMappingStep

The step in a property-to-indexed-embedded mapping where optional parameters can be set.

Method Summary

Modifier and Type	Method and Description
default PropertyMappingIndexedEmbeddedStep	extractor(String extractorName)
default PropertyMappingIndexedEmbeddedStep	extractors() Indicates that no container extractors should be applied, not even the default ones.
PropertyMappingIndexedEmbeddedStep	extractors(ContainerExtractorPath extractorPath)
PropertyMappingIndexedEmbeddedStep	includePaths(Collection<String> paths)
default PropertyMappingIndexedEmbeddedStep	includePaths(String... paths)
PropertyMappingIndexedEmbeddedStep	maxDepth(Integer depth)
PropertyMappingIndexedEmbeddedStep	prefix(String prefix)
PropertyMappingIndexedEmbeddedStep	storage(ObjectFieldStorage storage)

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

associationInverseSide, binder, documentId, fullTextField, fullTextField, genericField, genericField, indexedEmbedded, indexingDependency, keywordField, keywordField, marker, nonStandardField, nonStandardField, scaledNumberField, scaledNumberField

Method Detail

prefix

PropertyMappingIndexedEmbeddedStep prefix(String prefix)

Parameters:

prefix - The prefix used when embedding.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.prefix()

maxDepth

PropertyMappingIndexedEmbeddedStep maxDepth(Integer depth)

Parameters:

depth - The max recursion depth for indexed-embedded processing.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.maxDepth()

includePaths

default PropertyMappingIndexedEmbeddedStep includePaths(String... paths)

Parameters:

paths - The paths of index fields to include explicitly.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.includePaths()

includePaths

PropertyMappingIndexedEmbeddedStep includePaths(Collection<String> paths)

Parameters:

paths - The paths of index fields to include explicitly.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.includePaths()

storage

PropertyMappingIndexedEmbeddedStep storage(ObjectFieldStorage storage)

Parameters:

storage - The storage strategy of the object field created for this indexed-embedded.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.storage(), ObjectFieldStorage

extractor

default PropertyMappingIndexedEmbeddedStep extractor(String extractorName)

Parameters:

extractorName - The name of the container extractor to use.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.extraction(), BuiltinContainerExtractors

extractors

default PropertyMappingIndexedEmbeddedStep extractors()

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

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.extraction()

extractors

PropertyMappingIndexedEmbeddedStep extractors(ContainerExtractorPath extractorPath)

Parameters:

extractorPath - A ContainerExtractorPath.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.extraction(), ContainerExtractorPath