Package io.jmix.search.index.mapping.strategy

Interface FieldMappingStrategy

All Known Implementing Classes:

AutoMappingStrategy

@NullMarked
public interface FieldMappingStrategy

Base interface for mapping strategy.

Mapping strategy defines the way of transformation of property metadata and content into index mapping and value.

Method Summary

Modifier and Type	Method	Description
FieldConfiguration	createFieldConfiguration(MetaPropertyPath propertyPath, Map<String,Object> parameters)	Creates field configuration as native json.
FieldConfiguration	createFieldConfiguration(MetaPropertyPath propertyPath, Map<String,Object> parameters, ExtendedSearchSettings extendedSearchSettings)
int	getOrder()	Defines the order of mapping strategy.
PropertyValueExtractor	getPropertyValueExtractor(MetaPropertyPath propertyPath)	Provides PropertyValueExtractor to extract property value from entity instances
boolean	isSupported(MetaPropertyPath propertyPath)	Checks is provided MetaPropertyPath is supported by this mapping strategy

Method Details

getOrder

int getOrder()

Defines the order of mapping strategy. If several strategies match the same property strategy with the highest order value will be used This order also is used for setting the MappingFieldDescriptor.setOrder(int) but can be overridden with the AttributesGroupConfiguration.getOrder()

Returns:

order

isSupported

boolean isSupported(MetaPropertyPath propertyPath)

Checks is provided MetaPropertyPath is supported by this mapping strategy

Parameters:

propertyPath - property to check

Returns:

true if provided MetaPropertyPath is supported, false otherwise

createFieldConfiguration

FieldConfiguration createFieldConfiguration(MetaPropertyPath propertyPath,
 Map<String,Object> parameters)

Creates field configuration as native json.

Parameters:

propertyPath - property to generate configuration for

parameters - input parameters

Returns:

FieldConfiguration

createFieldConfiguration

FieldConfiguration createFieldConfiguration(MetaPropertyPath propertyPath,
 Map<String,Object> parameters,
 ExtendedSearchSettings extendedSearchSettings)

getPropertyValueExtractor

PropertyValueExtractor getPropertyValueExtractor(MetaPropertyPath propertyPath)

Provides PropertyValueExtractor to extract property value from entity instances

Parameters:

propertyPath - property

Returns:

PropertyValueExtractor