|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--fr.gouv.culture.sdx.search.lucene.FieldsDefinition
Definition of fields for a document base.
| Constructor Summary | |
FieldsDefinition()
This object is used for indexing; it contains a list of fields for a DocumentBase object and contains defaults for fields that do not specify indexing information. |
|
| Method Summary | |
void |
add(Field field)
Adds a field to the list |
void |
addInternalFields(org.apache.avalon.framework.configuration.Configuration conf)
Adds the internal fields defined in sdx.xconf to the list to allow searching using these fields |
java.lang.Object |
clone()
Returns a clone of this FieldsDef. |
void |
configure(org.apache.avalon.framework.configuration.Configuration configuration)
Sets the configuration options for the field definition. |
void |
configureFields(org.apache.avalon.framework.configuration.Configuration configuration)
|
void |
enableLogging(org.apache.avalon.framework.logger.Logger logger)
Sets the logger. |
Analyzer |
getAnalyzer()
Provides access to the analyzer for the field definition. |
Field |
getDefaultField()
Returns the default search field. |
Field |
getField(java.lang.String name)
Returns a field given a field name. |
java.util.Enumeration |
getFields()
Returns all fields in the FieldsDefinition |
int |
getFieldType(java.lang.String name)
Returns the field type. |
java.lang.String |
getId()
|
java.util.Locale |
getLocale()
Provides access to the locale for the field definition. |
java.util.Locale |
getLocale(java.lang.String name)
Returns a locale for a given field. |
org.apache.lucene.document.Field |
getLuceneField(Property prop)
Gets a Lucene field from a property. |
void |
setId(java.lang.String id)
|
void |
setProperties(java.util.Hashtable props)
Sets the properties object. |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public FieldsDefinition()
This object is used for indexing; it contains a list of fields for a DocumentBase object and contains defaults for fields that do not specify indexing information.
| Method Detail |
public void enableLogging(org.apache.avalon.framework.logger.Logger logger)
enableLogging in interface org.apache.avalon.framework.logger.LogEnabledlogger - The logger to use.
public void configure(org.apache.avalon.framework.configuration.Configuration configuration)
throws org.apache.avalon.framework.configuration.ConfigurationException
configure in interface org.apache.avalon.framework.configuration.Configurableconfiguration - The configuration object from which to build the field definition.
org.apache.avalon.framework.configuration.ConfigurationException
public void configureFields(org.apache.avalon.framework.configuration.Configuration configuration)
throws org.apache.avalon.framework.configuration.ConfigurationException
org.apache.avalon.framework.configuration.ConfigurationException
public void addInternalFields(org.apache.avalon.framework.configuration.Configuration conf)
throws SDXException,
org.apache.avalon.framework.configuration.ConfigurationException
conf - The configuration object containing the list of internal fields
SDXException
org.apache.avalon.framework.configuration.ConfigurationExceptionpublic Analyzer getAnalyzer()
public Field getDefaultField()
public int getFieldType(java.lang.String name)
name - The name of the field.
public void add(Field field)
throws SDXException
field - The field to add.
SDXException
public org.apache.lucene.document.Field getLuceneField(Property prop)
throws SDXException
prop - The property from which the field will be dervived
SDXExceptionpublic Field getField(java.lang.String name)
name - The field namepublic java.util.Locale getLocale(java.lang.String name)
public java.util.Locale getLocale()
public void setProperties(java.util.Hashtable props)
props - The properties objectpublic java.util.Enumeration getFields()
public java.lang.String getId()
public void setId(java.lang.String id)
public java.lang.Object clone()
clone in class java.lang.Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||