Package io.jmix.search.index.mapping

Class MappingDefinitionElement

java.lang.Object

io.jmix.search.index.mapping.MappingDefinitionElement

public class MappingDefinitionElement
extends Object

Describes details of mapping for entity property or group of properties. Equivalent of single field-mapping annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MappingDefinitionElement.MappingDefinitionElementBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final String[]	excludedProperties
protected final FieldConfiguration	fieldConfiguration
protected final FieldMappingStrategy	fieldMappingStrategy
protected final Class<? extends FieldMappingStrategy>	fieldMappingStrategyClass
protected final String[]	includedProperties
protected final Integer	order
protected final Map<String,Object>	parameters
protected final PropertyValueExtractor	propertyValueExtractor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MappingDefinitionElement(MappingDefinitionElement.MappingDefinitionElementBuilder builder)

Method Summary

Modifier and Type	Method	Description
static MappingDefinitionElement.MappingDefinitionElementBuilder	builder()
String[]	getExcludedProperties()	Provides full names of properties that should NOT be indexed.
FieldConfiguration	getFieldConfiguration()	Provides explicit configuration for indexed fields.
FieldMappingStrategy	getFieldMappingStrategy()	Provides FieldMappingStrategy instance that should be used to map properties.
Class<? extends FieldMappingStrategy>	getFieldMappingStrategyClass()	Provides FieldMappingStrategy implementation class that should be used to map properties.
String[]	getIncludedProperties()	Provides full names of properties that should be indexed.
Integer	getOrder()	Provides explicit order.
Map<String,Object>	getParameters()	Provides additional parameters related to this element.
PropertyValueExtractor	getPropertyValueExtractor()	Provides explicit property value extractor.

Methods inherited from class java.lang.Object

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

Field Details

includedProperties

protected final String[] includedProperties

excludedProperties

protected final String[] excludedProperties

fieldMappingStrategyClass

protected final Class<? extends FieldMappingStrategy> fieldMappingStrategyClass

fieldMappingStrategy

protected final FieldMappingStrategy fieldMappingStrategy

fieldConfiguration

protected final FieldConfiguration fieldConfiguration

propertyValueExtractor

protected final PropertyValueExtractor propertyValueExtractor

order

protected final Integer order

parameters

protected final Map<String,Object> parameters

Constructor Details

MappingDefinitionElement

protected MappingDefinitionElement(MappingDefinitionElement.MappingDefinitionElementBuilder builder)

Method Details

getIncludedProperties

public String[] getIncludedProperties()

Provides full names of properties that should be indexed.

Returns:

property names

getExcludedProperties

public String[] getExcludedProperties()

Provides full names of properties that should NOT be indexed.

Returns:

property names

getFieldMappingStrategyClass

@Nullable
public Class<? extends FieldMappingStrategy> getFieldMappingStrategyClass()

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

Can be null if strategy is defined as instance (see getFieldMappingStrategy()) or configuration is specified explicitly (see getFieldConfiguration())

Returns:

FieldMappingStrategy implementation class

getFieldMappingStrategy

@Nullable
public FieldMappingStrategy getFieldMappingStrategy()

Provides FieldMappingStrategy instance that should be used to map properties.

Can be null if strategy is defined as class (see getFieldMappingStrategyClass()) or configuration is specified explicitly (see getFieldConfiguration())

getFieldMappingStrategyClass() is ignored if this instance is set.

Returns:

FieldMappingStrategy instance

getFieldConfiguration

@Nullable
public FieldConfiguration getFieldConfiguration()

Provides explicit configuration for indexed fields.

Can be null if strategy is defined as class (see getFieldMappingStrategyClass()) or instance (see getFieldMappingStrategy()).

If strategy (as class or instance) and explicit configuration are both set then explicit configuration will override matching parameters of configuration generated by strategy.

Returns:

field configuration

getPropertyValueExtractor

@Nullable
public PropertyValueExtractor getPropertyValueExtractor()

Provides explicit property value extractor.

Can be null if strategy is defined as class (see getFieldMappingStrategyClass()) or instance (see getFieldMappingStrategy()).

Property value extractor got from strategy will be ignored if explicit one is set.

Returns:

property value extractor

getOrder

@Nullable
public Integer getOrder()

Provides explicit order.

See FieldMappingStrategy.getOrder()

Returns:

order

getParameters

public Map<String,Object> getParameters()

Provides additional parameters related to this element.

Parameters are used by FieldMapper during mapping generation within FieldMappingStrategy (e.g. analyzer) or by PropertyValueExtractor at runtime (e.g. enable\disable indexing file content).

Returns:

Map with parameters

builder

public static MappingDefinitionElement.MappingDefinitionElementBuilder builder()