org.apache.geode.cache.lucene

Interface LuceneQueryProvider

All Superinterfaces:

java.io.Serializable

@Experimental
public interface LuceneQueryProvider
extends java.io.Serializable

The instances of this class will be used for distributing Lucene Query objects and re-constructing the Query object. If necessary the implementation needs to take care of serializing and de-serializing Lucene Query object. Geode respects the DataSerializable contract to provide optimal object serialization. For instance, LuceneQueryProvider's toData method will be used to serialize it when it is sent to another member of the distributed system. Implementation of DataSerializable can provide a zero-argument constructor that will be invoked when they are read with DataSerializer.readObject.

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.Query	getQuery(LuceneIndex index)

Method Detail

getQuery

org.apache.lucene.search.Query getQuery(LuceneIndex index)
                                 throws LuceneQueryException

Parameters:

index - local lucene index the query is being constructed against.

Returns:

A Lucene Query object which could be used for executing Lucene Search on indexed data

Throws:

LuceneQueryException - if the provider fails to construct the query object