Package org.opencms.search.fields
Class A_CmsSearchFieldConfiguration
- java.lang.Object
-
- org.opencms.search.fields.A_CmsSearchFieldConfiguration
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<I_CmsSearchFieldConfiguration>
,I_CmsSearchFieldConfiguration
- Direct Known Subclasses:
CmsSearchFieldConfiguration
public abstract class A_CmsSearchFieldConfiguration extends java.lang.Object implements I_CmsSearchFieldConfiguration
Base class for a typical field configuration. Basically handles name and description and provides defaults for interface methods typically not of interest for most implementations.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description A_CmsSearchFieldConfiguration()
Creates a new empty field configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addField(CmsSearchField field)
Adds a field to this search field configuration.void
addUninvertingMappings(java.util.Map<java.lang.String,org.apache.solr.uninverting.UninvertingReader.Type> uninvertingMap)
To allow sorting on a field (without docvalues) the field must be added to the map given toUninvertingReader.wrap(org.apache.lucene.index.DirectoryReader, Map)
.int
compareTo(I_CmsSearchFieldConfiguration o)
boolean
equals(java.lang.Object obj)
java.lang.String
getDescription()
Returns the description of this field configuration.CmsSearchField
getField(java.lang.String name)
Returns the configuredCmsSearchField
instance with the given name.java.util.List<java.lang.String>
getFieldNames()
Returns the list of configured field names (Strings).java.util.List<CmsSearchField>
getFields()
Returns the list of configuredCmsSearchField
instances.java.lang.String
getName()
Returns the name of this field configuration.int
hashCode()
void
init()
Initializes this field configuration.void
setDescription(java.lang.String description)
Sets the description of this field configuration.void
setName(java.lang.String name)
Sets the name of this field configuration.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.opencms.search.fields.I_CmsSearchFieldConfiguration
createDocument
-
-
-
-
Constructor Detail
-
A_CmsSearchFieldConfiguration
public A_CmsSearchFieldConfiguration()
Creates a new empty field configuration.
-
-
Method Detail
-
addField
public void addField(CmsSearchField field)
Adds a field to this search field configuration.- Specified by:
addField
in interfaceI_CmsSearchFieldConfiguration
- Parameters:
field
- the field to add
-
addUninvertingMappings
public void addUninvertingMappings(java.util.Map<java.lang.String,org.apache.solr.uninverting.UninvertingReader.Type> uninvertingMap)
Description copied from interface:I_CmsSearchFieldConfiguration
To allow sorting on a field (without docvalues) the field must be added to the map given toUninvertingReader.wrap(org.apache.lucene.index.DirectoryReader, Map)
. The method adds the configured fields.- Specified by:
addUninvertingMappings
in interfaceI_CmsSearchFieldConfiguration
- Parameters:
uninvertingMap
- the map to which the fields are added.- See Also:
I_CmsSearchFieldConfiguration.addUninvertingMappings(java.util.Map)
-
compareTo
public int compareTo(I_CmsSearchFieldConfiguration o)
- Specified by:
compareTo
in interfacejava.lang.Comparable<I_CmsSearchFieldConfiguration>
- See Also:
Comparable.compareTo(java.lang.Object)
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
- See Also:
Object.equals(java.lang.Object)
-
getDescription
public java.lang.String getDescription()
Description copied from interface:I_CmsSearchFieldConfiguration
Returns the description of this field configuration.- Specified by:
getDescription
in interfaceI_CmsSearchFieldConfiguration
- Returns:
- the description of this field configuration
- See Also:
I_CmsSearchFieldConfiguration.getDescription()
-
getField
public CmsSearchField getField(java.lang.String name)
Returns the configuredCmsSearchField
instance with the given name.- Parameters:
name
- the search field name to look up- Returns:
- the configured
CmsSearchField
instance with the given name
-
getFieldNames
public java.util.List<java.lang.String> getFieldNames()
Returns the list of configured field names (Strings).- Returns:
- the list of configured field names (Strings)
-
getFields
public java.util.List<CmsSearchField> getFields()
Returns the list of configuredCmsSearchField
instances.- Specified by:
getFields
in interfaceI_CmsSearchFieldConfiguration
- Returns:
- the list of configured
CmsSearchField
instances
-
getName
public java.lang.String getName()
Description copied from interface:I_CmsSearchFieldConfiguration
Returns the name of this field configuration.- Specified by:
getName
in interfaceI_CmsSearchFieldConfiguration
- Returns:
- the name of this field configuration
- See Also:
I_CmsSearchFieldConfiguration.getName()
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
- See Also:
Object.hashCode()
-
init
public void init()
Description copied from interface:I_CmsSearchFieldConfiguration
Initializes this field configuration.- Specified by:
init
in interfaceI_CmsSearchFieldConfiguration
- See Also:
I_CmsSearchFieldConfiguration.init()
-
setDescription
public void setDescription(java.lang.String description)
Description copied from interface:I_CmsSearchFieldConfiguration
Sets the description of this field configuration.- Specified by:
setDescription
in interfaceI_CmsSearchFieldConfiguration
- Parameters:
description
- the description to set- See Also:
I_CmsSearchFieldConfiguration.setDescription(java.lang.String)
-
setName
public void setName(java.lang.String name)
Description copied from interface:I_CmsSearchFieldConfiguration
Sets the name of this field configuration.- Specified by:
setName
in interfaceI_CmsSearchFieldConfiguration
- Parameters:
name
- the name to set- See Also:
I_CmsSearchFieldConfiguration.setName(java.lang.String)
-
-