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

Class LuceneOperationsSupport

java.lang.Object

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

All Implemented Interfaces:

LuceneOperations

Direct Known Subclasses:

LuceneAccessor, ProjectingLuceneOperationsSupport

public abstract class LuceneOperationsSupport
extends Object
implements LuceneOperations

LuceneOperationsSupport is a abstract supporting class for implementations of the LuceneOperations interface.

Since:

1.1.0

Author:

John Blum

See Also:

• LuceneOperations

Field Summary

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

DEFAULT_PAGE_SIZE, DEFAULT_RESULT_LIMIT

Constructor Summary

Constructors

Constructor	Description
LuceneOperationsSupport()

Method Summary

Modifier and Type	Method	Description
<K, V> List<LuceneResultStruct<K,V>>	query(String query, String defaultField, int resultLimit)	Executes the given Lucene query with a limit on the number of results returned.
<K, V> PageableLuceneQueryResults<K,V>	query(String query, String defaultField, int resultLimit, int pageSize)	Executes the given Lucene query with a limit on the number of results returned along with a page size for paging.
<K, V> List<LuceneResultStruct<K,V>>	query(LuceneQueryProvider queryProvider, int resultLimit)	Executes the given Lucene query with a limit on the number of results returned.
<K, V> PageableLuceneQueryResults<K,V>	query(LuceneQueryProvider queryProvider, int resultLimit, int pageSize)	Executes the given Lucene query with a limit on the number of results returned along with a page size for paging.
<K> Collection<K>	queryForKeys(String query, String defaultField, int resultLimit)	Executes the given Lucene query returning a Collection of keys matching the query clause/predicate with a limit on the number of keys returned.
<K> Collection<K>	queryForKeys(LuceneQueryProvider queryProvider, int resultLimit)	Executes the given Lucene query returning a Collection of keys matching the query clause/predicate with a limit on the number of keys returned.
<V> Collection<V>	queryForValues(String query, String defaultField, int resultLimit)	Executes the given Lucene query returning a Collection of values matching the query clause/predicate.
<V> Collection<V>	queryForValues(LuceneQueryProvider queryProvider, int resultLimit)	Executes the given Lucene query returning a Collection of values matching the query clause/predicate.

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

LuceneOperationsSupport

public LuceneOperationsSupport()

Method Details

query

public <K,
V> List<LuceneResultStruct<K,V>> query(String query,
 String defaultField,
 int resultLimit)

Description copied from interface: LuceneOperations

Executes the given Lucene query with a limit on the number of results returned.

Specified by:

query in interface LuceneOperations

Type Parameters:

K - Class type of the key.

V - Class type of the value.

Parameters:

query - String containing the Lucene query to execute.

defaultField - String specifying the default field used in Lucene queries when a field is not explicitly defined in the Lucene query clause.

resultLimit - limit on the number of query results to return.

Returns:

a List of LuceneResultStruct containing the query results.

See Also:

• LuceneResultStruct
• List

query

public <K,
V> PageableLuceneQueryResults<K,V> query(String query,
 String defaultField,
 int resultLimit,
 int pageSize)

Description copied from interface: LuceneOperations

Executes the given Lucene query with a limit on the number of results returned along with a page size for paging.

Specified by:

query in interface LuceneOperations

Type Parameters:

K - Class type of the key.

V - Class type of the value.

Parameters:

query - String containing the Lucene query to execute.

defaultField - String specifying the default field used in Lucene queries when a field is not explicitly defined in the Lucene query clause.

resultLimit - limit on the number of query results to return.

pageSize - number of results per page.

Returns:

a PageableLuceneQueryResults data structure containing the results of the Lucene query.

See Also:

• PageableLuceneQueryResults

query

public <K,
V> List<LuceneResultStruct<K,V>> query(LuceneQueryProvider queryProvider,
 int resultLimit)

Description copied from interface: LuceneOperations

Executes the given Lucene query with a limit on the number of results returned.

Specified by:

query in interface LuceneOperations

Type Parameters:

K - Class type of the key.

V - Class type of the value.

Parameters:

queryProvider - LuceneQueryProvider is a provider implementation supplying the Lucene query to execute as well as de/serialize to distribute across the cluster.

resultLimit - limit on the number of query results to return.

Returns:

a List of LuceneResultStruct containing the query results.

See Also:

• LuceneQueryProvider
• LuceneResultStruct
• List

query

public <K,
V> PageableLuceneQueryResults<K,V> query(LuceneQueryProvider queryProvider,
 int resultLimit,
 int pageSize)

Description copied from interface: LuceneOperations

Executes the given Lucene query with a limit on the number of results returned along with a page size for paging.

Specified by:

query in interface LuceneOperations

Type Parameters:

K - Class type of the key.

V - Class type of the value.

Parameters:

queryProvider - LuceneQueryProvider is a provider implementation supplying the Lucene query to execute as well as de/serialize to distribute across the cluster.

resultLimit - limit on the number of query results to return.

pageSize - number of results per page.

Returns:

a PageableLuceneQueryResults data structure containing the results of the Lucene query.

See Also:

• LuceneQueryProvider
• PageableLuceneQueryResults

queryForKeys

public <K> Collection<K> queryForKeys(String query,
 String defaultField,
 int resultLimit)

Description copied from interface: LuceneOperations

Executes the given Lucene query returning a Collection of keys matching the query clause/predicate with a limit on the number of keys returned.

Specified by:

queryForKeys in interface LuceneOperations

Type Parameters:

K - Class type of the key.

Parameters:

query - String containing the Lucene query to execute.

defaultField - String specifying the default field used in Lucene queries when a field is not explicitly defined in the Lucene query clause.

resultLimit - limit on the number of keys returned.

Returns:

a Collection of keys matching the Lucene query clause (predicate).

See Also:

• LuceneOperations.queryForKeys(String, String, int)
• Collection

queryForKeys

public <K> Collection<K> queryForKeys(LuceneQueryProvider queryProvider,
 int resultLimit)

Description copied from interface: LuceneOperations

Executes the given Lucene query returning a Collection of keys matching the query clause/predicate with a limit on the number of keys returned.

Specified by:

queryForKeys in interface LuceneOperations

Type Parameters:

K - Class type of the key.

Parameters:

queryProvider - LuceneQueryProvider is a provider implementation supplying the Lucene query to execute as well as de/serialize to distribute across the cluster.

resultLimit - limit on the number of keys returned.

Returns:

a Collection of keys matching the Lucene query clause (predicate).

See Also:

• LuceneQueryProvider
• LuceneOperations.queryForKeys(String, String, int)
• Collection

queryForValues

public <V> Collection<V> queryForValues(String query,
 String defaultField,
 int resultLimit)

Description copied from interface: LuceneOperations

Executes the given Lucene query returning a Collection of values matching the query clause/predicate.

Specified by:

queryForValues in interface LuceneOperations

Type Parameters:

V - Class type of the value.

Parameters:

query - String containing the Lucene query to execute.

defaultField - String specifying the default field used in Lucene queries when a field is not explicitly defined in the Lucene query clause.

resultLimit - limit on the number of values returned.

Returns:

a Collection of values matching Lucene query clause (predicate).

See Also:

• LuceneOperations.queryForValues(String, String, int)
• Collection

queryForValues

public <V> Collection<V> queryForValues(LuceneQueryProvider queryProvider,
 int resultLimit)

Description copied from interface: LuceneOperations

Executes the given Lucene query returning a Collection of values matching the query clause/predicate.

Specified by:

queryForValues in interface LuceneOperations

Type Parameters:

V - Class type of the value.

Parameters:

queryProvider - LuceneQueryProvider is a provider implementation supplying the Lucene query to execute as well as de/serialize to distribute across the cluster.

resultLimit - limit on the number of values returned.

Returns:

a Collection of values matching Lucene query clause (predicate).

See Also:

• LuceneQueryProvider
• LuceneOperations.queryForValues(String, String, int)
• Collection