org.springframework.data.gemfire.search.lucene

Class ProjectingLuceneAccessor

java.lang.Object

org.springframework.data.gemfire.search.lucene.support.LuceneOperationsSupport

org.springframework.data.gemfire.search.lucene.LuceneAccessor

org.springframework.data.gemfire.search.lucene.support.LuceneAccessorSupport

org.springframework.data.gemfire.search.lucene.LuceneTemplate

org.springframework.data.gemfire.search.lucene.ProjectingLuceneAccessor

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, InitializingBean, LuceneOperations, ProjectingLuceneOperations

Direct Known Subclasses:

ProjectingLuceneAccessorSupport, ProjectingLuceneTemplate

public abstract class ProjectingLuceneAccessor
extends LuceneTemplate
implements BeanClassLoaderAware, BeanFactoryAware, ProjectingLuceneOperations

ProjectingLuceneAccessor is an abstract class supporting implementations of the ProjectingLuceneOperations interface encapsulating common functionality necessary to execute Lucene queries and work with application domain object views.

Since:

1.1.0

Author:

John Blum

See Also:

ClassLoader, BeanClassLoaderAware, BeanFactory, BeanFactoryAware, ProjectingLuceneOperations, PdxInstanceMethodInterceptorFactory, ProjectionFactory, SpelAwareProxyProjectionFactory, Region, LuceneIndex, LuceneQuery, LuceneQueryFactory, LuceneService, LuceneServiceProvider

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.gemfire.search.lucene.LuceneAccessor

LuceneAccessor.LuceneQueryExecutor<T>

Field Summary

Fields inherited from interface org.springframework.data.gemfire.search.lucene.LuceneOperations

DEFAULT_PAGE_SIZE, DEFAULT_RESULT_LIMIT

Constructor Summary

Constructors

Constructor and Description
ProjectingLuceneAccessor() Constructs a default, uninitialized instance of the ProjectingLuceneAccessor.
ProjectingLuceneAccessor(org.apache.geode.cache.lucene.LuceneIndex luceneIndex) Constructs an instance of the ProjectingLuceneAccessor initialized with the given LuceneIndex used to perform Lucene queries (searches).
ProjectingLuceneAccessor(String indexName, org.apache.geode.cache.Region<?,?> region) Constructs an instance of the ProjectingLuceneAccessor initialized with the given Lucene index name and Region reference upon which Lucene queries are executed.
ProjectingLuceneAccessor(String indexName, String regionPath) Constructs an instance of the ProjectingLuceneAccessor initialized with the given Lucene index name and Region reference upon which Lucene queries are executed.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected ClassLoader	getBeanClassLoader() Returns a reference to the ClassLoader used by the Spring container to load bean class definitions.
protected BeanFactory	getBeanFactory() Returns a reference to the Spring container.
protected ProjectionFactory	getProjectionFactory() Returns the Spring Data ProjectionFactory used to create projections out of query results.
<T,K,V> List<T>	project(List<org.apache.geode.cache.lucene.LuceneResultStruct<K,V>> source, Class<T> projectionType)
<T,K,V> T	project(org.apache.geode.cache.lucene.LuceneResultStruct<K,V> source, Class<T> projectionType)
<T> T	project(Object source, Class<T> projectionType)
protected ProjectionFactory	resolveProjectionFactory() Null-safe method to resolve the Spring Data ProjectionFactory used to create projections out of the Lucene query results.
void	setBeanClassLoader(ClassLoader beanClassLoader)
void	setBeanFactory(BeanFactory beanFactory)
void	setProjectionFactory(ProjectionFactory projectionFactory) Sets the Spring Data ProjectionFactory used to create projections out of query results.
protected ProjectionFactory	setThenGetProjectionFactory(ProjectionFactory projectionFactory)

Methods inherited from class org.springframework.data.gemfire.search.lucene.LuceneTemplate

query, query, query, query, queryForKeys, queryForKeys, queryForValues, queryForValues

Methods inherited from class org.springframework.data.gemfire.search.lucene.LuceneAccessor

createLuceneQueryFactory, createLuceneQueryFactory, createLuceneQueryFactory, doFind, getCache, getIndexName, getLuceneIndex, getLuceneService, getRegion, getRegionPath, resolveCache, resolveIndexName, resolveLuceneService, resolveLuceneService, resolveRegionPath, setCache, setIndexName, setLuceneIndex, setLuceneService, setRegion, setRegionPath

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.gemfire.search.lucene.ProjectingLuceneOperations

query, query, query, query, query, query

Methods inherited from interface org.springframework.data.gemfire.search.lucene.LuceneOperations

query, query, query, query, query, query, queryForKeys, queryForKeys, queryForKeys, queryForKeys, queryForValues, queryForValues, queryForValues, queryForValues

Constructor Detail

ProjectingLuceneAccessor

public ProjectingLuceneAccessor()

Constructs a default, uninitialized instance of the ProjectingLuceneAccessor.

ProjectingLuceneAccessor

public ProjectingLuceneAccessor(org.apache.geode.cache.lucene.LuceneIndex luceneIndex)

Constructs an instance of the ProjectingLuceneAccessor initialized with the given LuceneIndex used to perform Lucene queries (searches).

Parameters:

luceneIndex - LuceneIndex used in Lucene queries.

See Also:

LuceneIndex

ProjectingLuceneAccessor

public ProjectingLuceneAccessor(String indexName,
                                org.apache.geode.cache.Region<?,?> region)

Constructs an instance of the ProjectingLuceneAccessor initialized with the given Lucene index name and Region reference upon which Lucene queries are executed.

Parameters:

indexName - String containing the name of the LuceneIndex used in Lucene queries.

region - Region on which Lucene queries are executed.

See Also:

Region

ProjectingLuceneAccessor

public ProjectingLuceneAccessor(String indexName,
                                String regionPath)

Constructs an instance of the ProjectingLuceneAccessor initialized with the given Lucene index name and Region reference upon which Lucene queries are executed.

Parameters:

indexName - String containing the name of the LuceneIndex used in Lucene queries.

regionPath - String containing the name of the Region on which Lucene queries are executed.

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class LuceneAccessor

Throws:

Exception

See Also:

resolveProjectionFactory()

resolveProjectionFactory

protected ProjectionFactory resolveProjectionFactory()

Null-safe method to resolve the Spring Data ProjectionFactory used to create projections out of the Lucene query results.

Returns:

a resolved instance of the Spring Data ProjectionFactory used to create projections out of the Lucene query results.

See Also:

ProjectionFactory, SpelAwareProxyProjectionFactory, afterPropertiesSet()

setBeanClassLoader

public void setBeanClassLoader(ClassLoader beanClassLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

getBeanClassLoader

protected ClassLoader getBeanClassLoader()

Returns a reference to the ClassLoader used by the Spring container to load bean class definitions.

Returns:

a reference to the ClassLoader used by the Spring container to load bean class definitions.

See Also:

BeanClassLoaderAware.setBeanClassLoader(ClassLoader), ClassLoader

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

getBeanFactory

protected BeanFactory getBeanFactory()

Returns a reference to the Spring container.

Returns:

a reference to the Spring container.

See Also:

BeanFactoryAware.setBeanFactory(BeanFactory), BeanFactory

setThenGetProjectionFactory

protected ProjectionFactory setThenGetProjectionFactory(ProjectionFactory projectionFactory)

setProjectionFactory

public void setProjectionFactory(ProjectionFactory projectionFactory)

Sets the Spring Data ProjectionFactory used to create projections out of query results.

Parameters:

projectionFactory - Spring Data ProjectionFactory used to created projects out of query results.

See Also:

ProjectionFactory

getProjectionFactory

protected ProjectionFactory getProjectionFactory()

Returns the Spring Data ProjectionFactory used to create projections out of query results.

Returns:

the Spring Data ProjectionFactory used to created projects out of query results.

See Also:

ProjectionFactory

project

public <T,K,V> List<T> project(List<org.apache.geode.cache.lucene.LuceneResultStruct<K,V>> source,
                               Class<T> projectionType)

project

public <T,K,V> T project(org.apache.geode.cache.lucene.LuceneResultStruct<K,V> source,
                         Class<T> projectionType)

project

public <T> T project(Object source,
                     Class<T> projectionType)