io.jmix.search.index.mapping

Class IndexConfigurationManager

java.lang.Object

io.jmix.search.index.mapping.IndexConfigurationManager

@Component(value="search_IndexConfigurationManager")
public class IndexConfigurationManager
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	IndexConfigurationManager.PropertyTrackingInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.search.index.mapping.IndexConfigurationManager.Registry	registry

Constructor Summary

Constructors

Constructor and Description
IndexConfigurationManager(io.jmix.core.impl.scanning.JmixModulesClasspathScanner classpathScanner, AnnotatedIndexDefinitionProcessor indexDefinitionProcessor, io.jmix.core.InstanceNameProvider instanceNameProvider, IndexDefinitionDetector indexDefinitionDetector, io.jmix.core.MetadataTools metadataTools)

Method Summary

Modifier and Type	Method and Description
java.util.Collection<IndexConfiguration>	getAllIndexConfigurations() Gets all IndexConfiguration registered in application
java.util.Collection<java.lang.String>	getAllIndexedEntities()
java.util.Map<io.jmix.core.metamodel.model.MetaClass,java.util.Set<io.jmix.core.metamodel.model.MetaPropertyPath>>	getDependenciesMetaDataForDelete(java.lang.Class<?> deletedEntityClass) Gets metadata of entities dependent on deleted main entity.
java.util.Map<io.jmix.core.metamodel.model.MetaClass,java.util.Set<io.jmix.core.metamodel.model.MetaPropertyPath>>	getDependenciesMetaDataForUpdate(java.lang.Class<?> entityClass, java.util.Set<java.lang.String> changedProperties) Gets metadata of entities dependent on updated main entity and its changed properties.
IndexConfiguration	getIndexConfigurationByEntityName(java.lang.String entityName) Gets IndexConfiguration registered for provided entity name.
java.util.Optional<IndexConfiguration>	getIndexConfigurationByEntityNameOpt(java.lang.String entityName) Gets optional IndexConfiguration registered for provided entity name.
IndexConfiguration	getIndexConfigurationByIndexName(java.lang.String indexName) Gets IndexConfiguration registered for provided index name.
java.util.Optional<IndexConfiguration>	getIndexConfigurationByIndexNameOpt(java.lang.String indexName) Gets optional IndexConfiguration registered for provided index name.
java.util.Set<java.lang.String>	getLocalPropertyNamesAffectedByUpdate(java.lang.Class<?> entityClass) Gets local property names of provided entity involved into index update process
boolean	isAffectedEntityClass(java.lang.Class<?> entityClass) Checks if provided entity is involved in index process directly or as a part of another entity.
boolean	isDirectlyIndexed(java.lang.String entityName) Checks if provided entity is declared to be indexed directly (not as a part of another entity).

Methods inherited from class java.lang.Object

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

Field Detail

registry

protected final io.jmix.search.index.mapping.IndexConfigurationManager.Registry registry

Constructor Detail

IndexConfigurationManager

@Autowired
public IndexConfigurationManager(io.jmix.core.impl.scanning.JmixModulesClasspathScanner classpathScanner,
                                            AnnotatedIndexDefinitionProcessor indexDefinitionProcessor,
                                            io.jmix.core.InstanceNameProvider instanceNameProvider,
                                            IndexDefinitionDetector indexDefinitionDetector,
                                            io.jmix.core.MetadataTools metadataTools)

Method Detail

getAllIndexConfigurations

public java.util.Collection<IndexConfiguration> getAllIndexConfigurations()

Gets all IndexConfiguration registered in application

Returns:

all IndexConfiguration

getIndexConfigurationByEntityName

public IndexConfiguration getIndexConfigurationByEntityName(java.lang.String entityName)

Gets IndexConfiguration registered for provided entity name. Throws IllegalArgumentException if there is no configuration for provided entity name.

Parameters:

entityName - entity name.

Returns:

IndexConfiguration

getIndexConfigurationByEntityNameOpt

public java.util.Optional<IndexConfiguration> getIndexConfigurationByEntityNameOpt(java.lang.String entityName)

Gets optional IndexConfiguration registered for provided entity name.

Parameters:

entityName - entity name

Returns:

optional IndexConfiguration

getIndexConfigurationByIndexName

public IndexConfiguration getIndexConfigurationByIndexName(java.lang.String indexName)

Gets IndexConfiguration registered for provided index name. Throws IllegalArgumentException if there is no configuration for provided index name.

Parameters:

indexName - index name

Returns:

IndexConfiguration

getIndexConfigurationByIndexNameOpt

public java.util.Optional<IndexConfiguration> getIndexConfigurationByIndexNameOpt(java.lang.String indexName)

Gets optional IndexConfiguration registered for provided index name.

Parameters:

indexName - index name

Returns:

optional IndexConfiguration

getAllIndexedEntities

public java.util.Collection<java.lang.String> getAllIndexedEntities()

isDirectlyIndexed

public boolean isDirectlyIndexed(java.lang.String entityName)

Checks if provided entity is declared to be indexed directly (not as a part of another entity).

Parameters:

entityName - entity name

Returns:

true if entity is indexed, false otherwise

isAffectedEntityClass

public boolean isAffectedEntityClass(java.lang.Class<?> entityClass)

Checks if provided entity is involved in index process directly or as a part of another entity.

Parameters:

entityClass - entity java class

Returns:

true if entity is involved in index process, false otherwise

getLocalPropertyNamesAffectedByUpdate

public java.util.Set<java.lang.String> getLocalPropertyNamesAffectedByUpdate(java.lang.Class<?> entityClass)

Gets local property names of provided entity involved into index update process

Parameters:

entityClass - entity class

Returns:

set of property names

getDependenciesMetaDataForUpdate

public java.util.Map<io.jmix.core.metamodel.model.MetaClass,java.util.Set<io.jmix.core.metamodel.model.MetaPropertyPath>> getDependenciesMetaDataForUpdate(java.lang.Class<?> entityClass,
                                                                                                                                                           java.util.Set<java.lang.String> changedProperties)

Gets metadata of entities dependent on updated main entity and its changed properties.

Parameters:

entityClass - java class of main entity

changedProperties - changed property of main entity

Returns:

dependent entities grouped by their MetaClass. For every meta class group there are set of properties representing dependency-to-main references

getDependenciesMetaDataForDelete

public java.util.Map<io.jmix.core.metamodel.model.MetaClass,java.util.Set<io.jmix.core.metamodel.model.MetaPropertyPath>> getDependenciesMetaDataForDelete(java.lang.Class<?> deletedEntityClass)

Gets metadata of entities dependent on deleted main entity.

Parameters:

deletedEntityClass - java class of main entity

Returns:

dependent entities grouped by their MetaClass. For every meta class group there are set of properties representing dependency-to-main references