org.apache.geode.cache.lucene

Interface LuceneQuery<K,V>

@Experimental
public interface LuceneQuery<K,V>

Provides wrapper object of Lucene's Query object and execute the search.

Instances of this interface are created using LuceneQueryFactory.create(java.lang.String, java.lang.String, java.lang.String, java.lang.String).

Method Summary

Modifier and Type	Method and Description
java.util.Collection<K>	findKeys() Execute search and return keys.
PageableLuceneQueryResults<K,V>	findPages() Execute the search and get results.
java.util.List<LuceneResultStruct<K,V>>	findResults() Execute search and return list of LuceneResultStruct.
java.util.Collection<V>	findValues() Execute search and return values.
int	getLimit() Get limit size setting of current query.
int	getPageSize() Get page size setting of current query.
java.lang.String[]	getProjectedFieldNames() Get projected fields setting of current query.

Method Detail

findKeys

java.util.Collection<K> findKeys()
                          throws LuceneQueryException

Execute search and return keys.

Throws:

LuceneQueryException

findValues

java.util.Collection<V> findValues()
                            throws LuceneQueryException

Execute search and return values.

Throws:

LuceneQueryException

findResults

java.util.List<LuceneResultStruct<K,V>> findResults()
                                             throws LuceneQueryException

Execute search and return list of LuceneResultStruct.

Throws:

LuceneQueryException

findPages

PageableLuceneQueryResults<K,V> findPages()
                                   throws LuceneQueryException

Execute the search and get results.

Throws:

LuceneQueryException

getPageSize

int getPageSize()

Get page size setting of current query.

getLimit

int getLimit()

Get limit size setting of current query.

getProjectedFieldNames

java.lang.String[] getProjectedFieldNames()

Get projected fields setting of current query.