org.apache.geode.cache.lucene

Interface LuceneQueryFactory

@Experimental
public interface LuceneQueryFactory

Factory for creating instances of LuceneQuery. To get an instance of this factory call LuceneService.createLuceneQueryFactory().

To use this factory configure it with the set methods and then call create(java.lang.String, java.lang.String, java.lang.String, java.lang.String) to produce a LuceneQuery instance.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LIMIT Default query result limit is 100
static int	DEFAULT_PAGESIZE Default page size of result is 0, which means no pagination

Method Summary

Modifier and Type	Method and Description
<K,V> LuceneQuery<K,V>	create(java.lang.String indexName, java.lang.String regionName, LuceneQueryProvider provider) Creates a wrapper object for Lucene's Query object.
<K,V> LuceneQuery<K,V>	create(java.lang.String indexName, java.lang.String regionName, java.lang.String queryString, java.lang.String defaultField) Create wrapper object for lucene's QueryParser object using default standard analyzer.
LuceneQueryFactory	setPageSize(int pageSize) Set page size for a query result.
LuceneQueryFactory	setProjectionFields(java.lang.String... fieldNames) Deprecated. TODO This feature is not yet implemented
LuceneQueryFactory	setResultLimit(int limit) Set max limit of result for a query If specified limit is less or equal to zero, throw IllegalArgumentException

Field Detail

DEFAULT_LIMIT

static final int DEFAULT_LIMIT

Default query result limit is 100

See Also:

Constant Field Values

DEFAULT_PAGESIZE

static final int DEFAULT_PAGESIZE

Default page size of result is 0, which means no pagination

See Also:

Constant Field Values

Method Detail

setPageSize

LuceneQueryFactory setPageSize(int pageSize)

Set page size for a query result. The default page size is 0 which means no pagination. If specified negative value, throw IllegalArgumentException

Parameters:

pageSize -

Returns:

itself

setResultLimit

LuceneQueryFactory setResultLimit(int limit)

Set max limit of result for a query If specified limit is less or equal to zero, throw IllegalArgumentException

Parameters:

limit -

Returns:

itself

setProjectionFields

@Deprecated
LuceneQueryFactory setProjectionFields(java.lang.String... fieldNames)

Deprecated. TODO This feature is not yet implemented

Set a list of fields for result projection.

Parameters:

fieldNames -

Returns:

itself

create

<K,V> LuceneQuery<K,V> create(java.lang.String indexName,
                              java.lang.String regionName,
                              java.lang.String queryString,
                              java.lang.String defaultField)

Create wrapper object for lucene's QueryParser object using default standard analyzer. The queryString is using lucene QueryParser's syntax. QueryParser is for easy-to-use with human understandable syntax.

Type Parameters:

K - the key type in the query results

V - the value type in the query results

Parameters:

regionName - region name

indexName - index name

queryString - query string in lucene QueryParser's syntax

defaultField - default field used by the Lucene Query Parser

Returns:

LuceneQuery object

create

<K,V> LuceneQuery<K,V> create(java.lang.String indexName,
                              java.lang.String regionName,
                              LuceneQueryProvider provider)

Creates a wrapper object for Lucene's Query object. This LuceneQuery builder method could be used in advanced cases, such as cases where Lucene's Query object construction needs Lucene's API over query string.

Type Parameters:

K - the key type in the query results

V - the value type in the query results

Parameters:

indexName - index name

regionName - region name

provider - constructs and provides a Lucene Query object

Returns:

LuceneQuery object