|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.search.fields.CmsSearchFieldConfiguration
public class CmsSearchFieldConfiguration
Describes a configuration of fields that are used in building a search index.
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 |
---|
public static final CmsSearchFieldConfiguration DEFAULT_STANDARD
This defines the default that is used in case no "standard" field configuration
is defined in opencms-search.xml
.
public static final java.lang.String STR_STANDARD
public static final java.lang.String STR_STANDARD_DESCRIPTION
Constructor Detail |
---|
public CmsSearchFieldConfiguration()
Method Detail |
---|
public void addField(CmsSearchField field)
field
- the field to addpublic int compareTo(java.lang.Object obj)
compareTo
in interface java.lang.Comparable
Comparable.compareTo(Object)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Object.equals(java.lang.Object)
public java.lang.String getDescription()
public java.util.List getExcerptFieldNames()
public java.util.List getFieldNames()
public java.util.List getFields()
CmsSearchField
instances.
CmsSearchField
instancespublic java.lang.String getName()
public int hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
public void setDescription(java.lang.String description)
description
- the description to setpublic void setName(java.lang.String name)
name
- the name to set
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |