Package 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	Description
default PropertyMappingIndexedEmbeddedStep	extractor(String extractorName)
PropertyMappingIndexedEmbeddedStep	extractors(ContainerExtractorPath extractorPath)
PropertyMappingIndexedEmbeddedStep	includeDepth(Integer depth)
PropertyMappingIndexedEmbeddedStep	includeEmbeddedObjectId(boolean include)
default PropertyMappingIndexedEmbeddedStep	includePaths(String... paths)
PropertyMappingIndexedEmbeddedStep	includePaths(Collection<String> paths)
default PropertyMappingIndexedEmbeddedStep	noExtractors()	Indicates that no container extractors should be applied, not even the default ones.
PropertyMappingIndexedEmbeddedStep	prefix(String prefix)	Deprecated. Pass a field name to PropertyMappingStep.indexedEmbedded(String) instead.
PropertyMappingIndexedEmbeddedStep	structure(ObjectStructure structure)
PropertyMappingIndexedEmbeddedStep	targetType(Class<?> targetType)

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

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

Method Detail

prefix

@Deprecated
@Search5DeprecatedAPI
PropertyMappingIndexedEmbeddedStep prefix(String prefix)

Deprecated.

Pass a field name to PropertyMappingStep.indexedEmbedded(String) instead. Note that the name passed to that method does not allow dots.

Parameters:

prefix - The prefix used when embedding.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.prefix()

includeDepth

PropertyMappingIndexedEmbeddedStep includeDepth(Integer depth)

Parameters:

depth - The number of levels of indexed-embedded that will have all their fields included by default.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.includeDepth()

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()

includeEmbeddedObjectId

PropertyMappingIndexedEmbeddedStep includeEmbeddedObjectId(boolean include)

Parameters:

include - Whether the identifier of embedded objects should be included as an index field.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.includeEmbeddedObjectId()

structure

PropertyMappingIndexedEmbeddedStep structure(ObjectStructure structure)

Parameters:

structure - How the structure of the object field created for this indexed-embedded is preserved upon indexing.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.structure(), ObjectStructure

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

noExtractors

default PropertyMappingIndexedEmbeddedStep noExtractors()

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

targetType

PropertyMappingIndexedEmbeddedStep targetType(Class<?> targetType)

Parameters:

targetType - A type indexed-embedded elements should be cast to. When relying on container extraction, the extracted values are cast, not the container. By default, no casting occurs.

Returns:

this, for method chaining.

See Also:

IndexedEmbedded.targetType()