Package org.springframework.data.gemfire.search.lucene

Class LuceneAccessor

java.lang.Object

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

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

All Implemented Interfaces:

InitializingBean, LuceneOperations

Direct Known Subclasses:

LuceneAccessorSupport

public abstract class LuceneAccessor
extends LuceneOperationsSupport
implements InitializingBean

LuceneAccessor is an abstract class supporting implementations of the LuceneOperations interface encapsulating common functionality necessary to execute Lucene queries.

Since:

1.1.0

Author:

John Blum

See Also:

• InitializingBean
• LuceneOperationsSupport
• GemFireCache
• Region
• LuceneIndex
• LuceneQuery
• LuceneQueryFactory
• LuceneService
• LuceneServiceProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	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	Description
LuceneAccessor()	Constructs an uninitialized instance of LuceneAccessor.
LuceneAccessor(String indexName, String regionPath)	Constructs an instance of the LuceneAccessor initialized with the given Lucene index name and Region reference upon which Lucene queries are executed.
LuceneAccessor(String indexName, Region<?,?> region)	Constructs an instance of the LuceneAccessor initialized with the given Lucene index name and Region reference upon which Lucene queries are executed.
LuceneAccessor(LuceneIndex luceneIndex)	Constructs an instance of the LuceneAccessor initialized with the given LuceneIndex used to perform Lucene queries (searches).

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
LuceneQueryFactory	createLuceneQueryFactory()	Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.
LuceneQueryFactory	createLuceneQueryFactory(int resultLimit)	Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.
LuceneQueryFactory	createLuceneQueryFactory(int resultLimit, int pageSize)	Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.
protected <T> T	doFind(LuceneAccessor.LuceneQueryExecutor<T> queryExecutor, Object query, String regionPath, String indexName)
protected GemFireCache	getCache()	Returns a reference to the GemFireCache.
String	getIndexName()	Returns the name of the LuceneIndex used in Lucene queries.
LuceneIndex	getLuceneIndex()	Returns a reference to the LuceneIndex used in Lucene queries.
protected LuceneService	getLuceneService()	Returns a reference to the LuceneService used to perform Lucene query data access operations.
Region<?,?>	getRegion()	Returns a reference to the Region used to specify Lucene queries.
String	getRegionPath()	Returns a fully-qualified pathname to the Region used to specify Lucene queries.
protected GemFireCache	resolveCache()	Resolves a reference to the GemFireCache.
protected String	resolveIndexName()	Resolves the name of the LuceneIndex required in the Lucene data access, query operations when a LuceneIndex is not specifically provided.
protected LuceneService	resolveLuceneService()	Resolves the LuceneService used by this data access object to perform Lucene queries.
protected LuceneService	resolveLuceneService(GemFireCache gemfireCache)	Resolves the LuceneService used by this data access object to perform Lucene queries.
protected String	resolveRegionPath()	Resolves the fully-qualified pathname of the Region to which the Lucene data access, query operations are performed and the LuceneIndex is applied, when a region path is not specifically provided.
<T extends LuceneAccessor> T	setCache(GemFireCache gemfireCache)	Sets a reference to the GemFireCache.
<T extends LuceneAccessor> T	setIndexName(String indexName)	Sets the name of the LuceneIndex used in Lucene queries.
<T extends LuceneAccessor> T	setLuceneIndex(LuceneIndex luceneIndex)	Sets a reference to the LuceneIndex used in Lucene queries.
<T extends LuceneAccessor> T	setLuceneService(LuceneService luceneService)	Sets a reference to the LuceneService used to perform Lucene query data access operations.
<T extends LuceneAccessor> T	setRegion(Region<?,?> region)	Sets a reference to the Region used to specify Lucene queries.
<T extends LuceneAccessor> T	setRegionPath(String regionPath)	Sets a fully-qualified pathname to the Region used to specify Lucene queries.

Methods inherited from class org.springframework.data.gemfire.search.lucene.support.LuceneOperationsSupport

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

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

query, query, queryForKeys, queryForKeys, queryForValues, queryForValues

Constructor Details

LuceneAccessor

public LuceneAccessor()

Constructs an uninitialized instance of LuceneAccessor.

LuceneAccessor

public LuceneAccessor(LuceneIndex luceneIndex)

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

Parameters:

luceneIndex - LuceneIndex used in Lucene queries.

See Also:

• LuceneIndex

LuceneAccessor

public LuceneAccessor(String indexName,
 Region<?,?> region)

Constructs an instance of the LuceneAccessor 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

LuceneAccessor

public LuceneAccessor(String indexName,
 String regionPath)

Constructs an instance of the LuceneAccessor 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 Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

createLuceneQueryFactory

public LuceneQueryFactory createLuceneQueryFactory()

Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.

Returns:

an instance of the LuceneQueryFactory to create and execute Lucene queries.

See Also:

• LuceneQueryFactory
• getLuceneService()

createLuceneQueryFactory

public LuceneQueryFactory createLuceneQueryFactory(int resultLimit)

Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.

Parameters:

resultLimit - limit to the number of results returned by the query.

Returns:

an instance of the LuceneQueryFactory to create and execute Lucene queries.

See Also:

• LuceneQueryFactory
• createLuceneQueryFactory(int, int)

createLuceneQueryFactory

public LuceneQueryFactory createLuceneQueryFactory(int resultLimit,
 int pageSize)

Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.

Parameters:

resultLimit - limit to the number of results returned by the query.

pageSize - number of results appearing on a single page.

Returns:

an instance of the LuceneQueryFactory to create and execute Lucene queries.

See Also:

• createLuceneQueryFactory()

resolveCache

protected GemFireCache resolveCache()

Resolves a reference to the GemFireCache.

Returns:

a reference to the single instance of the GemFireCache.

See Also:

• CacheUtils.resolveGemFireCache()
• GemFireCache
• getCache()

resolveLuceneService

protected LuceneService resolveLuceneService()

Resolves the LuceneService used by this data access object to perform Lucene queries.

Returns:

a reference to the GemFireCache LuceneService.

See Also:

• LuceneService
• getLuceneService()
• resolveCache()
• resolveLuceneService(GemFireCache)

resolveLuceneService

protected LuceneService resolveLuceneService(GemFireCache gemfireCache)

Resolves the LuceneService used by this data access object to perform Lucene queries.

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

resolveIndexName

protected String resolveIndexName()

Resolves the name of the LuceneIndex required in the Lucene data access, query operations when a LuceneIndex is not specifically provided.

Returns:

the name of the resolve LuceneIndex.

Throws:

IllegalStateException - if the name of the LuceneIndex cannot be resolved.

See Also:

• LuceneIndex.getName()
• getIndexName()
• getLuceneIndex()

resolveRegionPath

protected String resolveRegionPath()

Resolves the fully-qualified pathname of the Region to which the Lucene data access, query operations are performed and the LuceneIndex is applied, when a region path is not specifically provided.

Returns:

a String containing the fully-qualified pathname of the Region on which the Lucene data access, query operations are performed and the LuceneIndex is applied.

Throws:

IllegalStateException - if the fully-qualified pathname of the Region cannot be resolved.

See Also:

• getRegionPath()
• getRegion()

setCache

public <T extends LuceneAccessor> T setCache(GemFireCache gemfireCache)

Sets a reference to the GemFireCache.

Type Parameters:

T - Class type of the LuceneAccessor.

Parameters:

gemfireCache - GemFireCache reference.

Returns:

this LuceneAccessor.

See Also:

• GemFireCache

getCache

protected GemFireCache getCache()

Returns a reference to the GemFireCache.

Returns:

a reference to the GemFireCache.

See Also:

• GemFireCache
• resolveCache()

setIndexName

public <T extends LuceneAccessor> T setIndexName(String indexName)

Sets the name of the LuceneIndex used in Lucene queries.

Type Parameters:

T - Class type of the LuceneAccessor.

Parameters:

indexName - String containing the name of the LuceneIndex.

Returns:

this LuceneAccessor.

See Also:

• setLuceneIndex(LuceneIndex)

getIndexName

public String getIndexName()

Returns the name of the LuceneIndex used in Lucene queries.

Returns:

a String containing the name of the LuceneIndex.

See Also:

• resolveIndexName()
• getLuceneIndex()

setLuceneIndex

public <T extends LuceneAccessor> T setLuceneIndex(LuceneIndex luceneIndex)

Sets a reference to the LuceneIndex used in Lucene queries.

Type Parameters:

T - Class type of the LuceneAccessor.

Parameters:

luceneIndex - LuceneIndex used in Lucene data access, query operations.

Returns:

this LuceneAccessor.

See Also:

• LuceneIndex
• setIndexName(String)

getLuceneIndex

public LuceneIndex getLuceneIndex()

Returns a reference to the LuceneIndex used in Lucene queries.

Returns:

a LuceneIndex used in Lucene data access, query operations.

See Also:

• LuceneIndex
• resolveIndexName()
• getIndexName()

setLuceneService

public <T extends LuceneAccessor> T setLuceneService(LuceneService luceneService)

Sets a reference to the LuceneService used to perform Lucene query data access operations.

Type Parameters:

T - Class type of the LuceneAccessor.

Parameters:

luceneService - LuceneService used to perform Lucene queries.

Returns:

this LuceneAccessor.

See Also:

• LuceneService

getLuceneService

protected LuceneService getLuceneService()

Returns a reference to the LuceneService used to perform Lucene query data access operations.

Returns:

a reference to the LuceneService used to perform Lucene queries.

See Also:

• LuceneService

setRegion

public <T extends LuceneAccessor> T setRegion(Region<?,?> region)

Sets a reference to the Region used to specify Lucene queries.

Type Parameters:

T - Class type of the LuceneAccessor.

Parameters:

region - Region used to specify Lucene queries.

Returns:

this LuceneAccessor.

See Also:

• Region
• setRegionPath(String)

getRegion

public Region<?,?> getRegion()

Returns a reference to the Region used to specify Lucene queries.

Returns:

a Region used to specify Lucene queries.

See Also:

• Region
• resolveRegionPath()
• getRegionPath()

setRegionPath

public <T extends LuceneAccessor> T setRegionPath(String regionPath)

Sets a fully-qualified pathname to the Region used to specify Lucene queries.

Type Parameters:

T - Class type of the LuceneAccessor.

Parameters:

regionPath - String containing the fully-qualified pathname to the Region used to specify Lucene queries.

Returns:

this LuceneAccessor.

See Also:

• setRegion(Region)

getRegionPath

public String getRegionPath()

Returns a fully-qualified pathname to the Region used to specify Lucene queries.

Returns:

a String containing the fully-qualified pathname to the Region used to specify Lucene queries.

See Also:

• resolveRegionPath()
• getRegion()

doFind

protected <T> T doFind(LuceneAccessor.LuceneQueryExecutor<T> queryExecutor,
 Object query,
 String regionPath,
 String indexName)