org.springframework.data.gemfire.config.annotation

Class IndexConfiguration

java.lang.Object

org.springframework.data.gemfire.config.annotation.EntityDefinedRegionsConfiguration

org.springframework.data.gemfire.config.annotation.IndexConfiguration

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, ImportBeanDefinitionRegistrar

public class IndexConfiguration
extends EntityDefinedRegionsConfiguration

The IndexConfiguration class is a Spring ImportBeanDefinitionRegistrar and extension of EntityDefinedRegionsConfiguration used in the EnableIndexes annotation to dynamically create GemFire/Geode Region Indexes based on GemfirePersistentEntity GemfirePersistentProperty annotations.

Since:

1.9.0

Author:

John Blum

See Also:

Annotation, BeanDefinitionBuilder, BeanDefinitionRegistry, Id, IndexFactoryBean, IndexType, EntityDefinedRegionsConfiguration, GemfirePersistentEntity, GemfirePersistentProperty, Indexed, Region, Index

Field Summary

Fields inherited from class org.springframework.data.gemfire.config.annotation.EntityDefinedRegionsConfiguration

DEFAULT_REGION_FACTORY_BEAN_CLASS, regionAnnotationToRegionFactoryBeanClass

Constructor Summary

Constructors

Constructor and Description
IndexConfiguration()

Method Summary

Modifier and Type	Method and Description
protected Class<? extends Annotation>	getEnableIndexesAnnotationType() Returns the Annotation type that configures and creates Region Indexes from application persistent entity properties.
protected String	getEnableIndexesAnnotationTypeName() Returns the name of the Annotation type that configures and creates Region Indexes from application persistent entity properties.
protected String	getEnableIndexesAnnotationTypeSimpleName() Returns the simple name of the Annotation type that configures and creates Region Indexes from application persistent entity properties.
protected GemfirePersistentEntity<?>	postProcess(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry, GemfirePersistentEntity<?> persistentEntity) Performs addition post processing on the GemfirePersistentEntity to offer additional feature support (e.g. dynamic Index creation).
protected void	registerIndexBeanDefinition(AnnotationAttributes enableIndexesAttributes, GemfirePersistentEntity<?> persistentEntity, GemfirePersistentProperty persistentProperty, IndexType indexType, Annotation indexAnnotation, BeanDefinitionRegistry registry) Registers an Index of the given IndexType for the GemfirePersistentProperty on the GemfirePersistentEntity using the Annotation meta-data to define the Index.

Methods inherited from class org.springframework.data.gemfire.config.annotation.EntityDefinedRegionsConfiguration

getAnnotationAttributes, getAnnotationAttributes, getAnnotationType, getAnnotationTypeName, getAnnotationTypeSimpleName, getBeanClassLoader, getBeanFactory, getPersistentEntity, isAnnotationPresent, isAnnotationPresent, newGemFireComponentClassTypeScanner, regionAnnotatedPersistentEntityTypeFilters, registerBeanDefinitions, registerRegionBeanDefinition, resolveBasePackages, resolveBeanClassLoader, resolveDomainType, resolveExcludes, resolveIdType, resolveIncludes, resolveMappingContext, resolveRegionAttributesFactoryBeanBuilder, resolveRegionFactoryBeanClass, setBeanClassLoader, setBeanFactory, setClientRegionAttributes, setFixedPartitionRegionAttributes, setPartitionRegionAttributes, setRegionAttributes, setReplicateRegionAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexConfiguration

public IndexConfiguration()

Method Detail

getEnableIndexesAnnotationType

protected Class<? extends Annotation> getEnableIndexesAnnotationType()

Returns the Annotation type that configures and creates Region Indexes from application persistent entity properties.

Returns:

the Annotation type that configures and creates Region Indexes from application persistent entity properties.

See Also:

EnableIndexes, Annotation, Class

getEnableIndexesAnnotationTypeName

protected String getEnableIndexesAnnotationTypeName()

Returns the name of the Annotation type that configures and creates Region Indexes from application persistent entity properties.

Returns:

the name of the Annotation type that configures and creates Region Indexes from application persistent entity properties.

See Also:

getEnableIndexesAnnotationType(), Class.getName()

getEnableIndexesAnnotationTypeSimpleName

protected String getEnableIndexesAnnotationTypeSimpleName()

Returns the simple name of the Annotation type that configures and creates Region Indexes from application persistent entity properties.

Returns:

the simple name of the Annotation type that configures and creates Region Indexes from application persistent entity properties.

See Also:

getEnableIndexesAnnotationType(), Class.getSimpleName()

postProcess

protected GemfirePersistentEntity<?> postProcess(AnnotationMetadata importingClassMetadata,
                                                 BeanDefinitionRegistry registry,
                                                 GemfirePersistentEntity<?> persistentEntity)

Description copied from class: EntityDefinedRegionsConfiguration

Performs addition post processing on the GemfirePersistentEntity to offer additional feature support (e.g. dynamic Index creation).

Overrides:

postProcess in class EntityDefinedRegionsConfiguration

Parameters:

importingClassMetadata - AnnotationMetadata for the importing application class.

registry - BeanDefinitionRegistry used to register Spring bean definitions.

persistentEntity - GemfirePersistentEntity to process.

Returns:

the given GemfirePersistentEntity.

See Also:

BeanDefinitionRegistry, AnnotationMetadata, GemfirePersistentEntity

registerIndexBeanDefinition

protected void registerIndexBeanDefinition(AnnotationAttributes enableIndexesAttributes,
                                           GemfirePersistentEntity<?> persistentEntity,
                                           GemfirePersistentProperty persistentProperty,
                                           IndexType indexType,
                                           Annotation indexAnnotation,
                                           BeanDefinitionRegistry registry)

Registers an Index of the given IndexType for the GemfirePersistentProperty on the GemfirePersistentEntity using the Annotation meta-data to define the Index.

Parameters:

enableIndexesAttributes - AnnotationAttributes containing meta-data for the EnableIndexes annotation.

persistentEntity - GemfirePersistentEntity containing the GemfirePersistentProperty to be indexed.

persistentProperty - GemfirePersistentProperty for which the Index will be created.

indexType - IndexType enum specifying the Index type (e.g. KEY, HASH, etc).

indexAnnotation - Index Annotation.

registry - BeanDefinitionRegistry used to register the Index bean definition.

See Also:

Annotation, BeanDefinitionBuilder, BeanDefinitionRegistry, IndexType, GemfirePersistentEntity, GemfirePersistentProperty