Package io.jmix.search.index.mapping

Class AbstractAttributesGroupConfiguration

java.lang.Object

io.jmix.search.index.mapping.AbstractAttributesGroupConfiguration

All Implemented Interfaces:

AttributesGroupConfiguration

Direct Known Subclasses:

DynamicAttributesGroupConfiguration, StaticAttributesGroupConfiguration

public abstract class AbstractAttributesGroupConfiguration
extends Object
implements AttributesGroupConfiguration

Abstract base class for defining a configuration group of attributes.

Provides common functionality and properties for configuring attribute mappings and value extraction. Enables specifying the field mapping strategy and related configurations used to index properties.

Subclasses should provide specific implementations or extensions as required for dynamic or static attribute configurations.

Implements AttributesGroupConfiguration.

Field Summary

Fields

Modifier and Type	Field	Description
protected final FieldConfiguration	fieldConfiguration
protected final FieldMappingStrategy	fieldMappingStrategy
protected final Class<? extends FieldMappingStrategy>	fieldMappingStrategyClass
protected final Integer	order
protected final Map<String,Object>	parameters
protected final PropertyValueExtractor	propertyValueExtractor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAttributesGroupConfiguration(Class<? extends FieldMappingStrategy> fieldMappingStrategyClass, FieldMappingStrategy fieldMappingStrategy, FieldConfiguration fieldConfiguration, PropertyValueExtractor propertyValueExtractor, Map<String,Object> parameters, Integer order)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

fieldMappingStrategyClass

protected final Class<? extends FieldMappingStrategy> fieldMappingStrategyClass

fieldMappingStrategy

protected final FieldMappingStrategy fieldMappingStrategy

fieldConfiguration

protected final FieldConfiguration fieldConfiguration

propertyValueExtractor

protected final PropertyValueExtractor propertyValueExtractor

parameters

protected final Map<String,Object> parameters

order

protected final Integer order

Constructor Details

AbstractAttributesGroupConfiguration

protected AbstractAttributesGroupConfiguration(Class<? extends FieldMappingStrategy> fieldMappingStrategyClass,
 FieldMappingStrategy fieldMappingStrategy,
 FieldConfiguration fieldConfiguration,
 PropertyValueExtractor propertyValueExtractor,
 Map<String,Object> parameters,
 Integer order)

Method Details

getFieldMappingStrategyClass

@Nullable
public 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())

Specified by:

getFieldMappingStrategyClass in interface AttributesGroupConfiguration

Returns:

FieldMappingStrategy implementation class

getFieldMappingStrategy

@Nullable
public 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())

getFieldMappingStrategyClass() is ignored if this instance is set.

Specified by:

getFieldMappingStrategy in interface AttributesGroupConfiguration

Returns:

FieldMappingStrategy instance

getFieldConfiguration

@Nullable
public 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.

Specified by:

getFieldConfiguration in interface AttributesGroupConfiguration

Returns:

field configuration

getPropertyValueExtractor

@Nullable
public 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.

Specified by:

getPropertyValueExtractor in interface AttributesGroupConfiguration

Returns:

property value extractor

getParameters

public 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).

Specified by:

getParameters in interface AttributesGroupConfiguration

Returns:

Map with parameters

getOrder

@Nullable
public Integer getOrder()

Provides explicit order.

See FieldMappingStrategy.getOrder()

Specified by:

getOrder in interface AttributesGroupConfiguration

Returns:

order