com.avaje.ebean.config.lucene
Interface IndexDefn<T>

Type Parameters:

T - The type of the entity to build the index on.

All Known Implementing Classes:

AbstractIndexDefn

public interface IndexDefn<T>

Defines a Lucene Index for a given entity type.

Author:

rbygrave

Method Summary

org.apache.lucene.analysis.Analyzer	getAnalyzer() Return the default Analyzer to use for this index.
String	getDefaultField() Return the name of the default query field.
List<IndexFieldDefn>	getFields() Return the index fields.
int	getMaxBufferedDocs() Return the max buffered documents for this index.
org.apache.lucene.index.IndexWriter.MaxFieldLength	getMaxFieldLength() Return the max field length to use for this index.
double	getRAMBufferSizeMB() Return the ram buffer size for this index.
int	getTermIndexInterval() Return the term index interval.
String[]	getUpdateSinceProperties() Return the properties that are the 'last updated timestamp' properties(s).
void	initialise(IndexDefnBuilder helper) Initialise the index defining the fields on the index.
boolean	isUpdateSinceSupported() Return true if incremental index updates are supported via 'last updated timestamp' properties(s).

Method Detail

initialise

void initialise(IndexDefnBuilder helper)

Initialise the index defining the fields on the index.

The IndexDefnBuilder can be used to make defining fields a little easier.

Parameters:

helper - to help create index field definitions

getDefaultField

String getDefaultField()

Return the name of the default query field.

getFields

List<IndexFieldDefn> getFields()

Return the index fields.

isUpdateSinceSupported

boolean isUpdateSinceSupported()

Return true if incremental index updates are supported via 'last updated timestamp' properties(s).

getUpdateSinceProperties

String[] getUpdateSinceProperties()

Return the properties that are the 'last updated timestamp' properties(s).

getAnalyzer

org.apache.lucene.analysis.Analyzer getAnalyzer()

Return the default Analyzer to use for this index.

getMaxFieldLength

org.apache.lucene.index.IndexWriter.MaxFieldLength getMaxFieldLength()

Return the max field length to use for this index.

getMaxBufferedDocs

int getMaxBufferedDocs()

Return the max buffered documents for this index.

getRAMBufferSizeMB

double getRAMBufferSizeMB()

Return the ram buffer size for this index.

getTermIndexInterval

int getTermIndexInterval()

Return the term index interval.