public class FieldList extends AbstractSdxObject implements java.lang.Cloneable
SdxObject.ConfigurationNode| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CLASS_NAME_SUFFIX |
_configuration, _context, _description, _encoding, _id, _locale, _logger, _manager, _xmlizable_objects, _xmlLang, isToSaxInitializedDEFAULT_ENCODING| Constructor and Description |
|---|
FieldList()
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.
|
| Modifier and Type | Method and Description |
|---|---|
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) |
Analyzer |
getAnalyzer()
Provides access to the analyzer for the field definition.
|
protected java.lang.String |
getClassNameSuffix()
Sub classes should element this method to return their class name suffix for SAX output
|
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 FieldList
|
int |
getFieldType(java.lang.String name)
Returns the field type.
|
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.
|
protected boolean |
initToSax()
Init the LinkedHashMap _xmlizable_objects with the objects in order to describ them in XML
|
protected void |
initVolatileObjectsToSax()
Init the LinkedHashMap _xmlizable_volatile_objects with the objects in order to describ them in XML
Some objects need to be refresh each time a toSAX is called
|
configureDescription, contextualize, enableLogging, getBaseAttributes, getConfiguration, getContext, getDescription, getEncoding, getId, getLocale, getLog, getServiceManager, getXmlLang, service, setDescription, setEncoding, setId, setLocale, setUpSdxObject, setUpSdxObject, setXmlLang, toSAX, verifyConfigurationResourcespublic static final java.lang.String CLASS_NAME_SUFFIX
public FieldList()
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.
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.Configurableconfigure in class AbstractSdxObjectconfiguration - The configuration object from which to build the field definition.org.apache.avalon.framework.configuration.ConfigurationExceptionpublic void configureFields(org.apache.avalon.framework.configuration.Configuration configuration)
throws org.apache.avalon.framework.configuration.ConfigurationException
org.apache.avalon.framework.configuration.ConfigurationExceptionpublic 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 fieldsSDXExceptionorg.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.SDXExceptionpublic org.apache.lucene.document.Field getLuceneField(Property prop) throws SDXException
prop - The property from which the field will be dervivedSDXExceptionpublic Field getField(java.lang.String name)
name - The field namepublic java.util.Locale getLocale(java.lang.String name)
public java.util.Enumeration getFields()
public java.lang.Object clone()
clone in class java.lang.Objectprotected java.lang.String getClassNameSuffix()
AbstractSdxObjectgetClassNameSuffix in class AbstractSdxObjectprotected boolean initToSax()
AbstractSdxObjectinitToSax in class AbstractSdxObjectprotected void initVolatileObjectsToSax()
initVolatileObjectsToSax in class AbstractSdxObjectCopyright © 2000-2010 Ministere de la culture et de la communication / AJLSM. All Rights Reserved.