com.avaje.ebean.config.lucene
Class IndexFieldDefn

java.lang.Object
  com.avaje.ebean.config.lucene.IndexFieldDefn

public class IndexFieldDefn
extends Object

Nested Class Summary

static class

IndexFieldDefn.Sortable

Constructor Summary

IndexFieldDefn(String name)

IndexFieldDefn(String name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, IndexFieldDefn.Sortable sortable)

Method Summary

IndexFieldDefn	copyField(String name) Use this IndexFieldDefn as a template copying all the settings to a new definition using the new name.
IndexFieldDefn	copyFieldConcat(String fieldName, String[] properties) Use this IndexFieldDefn as a template for a CONCATINATED string field.
float	getBoost() Return the boost for this field.
org.apache.lucene.document.Field.Index	getIndex() Return the index this field belongs to.
org.apache.lucene.analysis.Analyzer	getIndexAnalyzer() Return the Analyzer to use to index the values for this field.
String	getName() Return the index field name.
int	getPrecisionStep() Return the precision step for this field.
String	getPropertyName() Return the matching bean property name.
String[]	getPropertyNames() Return the bean properties associated with this field.
org.apache.lucene.analysis.Analyzer	getQueryAnalyzer() Return the Analyzer to use to query this field.
IndexFieldDefn.Sortable	getSortable() Return the Sortable option for this field.
org.apache.lucene.document.Field.Store	getStore() Return the Store option for this field.
void	setBoost(float boost) Set the boost for this field.
IndexFieldDefn	setBothAnalyzers(org.apache.lucene.analysis.Analyzer analyzer) Set the Analyzer to use to both query and index this field.
IndexFieldDefn	setIndex(org.apache.lucene.document.Field.Index index) Set the index this field belongs to.
IndexFieldDefn	setIndexAnalyzer(org.apache.lucene.analysis.Analyzer indexAnalyzer) Set the Analyzer to use to index the values for this field.
IndexFieldDefn	setPrecisionStep(int precisionStep) Set the precision step for this field.
IndexFieldDefn	setPropertyName(String propertyName) Set the associated bean property name.
void	setPropertyNames(String[] properties) Set the bean properties associated with this field.
IndexFieldDefn	setQueryAnalyzer(org.apache.lucene.analysis.Analyzer queryAnalyzer) Set the Analyzer to use to query this field.
IndexFieldDefn	setSortable(IndexFieldDefn.Sortable sortable) Set the Sortable option for this field.
IndexFieldDefn	setStore(org.apache.lucene.document.Field.Store store) Set the Store option for this field.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexFieldDefn

public IndexFieldDefn(String name)

IndexFieldDefn

public IndexFieldDefn(String name,
                      org.apache.lucene.document.Field.Store store,
                      org.apache.lucene.document.Field.Index index,
                      IndexFieldDefn.Sortable sortable)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

copyField

public IndexFieldDefn copyField(String name)

Use this IndexFieldDefn as a template copying all the settings to a new definition using the new name.

Parameters:

name - the name of the new IndexFieldDefn

copyFieldConcat

public IndexFieldDefn copyFieldConcat(String fieldName,
                                      String[] properties)

Use this IndexFieldDefn as a template for a CONCATINATED string field.

getName

public String getName()

Return the index field name.

getPropertyName

public String getPropertyName()

Return the matching bean property name.

setPropertyName

public IndexFieldDefn setPropertyName(String propertyName)

Set the associated bean property name.

getIndex

public org.apache.lucene.document.Field.Index getIndex()

Return the index this field belongs to.

setIndex

public IndexFieldDefn setIndex(org.apache.lucene.document.Field.Index index)

Set the index this field belongs to.

getStore

public org.apache.lucene.document.Field.Store getStore()

Return the Store option for this field.

setStore

public IndexFieldDefn setStore(org.apache.lucene.document.Field.Store store)

Set the Store option for this field.

getSortable

public IndexFieldDefn.Sortable getSortable()

Return the Sortable option for this field.

setSortable

public IndexFieldDefn setSortable(IndexFieldDefn.Sortable sortable)

Set the Sortable option for this field.

getPrecisionStep

public int getPrecisionStep()

Return the precision step for this field.

setPrecisionStep

public IndexFieldDefn setPrecisionStep(int precisionStep)

Set the precision step for this field.

getBoost

public float getBoost()

Return the boost for this field.

setBoost

public void setBoost(float boost)

Set the boost for this field.

getQueryAnalyzer

public org.apache.lucene.analysis.Analyzer getQueryAnalyzer()

Return the Analyzer to use to query this field.

getIndexAnalyzer

public org.apache.lucene.analysis.Analyzer getIndexAnalyzer()

Return the Analyzer to use to index the values for this field.

setQueryAnalyzer

public IndexFieldDefn setQueryAnalyzer(org.apache.lucene.analysis.Analyzer queryAnalyzer)

Set the Analyzer to use to query this field.

setIndexAnalyzer

public IndexFieldDefn setIndexAnalyzer(org.apache.lucene.analysis.Analyzer indexAnalyzer)

Set the Analyzer to use to index the values for this field.

setBothAnalyzers

public IndexFieldDefn setBothAnalyzers(org.apache.lucene.analysis.Analyzer analyzer)

Set the Analyzer to use to both query and index this field.

getPropertyNames

public String[] getPropertyNames()

Return the bean properties associated with this field.

setPropertyNames

public void setPropertyNames(String[] properties)

Set the bean properties associated with this field.