Package io.jmix.search.index.mapping

Class DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder

java.lang.Object

io.jmix.search.index.mapping.DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder

Enclosing class:

DynamicAttributesGroupConfiguration

public static class DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected FieldConfiguration	fieldConfiguration
protected FieldMappingStrategy	fieldMappingStrategy
protected Class<? extends FieldMappingStrategy>	fieldMappingStrategyClass
protected static final com.fasterxml.jackson.databind.ObjectMapper	mapper
protected Integer	order
protected Map<String,Object>	parameters
protected PropertyValueExtractor	propertyValueExtractor
protected ReferenceAttributesIndexingMode	referenceAttributesIndexingMode

Method Summary

Modifier and Type	Method	Description
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	addParameter(String parameterName, Object parameterValue)	Adds new parameter to parameters map.
DynamicAttributesGroupConfiguration	build()
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	excludeCategories(String... categories)
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	excludeProperties(String... properties)	Defines entity properties that should NOT be indexed.
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	withFieldConfiguration(com.fasterxml.jackson.databind.node.ObjectNode configuration)	Defines field configuration as json object with native configuration.
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	withFieldConfiguration(String configuration)	Defines field configuration as String json object with native configuration.
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	withFieldMappingStrategy(FieldMappingStrategy fieldMappingStrategy)	Defines FieldMappingStrategy instance that should be used to map properties.
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	withFieldMappingStrategyClass(Class<? extends FieldMappingStrategy> fieldMappingStrategyClass)	Defines FieldMappingStrategy implementation class that should be used to map properties.
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	withOrder(int order)	Defines explicit order of the MappingDefinition for the field.
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	withParameters(Map<String,Object> parameters)	Defines parameters map.
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	withPropertyValueExtractor(PropertyValueExtractor propertyValueExtractor)	Defines explicit PropertyValueExtractor that should be used to extract values from indexed properties.
DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	withReferenceAttributesIndexingMode(ReferenceAttributesIndexingMode mode)	Defines indexing mode for the reference dynamic attributes of the indexing entity

Methods inherited from class java.lang.Object

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

Field Details

mapper

protected static final com.fasterxml.jackson.databind.ObjectMapper mapper

fieldMappingStrategyClass

protected Class<? extends FieldMappingStrategy> fieldMappingStrategyClass

fieldMappingStrategy

protected FieldMappingStrategy fieldMappingStrategy

fieldConfiguration

protected FieldConfiguration fieldConfiguration

propertyValueExtractor

protected PropertyValueExtractor propertyValueExtractor

parameters

protected Map<String,Object> parameters

referenceAttributesIndexingMode

protected ReferenceAttributesIndexingMode referenceAttributesIndexingMode

order

protected Integer order

Method Details

excludeCategories

public DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder excludeCategories(String... categories)

excludeProperties

public DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder 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 DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder 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 DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder 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 DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder withParameters(Map<String,Object> parameters)

Defines parameters map.

See AbstractAttributesGroupConfiguration.getParameters().

Parameters:

parameters - parameters

Returns:

builder

addParameter

public DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder addParameter(String parameterName,
 Object parameterValue)

Adds new parameter to parameters map.

See AbstractAttributesGroupConfiguration.getParameters().

Parameters:

parameterName - parameter name

parameterValue - parameter value

Returns:

builder

withFieldConfiguration

public DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder withFieldConfiguration(String configuration)

Defines field configuration as String json object with 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 DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder withFieldConfiguration(com.fasterxml.jackson.databind.node.ObjectNode configuration)

Defines field configuration as json object with 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 DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder 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)

withReferenceAttributesIndexingMode

public DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder withReferenceAttributesIndexingMode(ReferenceAttributesIndexingMode mode)

Defines indexing mode for the reference dynamic attributes of the indexing entity

Parameters:

mode - reference attributes indexing mode

Returns:

builder

withOrder

public DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder withOrder(int order)

Defines explicit order of the MappingDefinition for the field. The MappingDefinition with the highest order number will be applied. If the order is not specified Integer.MIN_VALUE will be used. It overrides order on strategy - FieldMappingStrategy.getOrder(). If two MappingDefinition objects have the same order the runtime error during the application initialization will occur.

Parameters:

order - the order value to be set for the fields of this descriptor

Returns:

builder

build

public DynamicAttributesGroupConfiguration build()