Package io.jmix.search.index.mapping

Interface AttributesGroupConfiguration

All Known Implementing Classes:

AbstractAttributesGroupConfiguration, DynamicAttributesGroupConfiguration, StaticAttributesGroupConfiguration

@NullMarked
public interface AttributesGroupConfiguration

Defines the configuration for an attributes group, enabling mapping of properties into search index fields.

This interface allows specifying either a FieldMappingStrategy implementation (as a class or instance) or an explicit field configuration to control the mapping process. Additional customization can be achieved through property value extractors and parameters.

Method Summary

Modifier and Type	Method	Description
@Nullable FieldConfiguration	getFieldConfiguration()	Provides explicit configuration for indexed fields.
@Nullable FieldMappingStrategy	getFieldMappingStrategy()	Provides FieldMappingStrategy instance that should be used to map properties.
@Nullable Class<? extends FieldMappingStrategy>	getFieldMappingStrategyClass()	Provides FieldMappingStrategy implementation class that should be used to map properties.
@Nullable Integer	getOrder()	Provides explicit order.
Map<String,Object>	getParameters()	Provides additional parameters related to this element.
@Nullable PropertyValueExtractor	getPropertyValueExtractor()	Provides explicit property value extractor.

Method Details

getFieldMappingStrategyClass

@Nullable Class<? extends FieldMappingStrategy> getFieldMappingStrategyClass()

Provides FieldMappingStrategy implementation class that should be used to map properties.

Can be null if strategy is defined as instance (see getFieldMappingStrategy()) or configuration is specified explicitly (see getFieldConfiguration())

Returns:

FieldMappingStrategy implementation class

getFieldMappingStrategy

@Nullable FieldMappingStrategy getFieldMappingStrategy()

Provides FieldMappingStrategy instance that should be used to map properties.

Can be null if strategy is defined as class (see getFieldMappingStrategyClass()) or configuration is specified explicitly (see getFieldConfiguration())

AbstractAttributesGroupConfiguration.getFieldMappingStrategyClass() is ignored if this instance is set.

Returns:

FieldMappingStrategy instance

getFieldConfiguration

@Nullable FieldConfiguration getFieldConfiguration()

Provides explicit configuration for indexed fields.

Can be null if strategy is defined as class (see getFieldMappingStrategyClass()) or instance (see getFieldMappingStrategy()).

If strategy (as class or instance) and explicit configuration are both set then explicit configuration will override matching parameters of configuration generated by strategy.

Returns:

field configuration

getPropertyValueExtractor

@Nullable PropertyValueExtractor getPropertyValueExtractor()

Provides explicit property value extractor.

Can be null if strategy is defined as class (see getFieldMappingStrategyClass()) or instance (see getFieldMappingStrategy()).

Property value extractor got from strategy will be ignored if explicit one is set.

Returns:

property value extractor

getParameters

Map<String,Object> getParameters()

Provides additional parameters related to this element.

Parameters are used by FieldMapper during mapping generation within FieldMappingStrategy (e.g. analyzer) or by PropertyValueExtractor at runtime (e.g. enable\disable indexing file content).

Returns:

Map with parameters

getOrder

@Nullable Integer getOrder()

Provides explicit order.

See FieldMappingStrategy.getOrder()

Returns:

order