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

Interface PropertyMappingFullTextFieldOptionsStep

All Superinterfaces:

PropertyMappingFieldOptionsStep<PropertyMappingFullTextFieldOptionsStep>, PropertyMappingStandardFieldOptionsStep<PropertyMappingFullTextFieldOptionsStep>, PropertyMappingStep

public interface PropertyMappingFullTextFieldOptionsStep
extends PropertyMappingStandardFieldOptionsStep<PropertyMappingFullTextFieldOptionsStep>

The step in a property-to-index-field mapping where optional parameters can be set, when the index field is a full-text field.

See Also:

• FullTextField

Method Summary

Modifier and Type	Method	Description
PropertyMappingFullTextFieldOptionsStep	analyzer(String analyzerName)
PropertyMappingFullTextFieldOptionsStep	highlightable(Collection<org.hibernate.search.engine.backend.types.Highlightable> highlightable)
PropertyMappingFullTextFieldOptionsStep	norms(org.hibernate.search.engine.backend.types.Norms norms)
PropertyMappingFullTextFieldOptionsStep	searchAnalyzer(String searchAnalyzerName)
PropertyMappingFullTextFieldOptionsStep	termVector(org.hibernate.search.engine.backend.types.TermVector termVector)

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

extractor, extractors, noExtractors, valueBinder, valueBinder, valueBridge, valueBridge, valueBridge

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

projectable, searchable

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

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

Method Details

analyzer

PropertyMappingFullTextFieldOptionsStep analyzer(String analyzerName)

Parameters:

analyzerName - A reference to the analyzer to use for this field.

Returns:

this, for method chaining.

See Also:

• FullTextField.analyzer()

searchAnalyzer

PropertyMappingFullTextFieldOptionsStep searchAnalyzer(String searchAnalyzerName)

Parameters:

searchAnalyzerName - A reference to the analyzer to use for query parameters at search time.

Returns:

this, for method chaining.

See Also:

• FullTextField.searchAnalyzer()

norms

PropertyMappingFullTextFieldOptionsStep norms(org.hibernate.search.engine.backend.types.Norms norms)

Parameters:

norms - Whether index time scoring information should be stored or not.

Returns:

this, for method chaining.

See Also:

• FullTextField.norms()
• Norms

termVector

PropertyMappingFullTextFieldOptionsStep termVector(org.hibernate.search.engine.backend.types.TermVector termVector)

Parameters:

termVector - The term vector storing strategy.

Returns:

this, for method chaining.

See Also:

• FullTextField.termVector()
• TermVector

highlightable

PropertyMappingFullTextFieldOptionsStep highlightable(Collection<org.hibernate.search.engine.backend.types.Highlightable> highlightable)

Parameters:

highlightable - Whether this field can be highlighted, and if so which highlighter types can be applied to it. Pass Collections.singleton(Highlightable.NO) to disable highlighting.

Returns:

this, for method chaining.

See Also:

• FullTextField.highlightable()
• Highlightable