org.opencms.search.fields
Class CmsSearchFieldConfiguration

java.lang.Object
  extended byorg.opencms.search.fields.CmsSearchFieldConfiguration
All Implemented Interfaces:
java.lang.Comparable

public class CmsSearchFieldConfiguration
extends java.lang.Object
implements java.lang.Comparable

Describes a configuration of fields that are used in building a search index.

Since:
7.0.0
Version:
$Revision: 1.4 $
Author:
Alexander Kandzior

Field Summary
static CmsSearchFieldConfiguration DEFAULT_STANDARD
          The default for the standard search configuration.
static java.lang.String STR_STANDARD
          The name for the standard field configuration.
static java.lang.String STR_STANDARD_DESCRIPTION
          The description for the standard field configuration.
 
Constructor Summary
CmsSearchFieldConfiguration()
          Creates a new, empty field configuration.
 
Method Summary
 void addField(CmsSearchField field)
          Adds a field to this search field configuration.
 int compareTo(java.lang.Object obj)
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getDescription()
          Returns the description of this field configuration.
 java.util.List getExcerptFieldNames()
          Returns a list of all field names (Strings) that are used in generating the search excerpt.
 java.util.List getFieldNames()
          Returns the list of configured field names (Strings).
 java.util.List getFields()
          Returns the list of configured CmsSearchField instances.
 java.lang.String getName()
          Returns the name of this field configuration.
 int hashCode()
           
 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
 

Field Detail

DEFAULT_STANDARD

public static final CmsSearchFieldConfiguration DEFAULT_STANDARD
The default for the standard search configuration.

This defines the default that is used in case no "standard" field configuration is defined in opencms-search.xml.


STR_STANDARD

public static final java.lang.String STR_STANDARD
The name for the standard field configuration.

See Also:
Constant Field Values

STR_STANDARD_DESCRIPTION

public static final java.lang.String STR_STANDARD_DESCRIPTION
The description for the standard field configuration.

See Also:
Constant Field Values
Constructor Detail

CmsSearchFieldConfiguration

public CmsSearchFieldConfiguration()
Creates a new, empty field configuration.

Method Detail

addField

public void addField(CmsSearchField field)
Adds a field to this search field configuration.

Parameters:
field - the field to add

compareTo

public int compareTo(java.lang.Object obj)
Specified by:
compareTo in interface java.lang.Comparable
See Also:
Comparable.compareTo(Object)

equals

public boolean equals(java.lang.Object obj)
See Also:
Object.equals(java.lang.Object)

getDescription

public java.lang.String getDescription()
Returns the description of this field configuration.

Returns:
the description of this field configuration

getExcerptFieldNames

public java.util.List getExcerptFieldNames()
Returns a list of all field names (Strings) that are used in generating the search excerpt.

Returns:
a list of all field names (Strings) that are used in generating the search excerpt

getFieldNames

public java.util.List getFieldNames()
Returns the list of configured field names (Strings).

Returns:
the list of configured field names (Strings)

getFields

public java.util.List getFields()
Returns the list of configured CmsSearchField instances.

Returns:
the list of configured CmsSearchField instances

getName

public java.lang.String getName()
Returns the name of this field configuration.

Returns:
the name of this field configuration

hashCode

public int hashCode()
See Also:
Object.hashCode()

setDescription

public void setDescription(java.lang.String description)
Sets the description of this field configuration.

Parameters:
description - the description to set

setName

public void setName(java.lang.String name)
Sets the name of this field configuration.

Parameters:
name - the name to set