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

Interface FieldMappingStrategy

All Known Implementing Classes:
AutoMappingStrategy
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 Details

    • getOrder

      int getOrder()
      Defines the order of mapping strategy. If several strategies match the same property strategy with the latest order will be used
      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 Elasticsearch-native json.
      Parameters:
      propertyPath - property to generate configuration for
      parameters - input parameters
      Returns:
      FieldConfiguration

    • getPropertyValueExtractor

      PropertyValueExtractor getPropertyValueExtractor(MetaPropertyPath propertyPath)
      Provides PropertyValueExtractor to extract property value from entity instances
      Parameters:
      propertyPath - property
      Returns:
      PropertyValueExtractor