org.springframework.data.gemfire.search.lucene

Class LuceneIndexFactoryBean

java.lang.Object

org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<org.apache.geode.cache.lucene.LuceneIndex>

org.springframework.data.gemfire.search.lucene.LuceneIndexFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, FactoryBean<org.apache.geode.cache.lucene.LuceneIndex>, InitializingBean

public class LuceneIndexFactoryBean
extends AbstractFactoryBeanSupport<org.apache.geode.cache.lucene.LuceneIndex>
implements DisposableBean, InitializingBean

Spring FactoryBean used to construct, configure and initialize Lucene Indexes on application domain object fields.

Since:

1.1.0

Author:

John Blum

See Also:

GemFireCache, Region, LuceneIndex, LuceneService, LuceneServiceProvider, Analyzer, DisposableBean, FactoryBean, InitializingBean, IndexConfigurer, AbstractFactoryBeanSupport

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEFAULT_DESTROY

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

DEFAULT_SINGLETON

Constructor Summary

Constructors

Constructor and Description
LuceneIndexFactoryBean()

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 LuceneIndexFactoryBean.
protected void	applyIndexConfigurers(String indexName, Iterable<IndexConfigurer> indexConfigurers) Null-safe operation to apply the given Iterable of IndexConfigurers to this LuceneIndexFactoryBean.
protected org.apache.geode.cache.lucene.LuceneIndex	createLuceneIndex(String indexName, String regionPath) Creates a LuceneIndex with the given indexName on the GemFireCache Region identified by the given regionPath.
void	destroy()
protected org.apache.geode.cache.GemFireCache	getCache() Returns a reference to the GemFireCache.
protected IndexConfigurer	getCompositeRegionConfigurer() Returns a reference to the Composite IndexConfigurer used to apply additional configuration to this LuceneIndexFactoryBean on Spring container initialization.
protected Map<String,org.apache.lucene.analysis.Analyzer>	getFieldAnalyzers() Returns a Map of application domain object field names to Analyzers used in the construction of the Lucene Indexes for each field.
protected List<String>	getFields() Returns a List of application domain object fields to be indexed.
protected String	getIndexName() Returns the name of the LuceneIndex as identified in the GemFireCache.
Optional<org.apache.geode.cache.lucene.LuceneIndex>	getLuceneIndex() Returns an Optional reference to the LuceneIndex created by this LuceneIndexFactoryBean.
protected org.apache.geode.cache.lucene.LuceneService	getLuceneService() Returns a reference to the LuceneService used by this FactoryBean to create the LuceneIndex.
org.apache.geode.cache.lucene.LuceneIndex	getObject()
Class<?>	getObjectType()
protected org.apache.geode.cache.Region<?,?>	getRegion() Returns a reference to the GemFireCache Region on which the LuceneIndex will be created.
protected String	getRegionPath() Returns the fully-qualified pathname to the GemFireCache Region on which the LuceneIndex will be created.
protected boolean	isDestroy() Determines whether the LuceneIndex will be destroyed on shutdown.
protected boolean	isLuceneIndexDestroyable(org.apache.geode.cache.lucene.LuceneIndex luceneIndex) Determine whether the given LuceneIndex created by this FactoryBean is destroyable.
protected org.apache.geode.cache.GemFireCache	resolveCache() Resolves a reference to the GemFireCache.
protected List<String>	resolveFields(List<String> fields) Resolves the List of fields on the object to index.
protected org.apache.geode.cache.lucene.LuceneIndex	resolveLuceneIndex(String indexName, String regionPath) Attempts to resolve a LuceneIndex by the given indexName first then attempts to create the LuceneIndex with the given Region path.
protected org.apache.geode.cache.lucene.LuceneService	resolveLuceneService() Resolves the LuceneService used by this FactoryBean to create the LuceneIndex.
protected org.apache.geode.cache.lucene.LuceneService	resolveLuceneService(org.apache.geode.cache.GemFireCache gemfireCache) Resolves the LuceneService used by this FactoryBean to create the LuceneIndex.
protected org.apache.geode.cache.Region<?,?>	resolveRegion() Attempts to resolve the GemFireCache Region on which the LuceneIndex will be created.
protected String	resolveRegionPath() Resolves the fully-qualified pathname of the GemFireCache Region on which the LuceneIndex will be created.
void	setBeanName(String name) Sets the bean name assigned to this FactoryBean as declared in the Spring container.
void	setCache(org.apache.geode.cache.GemFireCache gemfireCache) Sets a reference to the GemFireCache.
void	setDestroy(boolean destroy) Sets whether to destroy the LuceneIndex on shutdown.
void	setFieldAnalyzers(Map<String,org.apache.lucene.analysis.Analyzer> fieldAnalyzers) Set a Map of application domain object field names to Analyzers used in the construction of the Lucene Indexes for each field.
void	setFields(List<String> fields) Sets the application domain object fields to index.
void	setFields(String... fields) Sets the application domain object fields to index.
void	setIndexConfigurers(IndexConfigurer... indexConfigurers) Null-safe operation to set an array of IndexConfigurers used to apply additional configuration to this LuceneIndexFactoryBean 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 LuceneIndexFactoryBean when using Annotation-based configuration.
void	setIndexName(String indexName) Sets the name of the LuceneIndex as identified in the GemFireCache.
LuceneIndexFactoryBean	setLuceneIndex(org.apache.geode.cache.lucene.LuceneIndex luceneIndex) Sets the given LuceneIndex as the index created by this FactoryBean.
void	setLuceneService(org.apache.geode.cache.lucene.LuceneService luceneService) Sets a reference to the LuceneService used by this FactoryBean to create the LuceneIndex.
void	setRegion(org.apache.geode.cache.Region<?,?> region) Sets a reference to the GemFireCache Region on which the LuceneIndex will be created.
void	setRegionPath(String pathname) Sets the fully-qualified pathname to the GemFireCache Region on which the LuceneIndex will be created.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DESTROY

protected static final boolean DEFAULT_DESTROY

See Also:

Constant Field Values

Constructor Detail

LuceneIndexFactoryBean

public LuceneIndexFactoryBean()

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 LuceneIndexFactoryBean.

Parameters:

indexName - String containing the name of the LuceneIndex.

indexConfigurers - array of IndexConfigurers applied to this LuceneIndexFactoryBean.

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 LuceneIndexFactoryBean.

Parameters:

indexName - String containing the name of the LuceneIndex.

indexConfigurers - Iterable of IndexConfigurers applied to this LuceneIndexFactoryBean.

See Also:

RegionConfigurer

resolveLuceneIndex

protected org.apache.geode.cache.lucene.LuceneIndex resolveLuceneIndex(String indexName,
                                                                       String regionPath)

Attempts to resolve a LuceneIndex by the given indexName first then attempts to create the LuceneIndex with the given Region path.

Parameters:

indexName - name of the LuceneIndex to resolve.

regionPath - Region path on which the LuceneIndex is applied.

Returns:

the resolved LuceneIndex by the given indexName or the created LuceneIndex with the given Region path if the LuceneIndex could not be resolved by indexName.

See Also:

LuceneService.getIndex(String, String), createLuceneIndex(String, String), getLuceneIndex()

createLuceneIndex

protected org.apache.geode.cache.lucene.LuceneIndex createLuceneIndex(String indexName,
                                                                      String regionPath)

Creates a LuceneIndex with the given indexName on the GemFireCache Region identified by the given regionPath.

Parameters:

indexName - String containing the name for the LuceneIndex.

regionPath - String containing the fully-qualified pathname to the GemFireCache Region.

Returns:

a new instance of LuceneIndex with the given indexName on the named Region.

See Also:

LuceneService.createIndex(String, String, Map), LuceneService.createIndex(String, String, String...), LuceneService.getIndex(String, String), resolveLuceneService(), getFieldAnalyzers(), getFields(), resolveFields(List)

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface DisposableBean

Throws:

Exception

isLuceneIndexDestroyable

protected boolean isLuceneIndexDestroyable(org.apache.geode.cache.lucene.LuceneIndex luceneIndex)

Determine whether the given LuceneIndex created by this FactoryBean is destroyable.

Parameters:

luceneIndex - LuceneIndex subject to destruction.

Returns:

a boolean value indicating whether the given LuceneIndex created by this FactoryBean is destroyable.

See Also:

LuceneIndex, isDestroy()

getObject

public org.apache.geode.cache.lucene.LuceneIndex getObject()
                                                    throws Exception

Specified by:

getObject in interface FactoryBean<org.apache.geode.cache.lucene.LuceneIndex>

Throws:

Exception

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<org.apache.geode.cache.lucene.LuceneIndex>

resolveCache

protected org.apache.geode.cache.GemFireCache resolveCache()

Resolves a reference to the GemFireCache.

Returns:

a reference to the single instance of the GemFireCache.

See Also:

CacheUtils.resolveGemFireCache(), GemFireCache, getCache()

resolveFields

protected List<String> resolveFields(List<String> fields)

Resolves the List of fields on the object to index.

Parameters:

fields - List of fields to evaluate.

Returns:

a resolve List of object fields to index.

resolveLuceneService

protected org.apache.geode.cache.lucene.LuceneService resolveLuceneService()

Resolves the LuceneService used by this FactoryBean to create the LuceneIndex.

Returns:

a reference to the GemFireCache, LuceneService.

See Also:

BeanFactory.getBean(Class), LuceneService, AbstractFactoryBeanSupport.getBeanFactory(), getLuceneService(), resolveCache(), resolveLuceneService(GemFireCache)

resolveLuceneService

protected org.apache.geode.cache.lucene.LuceneService resolveLuceneService(org.apache.geode.cache.GemFireCache gemfireCache)

Resolves the LuceneService used by this FactoryBean to create the LuceneIndex.

Parameters:

gemfireCache - GemFireCache used to resolve the LuceneService.

Returns:

a reference to the GemFireCache LuceneService.

Throws:

IllegalArgumentException - if GemFireCache is null.

See Also:

LuceneService, GemFireCache

resolveRegion

protected org.apache.geode.cache.Region<?,?> resolveRegion()

Attempts to resolve the GemFireCache Region on which the LuceneIndex will be created.

Returns:

a reference to the GemFireCache Region on which he LuceneIndex will be created. Returns null if the Region cannot be resolved.

See Also:

RegionService.getRegion(String), Region, resolveCache(), getRegionPath()

resolveRegionPath

protected String resolveRegionPath()

Resolves the fully-qualified pathname of the GemFireCache Region on which the LuceneIndex will be created.

Returns:

a String containing the fully-qualified pathname of the GemFireCache Region on which the LuceneIndex will be created.

Throws:

IllegalStateException - if the Region pathname could not resolved.

See Also:

resolveRegion(), getRegionPath()

setBeanName

public void setBeanName(String name)

Description copied from class: AbstractFactoryBeanSupport

Sets the bean name assigned to this FactoryBean as declared in the Spring container.

Specified by:

setBeanName in interface BeanNameAware

Overrides:

setBeanName in class AbstractFactoryBeanSupport<org.apache.geode.cache.lucene.LuceneIndex>

Parameters:

name - bean name assigned to this FactoryBean as declared in the Spring container.

See Also:

BeanNameAware.setBeanName(String), String

setCache

public void setCache(org.apache.geode.cache.GemFireCache gemfireCache)

Sets a reference to the GemFireCache.

Parameters:

gemfireCache - GemFireCache reference.

See Also:

GemFireCache

getCache

protected org.apache.geode.cache.GemFireCache getCache()

Returns a reference to the GemFireCache.

Returns:

a reference to the GemFireCache.

See Also:

GemFireCache, resolveCache()

getCompositeRegionConfigurer

protected IndexConfigurer getCompositeRegionConfigurer()

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

Returns:

the Composite IndexConfigurer.

See Also:

IndexConfigurer

setDestroy

public void setDestroy(boolean destroy)

Sets whether to destroy the LuceneIndex on shutdown.

Parameters:

destroy - boolean value indicating whether to destroy the LuceneIndex on shutdown.

isDestroy

protected boolean isDestroy()

Determines whether the LuceneIndex will be destroyed on shutdown.

Returns:

a boolean value indicating whether the LuceneIndex will be destroyed on shutdown.

See Also:

DisposableBean.destroy()

setFieldAnalyzers

public void setFieldAnalyzers(Map<String,org.apache.lucene.analysis.Analyzer> fieldAnalyzers)

Set a Map of application domain object field names to Analyzers used in the construction of the Lucene Indexes for each field.

Parameters:

fieldAnalyzers - Map of fields names to Analyzers.

See Also:

Analyzer, Map

getFieldAnalyzers

protected Map<String,org.apache.lucene.analysis.Analyzer> getFieldAnalyzers()

Returns a Map of application domain object field names to Analyzers used in the construction of the Lucene Indexes for each field.

Returns:

a Map of fields names to Analyzers.

See Also:

Analyzer, Map, getFields()

setFields

public void setFields(String... fields)

Sets the application domain object fields to index.

Parameters:

fields - array of Strings containing the names of the object fields ot index.

See Also:

setFields(List)

setFields

public void setFields(List<String> fields)

Sets the application domain object fields to index.

Parameters:

fields - List of Strings containing the names of the object fields ot index.

getFields

protected List<String> getFields()

Returns a List of application domain object fields to be indexed.

Returns:

a List of application domain object fields to be indexed.

See Also:

getFieldAnalyzers(), List

setIndexConfigurers

public void setIndexConfigurers(IndexConfigurer... indexConfigurers)

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

Parameters:

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

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 LuceneIndexFactoryBean when using Annotation-based configuration.

Parameters:

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

See Also:

IndexConfigurer

setIndexName

public void setIndexName(String indexName)

Sets the name of the LuceneIndex as identified in the GemFireCache.

Parameters:

indexName - String containing the name of the LuceneIndex.

See Also:

setBeanName(String)

getIndexName

protected String getIndexName()

Returns the name of the LuceneIndex as identified in the GemFireCache.

Returns:

a String containing the name of the LuceneIndex.

Throws:

IllegalStateException - if the indexName was not specified.

getLuceneIndex

public Optional<org.apache.geode.cache.lucene.LuceneIndex> getLuceneIndex()

Returns an Optional reference to the LuceneIndex created by this LuceneIndexFactoryBean.

Returns:

an Optional reference to the LuceneIndex created by this LuceneIndexFactoryBean.

See Also:

LuceneIndex, Optional

setLuceneIndex

public LuceneIndexFactoryBean setLuceneIndex(org.apache.geode.cache.lucene.LuceneIndex luceneIndex)

Sets the given LuceneIndex as the index created by this FactoryBean. This method is generally used for testing purposes only.

Parameters:

luceneIndex - LuceneIndex created by this FactoryBean.

Returns:

this LuceneIndexFactoryBean.

See Also:

LuceneIndexFactoryBean, LuceneIndex

setLuceneService

public void setLuceneService(org.apache.geode.cache.lucene.LuceneService luceneService)

Sets a reference to the LuceneService used by this FactoryBean to create the LuceneIndex.

Parameters:

luceneService - LuceneService used to create the LuceneIndex.

See Also:

LuceneService

getLuceneService

protected org.apache.geode.cache.lucene.LuceneService getLuceneService()

Returns a reference to the LuceneService used by this FactoryBean to create the LuceneIndex.

Returns:

a reference to the LuceneService used to create the LuceneIndex.

See Also:

LuceneService, resolveLuceneService()

setRegion

public void setRegion(org.apache.geode.cache.Region<?,?> region)

Sets a reference to the GemFireCache Region on which the LuceneIndex will be created.

Parameters:

region - Region on which the LuceneIndex will be created.

See Also:

Region, setRegionPath(String)

getRegion

protected org.apache.geode.cache.Region<?,?> getRegion()

Returns a reference to the GemFireCache Region on which the LuceneIndex will be created.

Returns:

a reference to the Region on which the LuceneIndex will be created.

See Also:

Region, getRegionPath(), resolveRegion()

setRegionPath

public void setRegionPath(String pathname)

Sets the fully-qualified pathname to the GemFireCache Region on which the LuceneIndex will be created.

Parameters:

pathname - String containing the fully-qualified pathname to the GemFireCache Region on which the LuceneIndex will be created.

See Also:

setRegion(Region)

getRegionPath

protected String getRegionPath()

Returns the fully-qualified pathname to the GemFireCache Region on which the LuceneIndex will be created.

Returns:

a String containing the fully-qualified pathname to the GemFireCache Region on which the LuceneIndex will be created.

See Also:

getRegion()