Package org.opencms.search.fields

Class A_CmsSearchFieldConfiguration

java.lang.Object

org.opencms.search.fields.A_CmsSearchFieldConfiguration

All Implemented Interfaces:

Serializable, Comparable<I_CmsSearchFieldConfiguration>, I_CmsSearchFieldConfiguration

Direct Known Subclasses:

CmsSearchFieldConfiguration

public abstract class A_CmsSearchFieldConfiguration
extends 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

Modifier and Type	Method	Description
void	addField(CmsSearchField field)	Adds a field to this search field configuration.
void	addUninvertingMappings(Map<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 to UninvertingReader.wrap(org.apache.lucene.index.DirectoryReader, Map).
int	compareTo(I_CmsSearchFieldConfiguration o)
boolean	equals(Object obj)
String	getDescription()	Returns the description of this field configuration.
CmsSearchField	getField(String name)	Returns the configured CmsSearchField instance with the given name.
List<String>	getFieldNames()	Returns the list of configured field names (Strings).
List<CmsSearchField>	getFields()	Returns the list of configured CmsSearchField instances.
String	getName()	Returns the name of this field configuration.
int	hashCode()
void	init()	Initializes this field configuration.
void	setDescription(String description)	Sets the description of this field configuration.
void	setName(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 Details

A_CmsSearchFieldConfiguration

public A_CmsSearchFieldConfiguration()

Creates a new empty field configuration.

Method Details

addField

public void addField(CmsSearchField field)

Adds a field to this search field configuration.

Specified by:

addField in interface I_CmsSearchFieldConfiguration

Parameters:

field - the field to add

addUninvertingMappings

public void addUninvertingMappings(Map<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 to UninvertingReader.wrap(org.apache.lucene.index.DirectoryReader, Map). The method adds the configured fields.

Specified by:

addUninvertingMappings in interface I_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 interface Comparable<I_CmsSearchFieldConfiguration>

See Also:

• Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

getDescription

public String getDescription()

Description copied from interface: I_CmsSearchFieldConfiguration

Returns the description of this field configuration.

Specified by:

getDescription in interface I_CmsSearchFieldConfiguration

Returns:

the description of this field configuration

See Also:

• I_CmsSearchFieldConfiguration.getDescription()

getField

public CmsSearchField getField(String name)

Returns the configured CmsSearchField 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 List<String> getFieldNames()

Returns the list of configured field names (Strings).

Returns:

the list of configured field names (Strings)

getFields

public List<CmsSearchField> getFields()

Returns the list of configured CmsSearchField instances.

Specified by:

getFields in interface I_CmsSearchFieldConfiguration

Returns:

the list of configured CmsSearchField instances

getName

public String getName()

Description copied from interface: I_CmsSearchFieldConfiguration

Returns the name of this field configuration.

Specified by:

getName in interface I_CmsSearchFieldConfiguration

Returns:

the name of this field configuration

See Also:

• I_CmsSearchFieldConfiguration.getName()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

init

public void init()

Description copied from interface: I_CmsSearchFieldConfiguration

Initializes this field configuration.

Specified by:

init in interface I_CmsSearchFieldConfiguration

See Also:

• I_CmsSearchFieldConfiguration.init()

setDescription

public void setDescription(String description)

Description copied from interface: I_CmsSearchFieldConfiguration

Sets the description of this field configuration.

Specified by:

setDescription in interface I_CmsSearchFieldConfiguration

Parameters:

description - the description to set

See Also:

• I_CmsSearchFieldConfiguration.setDescription(java.lang.String)

setName

public void setName(String name)

Description copied from interface: I_CmsSearchFieldConfiguration

Sets the name of this field configuration.

Specified by:

setName in interface I_CmsSearchFieldConfiguration

Parameters:

name - the name to set

See Also:

• I_CmsSearchFieldConfiguration.setName(java.lang.String)