Package io.jmix.search.index.mapping

Class StaticAttributesGroupConfiguration

java.lang.Object

io.jmix.search.index.mapping.AbstractAttributesGroupConfiguration

io.jmix.search.index.mapping.StaticAttributesGroupConfiguration

All Implemented Interfaces:

AttributesGroupConfiguration

Direct Known Subclasses:

MappingDefinitionElement

public class StaticAttributesGroupConfiguration
extends AbstractAttributesGroupConfiguration

The StaticAttributesGroupConfiguration class represents a search configuration for a group of the regular static 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 AutoMappedField.

Instances of this class should be built using the StaticAttributesGroupConfiguration.StaticAttributeGroupBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StaticAttributesGroupConfiguration.StaticAttributeGroupBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final String[]	excludedProperties
protected final String[]	includedProperties

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

fieldConfiguration, fieldMappingStrategy, fieldMappingStrategyClass, order, parameters, propertyValueExtractor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StaticAttributesGroupConfiguration(StaticAttributesGroupConfiguration.StaticAttributeGroupBuilder builder)

Method Summary

Modifier and Type	Method	Description
static StaticAttributesGroupConfiguration.StaticAttributeGroupBuilder	builder()
String[]	getExcludedProperties()	Provides full names of properties that should NOT be indexed.
String[]	getIncludedProperties()	Provides full names of properties that should be indexed.

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

includedProperties

protected final String[] includedProperties

excludedProperties

protected final String[] excludedProperties

Constructor Details

StaticAttributesGroupConfiguration

protected StaticAttributesGroupConfiguration(StaticAttributesGroupConfiguration.StaticAttributeGroupBuilder 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

builder

public static StaticAttributesGroupConfiguration.StaticAttributeGroupBuilder builder()