Package io.jmix.search.index.mapping

Class DynamicAttributesGroupConfiguration

java.lang.Object

io.jmix.search.index.mapping.AbstractAttributesGroupConfiguration

io.jmix.search.index.mapping.DynamicAttributesGroupConfiguration

All Implemented Interfaces:

AttributesGroupConfiguration

public class DynamicAttributesGroupConfiguration
extends AbstractAttributesGroupConfiguration

The DynamicAttributesGroupConfiguration class represents a search configuration for a group of the dynamic attributes.

It allows specifying which properties should be included or excluded for indexing and provides functionality to define additional configurations like field mapping strategies and parameterization.

Equivalent of a single field-mapping annotation DynamicAttributes.

Instances of this class should be built using the DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final String[]	excludedCategories
protected final String[]	excludedProperties
protected final ReferenceAttributesIndexingMode	referenceAttributesIndexingMode

Fields inherited from class io.jmix.search.index.mapping.AbstractAttributesGroupConfiguration

fieldConfiguration, fieldMappingStrategy, fieldMappingStrategyClass, order, parameters, propertyValueExtractor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DynamicAttributesGroupConfiguration(DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder builder)

Method Summary

Modifier and Type	Method	Description
static DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder	builder()
String[]	getExcludedCategories()	Retrieves the categories that are excluded from processing or indexing.
String[]	getExcludedProperties()	Provides full names of properties that should NOT be indexed.
ReferenceAttributesIndexingMode	getReferenceAttributesIndexingMode()	Gets the reference attributes indexing mode.

Methods inherited from class io.jmix.search.index.mapping.AbstractAttributesGroupConfiguration

getFieldConfiguration, getFieldMappingStrategy, getFieldMappingStrategyClass, getOrder, getParameters, getPropertyValueExtractor

Methods inherited from class java.lang.Object

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

Field Details

excludedCategories

protected final String[] excludedCategories

excludedProperties

protected final String[] excludedProperties

referenceAttributesIndexingMode

protected final ReferenceAttributesIndexingMode referenceAttributesIndexingMode

Constructor Details

DynamicAttributesGroupConfiguration

protected DynamicAttributesGroupConfiguration(DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder builder)

Method Details

getExcludedProperties

public String[] getExcludedProperties()

Provides full names of properties that should NOT be indexed.

Returns:

property names

builder

public static DynamicAttributesGroupConfiguration.DynamicAttributeGroupDefinitionBuilder builder()

getExcludedCategories

public String[] getExcludedCategories()

Retrieves the categories that are excluded from processing or indexing.

Returns:

an array of the excluded category names.

getReferenceAttributesIndexingMode

public ReferenceAttributesIndexingMode getReferenceAttributesIndexingMode()

Gets the reference attributes indexing mode.

Returns:

the reference attributes indexing mode