org.springframework.data.gemfire

Class IndexFactoryBean

java.lang.Object

org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<org.apache.geode.cache.query.Index>

org.springframework.data.gemfire.IndexFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, FactoryBean<org.apache.geode.cache.query.Index>, InitializingBean

public class IndexFactoryBean
extends AbstractFactoryBeanSupport<org.apache.geode.cache.query.Index>
implements InitializingBean

Spring FactoryBean used to construct, configure and initialize Indexes using a declarative approach.

Since:

1.0.0

Author:

Costin Leau, David Turanski, John Blum

See Also:

Region, RegionService, Index, QueryService, FactoryBean, InitializingBean, IndexFactoryBean.IndexWrapper, IndexConfigurer, AbstractFactoryBeanSupport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	IndexFactoryBean.IndexWrapper

Field Summary

Fields inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

DEFAULT_SINGLETON

Constructor Summary

Constructors

Constructor and Description
IndexFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	applyIndexConfigurers(String indexName, IndexConfigurer... indexConfigurers) Null-safe operation to apply the given array of IndexConfigurers to this IndexFactoryBean.
protected void	applyIndexConfigurers(String indexName, Iterable<IndexConfigurer> indexConfigurers) Null-safe operation to apply the given Iterable of IndexConfigurers to this IndexFactoryBean.
protected IndexConfigurer	getCompositeRegionConfigurer() Returns a reference to the Composite IndexConfigurer used to apply additional configuration to this IndexFactoryBean on Spring container initialization.
org.apache.geode.cache.query.Index	getObject()
Class<?>	getObjectType()
protected boolean	isDefine()
void	setCache(org.apache.geode.cache.RegionService cache) Sets the underlying cache used for creating indexes.
void	setDefine(boolean define) Sets a boolean condition to indicate whether the Index declared and defined by this FactoryBean will only be defined initially, or defined and created.
void	setExpression(String expression)
void	setFrom(String from)
void	setImports(String imports)
void	setIndexConfigurers(IndexConfigurer... indexConfigurers) Null-safe operation to set an array of IndexConfigurers used to apply additional configuration to this IndexFactoryBean when using Annotation-based configuration.
void	setIndexConfigurers(List<IndexConfigurer> indexConfigurers) Null-safe operation to set an Iterable of IndexConfigurers used to apply additional configuration to this IndexFactoryBean when using Annotation-based configuration.
void	setName(String name)
void	setOverride(boolean override)
void	setQueryService(org.apache.geode.cache.query.QueryService service) Sets the query service used for creating indexes.
void	setType(IndexType indexType) Sets the type of GemFire Index to create.
void	setType(String type)

Methods inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

getBeanClassLoader, getBeanFactory, getBeanName, getLog, isSingleton, logDebug, logDebug, logInfo, logInfo, newLog, setBeanClassLoader, setBeanFactory, setBeanName

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexFactoryBean

public IndexFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

applyIndexConfigurers

protected void applyIndexConfigurers(String indexName,
                                     IndexConfigurer... indexConfigurers)

Null-safe operation to apply the given array of IndexConfigurers to this IndexFactoryBean.

Parameters:

indexName - String containing the name of the Index.

indexConfigurers - array of IndexConfigurers applied to this IndexFactoryBean.

See Also:

RegionConfigurer, applyIndexConfigurers(String, Iterable)

applyIndexConfigurers

protected void applyIndexConfigurers(String indexName,
                                     Iterable<IndexConfigurer> indexConfigurers)

Null-safe operation to apply the given Iterable of IndexConfigurers to this IndexFactoryBean.

Parameters:

indexName - String containing the name of the Index.

indexConfigurers - Iterable of IndexConfigurers applied to this IndexFactoryBean.

See Also:

RegionConfigurer

getCompositeRegionConfigurer

protected IndexConfigurer getCompositeRegionConfigurer()

Returns a reference to the Composite IndexConfigurer used to apply additional configuration to this IndexFactoryBean on Spring container initialization.

Returns:

the Composite IndexConfigurer.

See Also:

IndexConfigurer

getObject

public org.apache.geode.cache.query.Index getObject()

Specified by:

getObject in interface FactoryBean<org.apache.geode.cache.query.Index>

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<org.apache.geode.cache.query.Index>

setCache

public void setCache(org.apache.geode.cache.RegionService cache)

Sets the underlying cache used for creating indexes.

Parameters:

cache - cache used for creating indexes.

setQueryService

public void setQueryService(org.apache.geode.cache.query.QueryService service)

Sets the query service used for creating indexes.

Parameters:

service - query service used for creating indexes.

setName

public void setName(String name)

Parameters:

name - the name to set

setDefine

public void setDefine(boolean define)

Sets a boolean condition to indicate whether the Index declared and defined by this FactoryBean will only be defined initially, or defined and created. If defined-only, the IndexFactoryBean will receive a callback at the end of the Spring container lifecycle to subsequently "create" all "defined-only" Indexes once, in a single operation.

Parameters:

define - a boolean value indicating the define or define/create status. If true, the Index declared by this FactoryBean will only be defined initially and subsequently created when this SmartLifecycle bean receives an appropriate callback from the Spring container; if false, the Index will be created immediately.

isDefine

protected boolean isDefine()

setExpression

public void setExpression(String expression)

Parameters:

expression - the expression to set

setFrom

public void setFrom(String from)

Parameters:

from - the from to set

setImports

public void setImports(String imports)

Parameters:

imports - the imports to set

setIndexConfigurers

public void setIndexConfigurers(IndexConfigurer... indexConfigurers)

Null-safe operation to set an array of IndexConfigurers used to apply additional configuration to this IndexFactoryBean when using Annotation-based configuration.

Parameters:

indexConfigurers - array of IndexConfigurers used to apply additional configuration to this IndexFactoryBean.

See Also:

IndexConfigurer, setIndexConfigurers(List)

setIndexConfigurers

public void setIndexConfigurers(List<IndexConfigurer> indexConfigurers)

Null-safe operation to set an Iterable of IndexConfigurers used to apply additional configuration to this IndexFactoryBean when using Annotation-based configuration.

Parameters:

indexConfigurers - Iterable of IndexConfigurers used to apply additional configuration to this IndexFactoryBean.

See Also:

IndexConfigurer

setOverride

public void setOverride(boolean override)

Parameters:

override - the override to set

setType

public void setType(String type)

Parameters:

type - the type to set

setType

public void setType(IndexType indexType)

Sets the type of GemFire Index to create.

Parameters:

indexType - the IndexType enumerated value indicating the type of GemFire Index that will be created by this Spring FactoryBean.

See Also:

IndexType