Package io.jmix.search.index.mapping.processor.impl.dynattr

Class DynamicAttributesAnnotationProcessor

java.lang.Object

io.jmix.search.index.mapping.processor.AbstractFieldAnnotationProcessor<DynamicAttributes>

io.jmix.search.index.mapping.processor.impl.dynattr.DynamicAttributesAnnotationProcessor

All Implemented Interfaces:

FieldAnnotationProcessor<DynamicAttributes>

@Component("search_DynamicAttributesAnnotationProcessor")
public class DynamicAttributesAnnotationProcessor
extends AbstractFieldAnnotationProcessor<DynamicAttributes>

Processor for the DynamicAttributes annotation used in field mapping definitions. This class provides the functionality to process the annotation, extract its parameters, and define a mapping of dynamic attributes to be indexed.

If the 'Dynamic attributes' module is absent, the IndexConfigurationException is thrown.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DynamicAttributesSupport	dynamicAttributesSupport

Constructor Summary

Constructors

Constructor	Description
DynamicAttributesAnnotationProcessor(DynamicAttributesSupport dynamicAttributesSupport)

Method Summary

Modifier and Type	Method	Description
protected DynamicAttributesGroupConfiguration	createDefinition(DynamicAttributes annotation)
protected Map<String,Object>	createParameters(DynamicAttributes specificAnnotation)	Extracts parameters from the annotation.
Class<DynamicAttributes>	getAnnotationClass()	Gets specific annotation class
protected Class<? extends FieldMappingStrategy>	getFieldMappingStrategyClass()	Provides class of FieldMappingStrategy specific for this annotation.
protected void	processSpecificAnnotation(MappingDefinition.MappingDefinitionBuilder builder, MetaClass rootEntityMetaClass, DynamicAttributes annotation)	Processes the DynamicAttributes annotation by verifying the presence of the necessary module and adding a dynamic attributes group to the specified mapping definition builder.

Methods inherited from class io.jmix.search.index.mapping.processor.AbstractFieldAnnotationProcessor

process

Methods inherited from class java.lang.Object

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

Field Details

dynamicAttributesSupport

protected final DynamicAttributesSupport dynamicAttributesSupport

Constructor Details

DynamicAttributesAnnotationProcessor

public DynamicAttributesAnnotationProcessor(DynamicAttributesSupport dynamicAttributesSupport)

Method Details

getAnnotationClass

public Class<DynamicAttributes> getAnnotationClass()

Description copied from interface: FieldAnnotationProcessor

Gets specific annotation class

Returns:

annotation class

processSpecificAnnotation

protected void processSpecificAnnotation(MappingDefinition.MappingDefinitionBuilder builder,
 MetaClass rootEntityMetaClass,
 DynamicAttributes annotation)

Processes the DynamicAttributes annotation by verifying the presence of the necessary module and adding a dynamic attributes group to the specified mapping definition builder.

If the 'Dynamic Attributes' module is not present, this method throws an IndexConfigurationException.

Specified by:

processSpecificAnnotation in class AbstractFieldAnnotationProcessor<DynamicAttributes>

Parameters:

builder - the MappingDefinition.MappingDefinitionBuilder used to define the mapping of attributes

rootEntityMetaClass - the root MetaClass of the entity being processed

annotation - the DynamicAttributes annotation containing configuration for dynamic attributes

Throws:

IndexConfigurationException - if the Dynamic Attributes module is not present

createDefinition

protected DynamicAttributesGroupConfiguration createDefinition(DynamicAttributes annotation)

createParameters

protected Map<String,Object> createParameters(DynamicAttributes specificAnnotation)

Description copied from class: AbstractFieldAnnotationProcessor

Extracts parameters from the annotation.

Specified by:

createParameters in class AbstractFieldAnnotationProcessor<DynamicAttributes>

Parameters:

specificAnnotation - processed annotation

Returns:

map with parameters

getFieldMappingStrategyClass

protected Class<? extends FieldMappingStrategy> getFieldMappingStrategyClass()

Description copied from class: AbstractFieldAnnotationProcessor

Provides class of FieldMappingStrategy specific for this annotation.

Specified by:

getFieldMappingStrategyClass in class AbstractFieldAnnotationProcessor<DynamicAttributes>

Returns:

mapping strategy