Package io.jmix.search.index.mapping

Class MappingDefinition

java.lang.Object

io.jmix.search.index.mapping.MappingDefinition

public class MappingDefinition
extends Object

Contains information about indexed properties defined within index definition interface marked with JmixEntitySearchIndex

It can be created automatically according to field-mapping annotations used in index definition or manually within mapping method implementation. Such method should fulfil the following requirements:

• Annotated with ManualMappingDefinition
• with any name
• default
• With return type - MappingDefinition
• With Spring beans as parameters

builder(), StaticAttributesGroupConfiguration.builder() and DynamicAttributesGroupConfiguration.builder() should be used to create content.

Example:

 @JmixEntitySearchIndex(entity = Customer.class)
 public interface CustomerIndexDefinition {

     @ManualMappingDefinition
     default MappingDefinition mapping(AutoMappingStrategy autoMappingStrategy,
                                       SimplePropertyValueExtractor simplePropertyValueExtractor) {
         return MappingDefinition.builder()
                 .addStaticAttributesGroup(
                         StaticAttributesGroupConfiguration.builder()
                                 .includeProperties("*")
                                 .excludeProperties("name", "description")
                                 .withFieldMappingStrategyClass(AutoMappingStrategy.class)
                                 .build()
                 )
                 .addStaticAttributesGroup(
                         StaticAttributesGroupConfiguration.builder()
                                 .includeProperties("name")
                                 .withFieldMappingStrategy(autoMappingStrategy)
                                 .withFieldConfiguration(
                                         "{\n" +
                                         "    \"type\": \"text\",\n" +
                                         "    \"analyzer\": \"standard\",\n" +
                                         "    \"boost\": 2\n" +
                                         "}"
                                 )
                                 .build()
                 )
                 .addStaticAttributesGroup(
                         StaticAttributesGroupConfiguration.builder()
                                 .includeProperties("description")
                                 .withFieldConfiguration(
                                         "{\n" +
                                         "    \"type\": \"text\",\n" +
                                         "    \"analyzer\": \"english\"\n" +
                                         "}"
                                 )
                                 .withPropertyValueExtractor(simplePropertyValueExtractor)
                                 .withOrder(1)
                                 .build()
                 )
                 .addDynamicAttributesGroup(
                         DynamicAttributesGroupConfiguration.builder()
                                 .excludeProperties("prefix1*")
                                 .excludeCategories("categoryPrefix1*")
                                 .withFieldMappingStrategyClass(AutoMappingStrategy.class)
                                 .build()
                 )
                 .addDynamicAttributesGroup(
                         DynamicAttributesGroupConfiguration.builder()
                                 .excludeProperties("prefix2*", "*infix*")
                                 .withReferenceAttributesIndexingMode(ReferenceAttributesIndexingMode.NONE)
                                 .addParameter("analyzer", "english")
                                 .withPropertyValueExtractor(simplePropertyValueExtractor)
                                 .withFieldConfiguration(
                                         "{\n" +
                                         "    \"type\": \"text\",\n" +
                                         "    \"analyzer\": \"english\"\n" +
                                         "}"
                                 ) *
                                 .build()
                 )
                 .build();
     }
 }
 

Note: if definition method has implementation any field-mapping annotations on it will be ignored

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MappingDefinition.MappingDefinitionBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Class<? extends AttributesGroupConfiguration>,List<? extends AttributesGroupConfiguration>>	attributesGroupConfigurationMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MappingDefinition(MappingDefinition.MappingDefinitionBuilder builder)

Method Summary

Modifier and Type	Method	Description
static MappingDefinition.MappingDefinitionBuilder	builder()
List<StaticAttributesGroupConfiguration>	getElements()	Deprecated. use the getMappingConfigurations(Class)}
<T extends AttributesGroupConfiguration> List<T>	getMappingConfigurations(Class<T> configurationType)

Methods inherited from class java.lang.Object

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

Field Details

attributesGroupConfigurationMap

protected Map<Class<? extends AttributesGroupConfiguration>,List<? extends AttributesGroupConfiguration>> attributesGroupConfigurationMap

Constructor Details

MappingDefinition

protected MappingDefinition(MappingDefinition.MappingDefinitionBuilder builder)

Method Details

getElements

@Deprecated
public List<StaticAttributesGroupConfiguration> getElements()

Deprecated.

use the getMappingConfigurations(Class)}

Gets all StaticAttributesGroupConfiguration

Returns:

List of MappingDefinitionElement

getMappingConfigurations

public <T extends AttributesGroupConfiguration>
List<T> getMappingConfigurations(Class<T> configurationType)

builder

public static MappingDefinition.MappingDefinitionBuilder builder()