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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<AttributesGroupProcessor<? extends AttributesGroupConfiguration>>	attributesGroupProcessors
protected final InstanceNameRelatedPropertiesResolver	instanceNameRelatedPropertiesResolver
protected final MappingFieldAnnotationProcessorsRegistry	mappingFieldAnnotationProcessorsRegistry
protected final Metadata	metadata
protected final MethodArgumentsProvider	methodArgumentsProvider
protected final PropertyValueExtractorProvider	propertyValueExtractorProvider
protected final SearchProperties	searchProperties

Constructor Summary

Constructors

Constructor

Description

AnnotatedIndexDefinitionProcessor(Metadata metadata, MappingFieldAnnotationProcessorsRegistry mappingFieldAnnotationProcessorsRegistry, PropertyValueExtractorProvider propertyValueExtractorProvider, SearchProperties searchProperties, ContextArgumentResolverComposite resolvers, List<AttributesGroupProcessor<?>> attributesGroupProcessors, InstanceNameRelatedPropertiesResolver instanceNameRelatedPropertiesResolver)

Method Summary

Modifier and Type	Method	Description
IndexConfiguration	appendContributedFields(IndexConfiguration base, ContributedIndexDefinition definition)	Adds the fields of a contributed definition to an existing configuration.
protected <T> T	callMethod(Class<?> ownerClass, Method method)
protected Object	createClassProxyInstance(Class<?> ownerClass)
protected DisplayedNameDescriptor	createDisplayedNameDescriptor(MetaClass metaClass)
protected ExtendedSearchSettings	createExtendedSearchSettings(Class<?> indexDefinitionClass)
protected Predicate<Object>	createIndexablePredicate(AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parsedIndexDefinition)
IndexConfiguration	createIndexConfiguration(ContributedIndexDefinition definition)	Creates an index configuration for an entity that has no annotated Java definition.
IndexConfiguration	createIndexConfiguration(String className)	Processes index definition interface marked with JmixEntitySearchIndex annotation and creates IndexConfiguration based on it.
protected IndexMappingConfiguration	createIndexMappingConfig(AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parsedIndexDefinition)
protected String	createIndexName(AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parsedIndexDefinition)
protected String	createIndexName(@Nullable String explicitIndexName, MetaClass metaClass)
protected Object	createInterfaceProxyInstance(Class<?> ownerClass)
protected Object	createProxy(Class<?> ownerClass)
protected Set<Class<?>>	getAffectedEntityClasses(IndexMappingConfiguration indexMappingConfiguration)
protected @Nullable 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 AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition	parseIndexDefinition(Class<?> indexDefinitionClass)
protected void	processAnnotation(MappingDefinition.MappingDefinitionBuilder builder, Annotation annotation, MetaClass entityMetaClass)
protected Map<String,MappingFieldDescriptor>	processMappingDefinition(MetaClass metaClass, MappingDefinition mappingDefinition, ExtendedSearchSettings extendedSearchSettings)
protected Class<?>	resolveClass(String className)

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

mappingFieldAnnotationProcessorsRegistry

protected final MappingFieldAnnotationProcessorsRegistry mappingFieldAnnotationProcessorsRegistry

propertyValueExtractorProvider

protected final PropertyValueExtractorProvider propertyValueExtractorProvider

searchProperties

protected final SearchProperties searchProperties

methodArgumentsProvider

protected final MethodArgumentsProvider methodArgumentsProvider

attributesGroupProcessors

protected final List<AttributesGroupProcessor<? extends AttributesGroupConfiguration>> attributesGroupProcessors

instanceNameRelatedPropertiesResolver

protected final InstanceNameRelatedPropertiesResolver instanceNameRelatedPropertiesResolver

Constructor Details

AnnotatedIndexDefinitionProcessor

@Autowired
public AnnotatedIndexDefinitionProcessor(Metadata metadata,
 MappingFieldAnnotationProcessorsRegistry mappingFieldAnnotationProcessorsRegistry,
 PropertyValueExtractorProvider propertyValueExtractorProvider,
 SearchProperties searchProperties,
 ContextArgumentResolverComposite resolvers,
 List<AttributesGroupProcessor<?>> attributesGroupProcessors,
 InstanceNameRelatedPropertiesResolver instanceNameRelatedPropertiesResolver)

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

createIndexConfiguration

public IndexConfiguration createIndexConfiguration(ContributedIndexDefinition definition)

Creates an index configuration for an entity that has no annotated Java definition.

Parameters:

definition - contributed definition

Returns:

index configuration

appendContributedFields

public IndexConfiguration appendContributedFields(IndexConfiguration base,
 ContributedIndexDefinition definition)

Adds the fields of a contributed definition to an existing configuration. Fields already present in the existing configuration win over contributed ones with the same name. The index name, the extended search settings and the indexable predicate of the existing configuration are kept.

Parameters:

base - configuration built from the annotated Java definition

definition - contributed definition for the same entity

Returns:

a new index configuration with the merged fields

resolveClass

protected Class<?> resolveClass(String className)

parseIndexDefinition

protected AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parseIndexDefinition(Class<?> indexDefinitionClass)

createIndexName

protected String createIndexName(AnnotatedIndexDefinitionProcessor.ParsedIndexDefinition parsedIndexDefinition)

createIndexName

protected String createIndexName(@Nullable String explicitIndexName,
 MetaClass metaClass)

createExtendedSearchSettings

protected ExtendedSearchSettings createExtendedSearchSettings(Class<?> indexDefinitionClass)

createIndexMappingConfig

protected IndexMappingConfiguration createIndexMappingConfig(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(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

protected @Nullable 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)

processMappingDefinition

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

createDisplayedNameDescriptor

protected DisplayedNameDescriptor createDisplayedNameDescriptor(MetaClass metaClass)