Package io.jmix.search.index.mapping

Class MappingDefinitionElement.MappingDefinitionElementBuilder

java.lang.Object

io.jmix.search.index.mapping.MappingDefinitionElement.MappingDefinitionElementBuilder

Enclosing class:

MappingDefinitionElement

public static class MappingDefinitionElement.MappingDefinitionElementBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
MappingDefinitionElement.MappingDefinitionElementBuilder	addParameter(String parameterName, Object parameterValue)	Adds new parameter to parameters map.
MappingDefinitionElement	build()
MappingDefinitionElement.MappingDefinitionElementBuilder	excludeProperties(String... properties)	Defines entity properties that should NOT be indexed.
MappingDefinitionElement.MappingDefinitionElementBuilder	includeProperties(String... properties)	Defines entity properties that should be indexed.
MappingDefinitionElement.MappingDefinitionElementBuilder	withFieldConfiguration(com.fasterxml.jackson.databind.node.ObjectNode configuration)	Defines field configuration as json object with Elasticsearch-native configuration.
MappingDefinitionElement.MappingDefinitionElementBuilder	withFieldConfiguration(String configuration)	Defines field configuration as String json object with Elasticsearch-native configuration.
MappingDefinitionElement.MappingDefinitionElementBuilder	withFieldMappingStrategy(FieldMappingStrategy fieldMappingStrategy)	Defines FieldMappingStrategy instance that should be used to map properties.
MappingDefinitionElement.MappingDefinitionElementBuilder	withFieldMappingStrategyClass(Class<? extends FieldMappingStrategy> fieldMappingStrategyClass)	Defines FieldMappingStrategy implementation class that should be used to map properties.
MappingDefinitionElement.MappingDefinitionElementBuilder	withOrder(int order)	Defines explicit order.
MappingDefinitionElement.MappingDefinitionElementBuilder	withParameters(Map<String,Object> parameters)	Defines parameters map.
MappingDefinitionElement.MappingDefinitionElementBuilder	withPropertyValueExtractor(PropertyValueExtractor propertyValueExtractor)	Defines explicit PropertyValueExtractor that should be used to extract values from indexed properties.

Methods inherited from class java.lang.Object

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

Method Details

includeProperties

public MappingDefinitionElement.MappingDefinitionElementBuilder includeProperties(String... properties)

Defines entity properties that should be indexed.

Properties should be defined in a full-name format started from the root entity ("localPropertyName", "refPropertyName.propertyName").

Wildcard is allowed at the last level of multilevel properties ("*", "refPropertyName.*").

Parameters:

properties - property names

Returns:

builder

excludeProperties

public MappingDefinitionElement.MappingDefinitionElementBuilder excludeProperties(String... properties)

Defines entity properties that should NOT be indexed.

Properties should be defined in a full-name format started from the root entity ("localPropertyName", "refPropertyName.propertyName").

Wildcard is allowed at the last level of multilevel properties ("*", "refPropertyName.*").

Parameters:

properties - property names

Returns:

builder

withFieldMappingStrategyClass

public MappingDefinitionElement.MappingDefinitionElementBuilder withFieldMappingStrategyClass(Class<? extends FieldMappingStrategy> fieldMappingStrategyClass)

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

Optional - at least one of the followings should be defined:

• FieldMappingStrategy implementation class via this method
• FieldMappingStrategy instance via withFieldMappingStrategy(io.jmix.search.index.mapping.strategy.FieldMappingStrategy) method
• Explicit native configuration via withFieldConfiguration(java.lang.String) methods

If some of them are defined at the same time:

• Strategy instance takes precedence over strategy class
• Explicit configuration overrides identical parameters of configuration generated by strategy

Parameters:

fieldMappingStrategyClass - class implements FieldMappingStrategy

Returns:

builder

See Also:

• withFieldMappingStrategy(io.jmix.search.index.mapping.strategy.FieldMappingStrategy)
• withFieldConfiguration(String)
• withFieldConfiguration(ObjectNode)

withFieldMappingStrategy

public MappingDefinitionElement.MappingDefinitionElementBuilder withFieldMappingStrategy(FieldMappingStrategy fieldMappingStrategy)

Defines FieldMappingStrategy instance that should be used to map properties.

Optional - at least one of the followings should be defined:

• FieldMappingStrategy implementation class via withFieldMappingStrategyClass(java.lang.Class<? extends io.jmix.search.index.mapping.strategy.FieldMappingStrategy>) method
• FieldMappingStrategy instance via this method
• Explicit native configuration via withFieldConfiguration(java.lang.String) methods

If some of them are defined at the same time:

• Strategy instance takes precedence over strategy class
• Explicit configuration overrides identical parameters of configuration generated by strategy

Parameters:

fieldMappingStrategy - FieldMappingStrategy instance

Returns:

builder

See Also:

• withFieldMappingStrategyClass(java.lang.Class<? extends io.jmix.search.index.mapping.strategy.FieldMappingStrategy>)
• withFieldConfiguration(String)
• withFieldConfiguration(ObjectNode)

withParameters

public MappingDefinitionElement.MappingDefinitionElementBuilder withParameters(Map<String,Object> parameters)

Defines parameters map.

See MappingDefinitionElement.getParameters().

Parameters:

parameters - parameters

Returns:

builder

addParameter

public MappingDefinitionElement.MappingDefinitionElementBuilder addParameter(String parameterName,
 Object parameterValue)

Adds new parameter to parameters map.

See MappingDefinitionElement.getParameters().

Parameters:

parameterName - parameter name

parameterValue - parameter value

Returns:

builder

withFieldConfiguration

public MappingDefinitionElement.MappingDefinitionElementBuilder withFieldConfiguration(String configuration)

Defines field configuration as String json object with Elasticsearch-native configuration. It should contain only configuration itself without field name:

 
 {
      "type": "text",
      "analyzer": "english",
      "boost": 2
 }
 

Optional - at least one of the followings should be defined:

• FieldMappingStrategy implementation class via withFieldMappingStrategyClass(java.lang.Class<? extends io.jmix.search.index.mapping.strategy.FieldMappingStrategy>) method
• FieldMappingStrategy instance via withFieldMappingStrategy(io.jmix.search.index.mapping.strategy.FieldMappingStrategy) method
• Explicit native configuration via withFieldConfiguration(java.lang.String) methods

If some of them are defined at the same time:

• Strategy instance takes precedence over strategy class
• Explicit configuration overrides identical parameters of configuration generated by strategy

Parameters:

configuration - configuration as json string

Returns:

builder

Throws:

RuntimeException - if provided string is not a well-formed json object

See Also:

• withFieldMappingStrategyClass(java.lang.Class<? extends io.jmix.search.index.mapping.strategy.FieldMappingStrategy>)
• withFieldMappingStrategy(io.jmix.search.index.mapping.strategy.FieldMappingStrategy)
• withFieldConfiguration(ObjectNode)

withFieldConfiguration

public MappingDefinitionElement.MappingDefinitionElementBuilder withFieldConfiguration(com.fasterxml.jackson.databind.node.ObjectNode configuration)

Defines field configuration as json object with Elasticsearch-native configuration. It should contain only configuration itself without field name:

 
 {
      "type": "text",
      "analyzer": "english",
      "boost": 2
 }
 

Optional - at least one of the followings should be defined:

• FieldMappingStrategy implementation class via withFieldMappingStrategyClass(java.lang.Class<? extends io.jmix.search.index.mapping.strategy.FieldMappingStrategy>) method
• FieldMappingStrategy instance via withFieldMappingStrategy(io.jmix.search.index.mapping.strategy.FieldMappingStrategy) method
• Explicit native configuration via withFieldConfiguration(java.lang.String) methods

If some of them are defined at the same time:

• Strategy instance takes precedence over strategy class
• Explicit configuration overrides identical parameters of configuration generated by strategy

Parameters:

configuration - configuration as json object

Returns:

builder

See Also:

• withFieldMappingStrategyClass(java.lang.Class<? extends io.jmix.search.index.mapping.strategy.FieldMappingStrategy>)
• withFieldMappingStrategy(io.jmix.search.index.mapping.strategy.FieldMappingStrategy)
• withFieldConfiguration(String)

withPropertyValueExtractor

public MappingDefinitionElement.MappingDefinitionElementBuilder withPropertyValueExtractor(PropertyValueExtractor propertyValueExtractor)

Defines explicit PropertyValueExtractor that should be used to extract values from indexed properties.

Required if only explicit field configuration is defined.

Optional if FieldMappingStrategy is defined (class or instance) - explicit extractor takes precedence over extractor provided by strategy.

Parameters:

propertyValueExtractor - property value extractor

Returns:

builder

See Also:

• withFieldConfiguration(String)
• withFieldConfiguration(ObjectNode)

withOrder

public MappingDefinitionElement.MappingDefinitionElementBuilder withOrder(int order)

Defines explicit order. It overrides order on strategy - FieldMappingStrategy.getOrder().

Parameters:

order - order

Returns:

builder

build

public MappingDefinitionElement build()