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

Class AnnotatedIndexDefinitionProcessor

java.lang.Object

io.jmix.search.index.mapping.processor.impl.AnnotatedIndexDefinitionProcessor

@Component("search_AnnotatedIndexDefinitionProcessor")
public class AnnotatedIndexDefinitionProcessor
extends Object

Provides functionality to process index definition interfaces marked with JmixEntitySearchIndex

Field Summary

Fields

Modifier and Type	Field	Description
protected final FieldMappingStrategyProvider	fieldMappingStrategyProvider
protected final IndexAnalysisElementsRegistry	indexAnalysisElementsRegistry
protected final List<IndexSettingsConfigurer>	indexSettingsConfigurers
protected final InstanceNameProvider	instanceNameProvider
protected final MappingFieldAnnotationProcessorsRegistry	mappingFieldAnnotationProcessorsRegistry
protected final Metadata	metadata
protected final MetadataTools	metadataTools
protected final MethodArgumentsProvider	methodArgumentsProvider
protected final PropertyTools	propertyTools
protected final PropertyValueExtractorProvider	propertyValueExtractorProvider
protected final SearchProperties	searchProperties

Constructor Summary

Constructors

Constructor

Description

AnnotatedIndexDefinitionProcessor(Metadata metadata, MetadataTools metadataTools, MappingFieldAnnotationProcessorsRegistry mappingFieldAnnotationProcessorsRegistry, PropertyTools propertyTools, FieldMappingStrategyProvider fieldMappingStrategyProvider, InstanceNameProvider instanceNameProvider, PropertyValueExtractorProvider propertyValueExtractorProvider, SearchProperties searchProperties, List<IndexSettingsConfigurer> indexSettingsConfigurers, ContextArgumentResolverComposite resolvers, IndexAnalysisElementsRegistry indexAnalysisElementsRegistry)

Method Summary

Modifier and Type	Method	Description
protected <T> T	callMethod(Class<?> ownerClass, Method method)
protected void	configureAnalysisSettings(org.elasticsearch.common.settings.Settings.Builder settingsBuilder, IndexMappingConfiguration mappingConfiguration)
protected void	configureIndexSettings(org.elasticsearch.common.settings.Settings.Builder settingsBuilder, Class<?> entityClass)
protected org.elasticsearch.common.settings.Settings	configureSettings(Class<?> entityClass, IndexMappingConfiguration mappingConfiguration)
protected Object	createClassProxyInstance(Class<?> ownerClass)
protected DisplayedNameDescriptor	createDisplayedNameDescriptor(MetaClass metaClass)
protected Predicate<Object>	createIndexablePredicate(io.jmix.search.index.mapping.processor.impl.AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parsedIndexDefinition)
IndexConfiguration	createIndexConfiguration(String className)	Processes index definition interface marked with JmixEntitySearchIndex annotation and creates IndexConfiguration based on it.
protected IndexMappingConfiguration	createIndexMappingConfig(io.jmix.search.index.mapping.processor.impl.AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parsedIndexDefinition)
protected String	createIndexName(io.jmix.search.index.mapping.processor.impl.AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parsedIndexDefinition)
protected Object	createInterfaceProxyInstance(Class<?> ownerClass)
protected Optional<MappingFieldDescriptor>	createMappingFieldDescriptor(MetaPropertyPath propertyPath, MappingDefinitionElement element)
protected Object	createProxy(Class<?> ownerClass)
protected Map<String,MetaPropertyPath>	expandEmbeddedProperties(MetaClass rootEntityMetaClass, Map<String,MetaPropertyPath> propertyPaths)
protected Set<Class<?>>	getAffectedEntityClasses(IndexMappingConfiguration indexMappingConfiguration)
protected Object	invokeProxyMethod(Class<?> ownerClass, Object proxy, Method method, Object[] args)
protected boolean	isFieldMappingAnnotation(Annotation annotation)
protected boolean	isIndexablePredicateMethod(Method method)
protected boolean	isMappingDefinitionImplementationMethod(Method method)
protected io.jmix.search.index.mapping.processor.impl.AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition	parseIndexDefinition(Class<?> indexDefinitionClass)
protected void	processAnnotation(MappingDefinition.MappingDefinitionBuilder builder, Annotation annotation, MetaClass entityMetaClass)
protected Map<String,MappingFieldDescriptor>	processMappingDefinition(MetaClass metaClass, MappingDefinition mappingDefinition)
protected List<MappingFieldDescriptor>	processMappingDefinitionElement(MetaClass metaClass, MappingDefinitionElement element)
protected Class<?>	resolveClass(String className)
protected FieldConfiguration	resolveEffectiveFieldConfiguration(FieldConfiguration strategyFieldConfiguration, FieldConfiguration explicitFieldConfiguration)
protected Map<String,MetaPropertyPath>	resolveEffectiveProperties(MetaClass rootEntityMetaClass, String[] includes, String[] excludes)
protected Optional<FieldMappingStrategy>	resolveFieldMappingStrategy(MappingDefinitionElement element)
protected List<MetaPropertyPath>	resolveInstanceNameRelatedProperties(MetaClass metaClass, MetaPropertyPath rootPropertyPath)
protected List<MetaPropertyPath>	resolveInstanceNameRelatedProperties(MetaPropertyPath propertyPath)

Methods inherited from class java.lang.Object

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

Field Details

metadata

protected final Metadata metadata

metadataTools

protected final MetadataTools metadataTools

mappingFieldAnnotationProcessorsRegistry

protected final MappingFieldAnnotationProcessorsRegistry mappingFieldAnnotationProcessorsRegistry

propertyTools

protected final PropertyTools propertyTools

fieldMappingStrategyProvider

protected final FieldMappingStrategyProvider fieldMappingStrategyProvider

instanceNameProvider

protected final InstanceNameProvider instanceNameProvider

propertyValueExtractorProvider

protected final PropertyValueExtractorProvider propertyValueExtractorProvider

searchProperties

protected final SearchProperties searchProperties

indexSettingsConfigurers

protected final List<IndexSettingsConfigurer> indexSettingsConfigurers

methodArgumentsProvider

protected final MethodArgumentsProvider methodArgumentsProvider

indexAnalysisElementsRegistry

protected final IndexAnalysisElementsRegistry indexAnalysisElementsRegistry

Constructor Details

AnnotatedIndexDefinitionProcessor

@Autowired
public AnnotatedIndexDefinitionProcessor(Metadata metadata,
 MetadataTools metadataTools,
 MappingFieldAnnotationProcessorsRegistry mappingFieldAnnotationProcessorsRegistry,
 PropertyTools propertyTools,
 FieldMappingStrategyProvider fieldMappingStrategyProvider,
 InstanceNameProvider instanceNameProvider,
 PropertyValueExtractorProvider propertyValueExtractorProvider,
 SearchProperties searchProperties,
 List<IndexSettingsConfigurer> indexSettingsConfigurers,
 ContextArgumentResolverComposite resolvers,
 IndexAnalysisElementsRegistry indexAnalysisElementsRegistry)

Method Details

createIndexConfiguration

public IndexConfiguration createIndexConfiguration(String className)

Processes index definition interface marked with JmixEntitySearchIndex annotation and creates IndexConfiguration based on it.

Parameters:

className - full name of index definition interface

Returns:

IndexConfiguration

resolveClass

protected Class<?> resolveClass(String className)

parseIndexDefinition

protected io.jmix.search.index.mapping.processor.impl.AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parseIndexDefinition(Class<?> indexDefinitionClass)

createIndexName

protected String createIndexName(io.jmix.search.index.mapping.processor.impl.AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parsedIndexDefinition)

createIndexMappingConfig

protected IndexMappingConfiguration createIndexMappingConfig(io.jmix.search.index.mapping.processor.impl.AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parsedIndexDefinition)

isIndexablePredicateMethod

protected boolean isIndexablePredicateMethod(Method method)

isMappingDefinitionImplementationMethod

protected boolean isMappingDefinitionImplementationMethod(Method method)

isFieldMappingAnnotation

protected boolean isFieldMappingAnnotation(Annotation annotation)

createIndexablePredicate

protected Predicate<Object> createIndexablePredicate(io.jmix.search.index.mapping.processor.impl.AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parsedIndexDefinition)

callMethod

protected <T> T callMethod(Class<?> ownerClass,
 Method method)
                    throws Exception

Throws:

Exception

createProxy

protected Object createProxy(Class<?> ownerClass)

createInterfaceProxyInstance

protected Object createInterfaceProxyInstance(Class<?> ownerClass)

createClassProxyInstance

protected Object createClassProxyInstance(Class<?> ownerClass)

invokeProxyMethod

@Nullable
protected Object invokeProxyMethod(Class<?> ownerClass,
 Object proxy,
 Method method,
 Object[] args)

processAnnotation

protected void processAnnotation(MappingDefinition.MappingDefinitionBuilder builder,
 Annotation annotation,
 MetaClass entityMetaClass)

getAffectedEntityClasses

protected Set<Class<?>> getAffectedEntityClasses(IndexMappingConfiguration indexMappingConfiguration)

configureSettings

protected org.elasticsearch.common.settings.Settings configureSettings(Class<?> entityClass,
 IndexMappingConfiguration mappingConfiguration)

configureAnalysisSettings

protected void configureAnalysisSettings(org.elasticsearch.common.settings.Settings.Builder settingsBuilder,
 IndexMappingConfiguration mappingConfiguration)

configureIndexSettings

protected void configureIndexSettings(org.elasticsearch.common.settings.Settings.Builder settingsBuilder,
 Class<?> entityClass)

processMappingDefinition

protected Map<String,MappingFieldDescriptor> processMappingDefinition(MetaClass metaClass,
 MappingDefinition mappingDefinition)

processMappingDefinitionElement

protected List<MappingFieldDescriptor> processMappingDefinitionElement(MetaClass metaClass,
 MappingDefinitionElement element)

resolveEffectiveProperties

protected Map<String,MetaPropertyPath> resolveEffectiveProperties(MetaClass rootEntityMetaClass,
 String[] includes,
 String[] excludes)

expandEmbeddedProperties

protected Map<String,MetaPropertyPath> expandEmbeddedProperties(MetaClass rootEntityMetaClass,
 Map<String,MetaPropertyPath> propertyPaths)

createMappingFieldDescriptor

protected Optional<MappingFieldDescriptor> createMappingFieldDescriptor(MetaPropertyPath propertyPath,
 MappingDefinitionElement element)

resolveEffectiveFieldConfiguration

protected FieldConfiguration resolveEffectiveFieldConfiguration(@Nullable
 FieldConfiguration strategyFieldConfiguration,
 @Nullable
 FieldConfiguration explicitFieldConfiguration)

createDisplayedNameDescriptor

protected DisplayedNameDescriptor createDisplayedNameDescriptor(MetaClass metaClass)

resolveInstanceNameRelatedProperties

protected List<MetaPropertyPath> resolveInstanceNameRelatedProperties(MetaPropertyPath propertyPath)

resolveInstanceNameRelatedProperties

protected List<MetaPropertyPath> resolveInstanceNameRelatedProperties(MetaClass metaClass,
 @Nullable
 MetaPropertyPath rootPropertyPath)

resolveFieldMappingStrategy

protected Optional<FieldMappingStrategy> resolveFieldMappingStrategy(MappingDefinitionElement element)