org.apache.geode.cache.lucene

Interface LuceneIndex

@Experimental
public interface LuceneIndex

An lucene index is built over the data stored in a GemFire Region.

An index is specified using a index name, field names, region name.

The index name and region name together uniquely identifies the lucene index.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,org.apache.lucene.analysis.Analyzer>	getFieldAnalyzers()
java.lang.String[]	getFieldNames()
java.lang.String	getName()
java.lang.String	getRegionPath()
boolean	waitUntilFlushed(int maxWaitInMillisecond)

Method Detail

getName

java.lang.String getName()

Returns:

the index name of this index

getRegionPath

java.lang.String getRegionPath()

Returns:

the region name for this index

getFieldNames

java.lang.String[] getFieldNames()

Returns:

the indexed field names in a Set

getFieldAnalyzers

java.util.Map<java.lang.String,org.apache.lucene.analysis.Analyzer> getFieldAnalyzers()

Returns:

the field to analyzer map

waitUntilFlushed

boolean waitUntilFlushed(int maxWaitInMillisecond)