org.opencms.search.fields

类 CmsLuceneFieldConfiguration

java.lang.Object

org.opencms.search.fields.CmsSearchFieldConfiguration

org.opencms.search.fields.CmsLuceneFieldConfiguration

所有已实现的接口:

java.lang.Comparable<CmsSearchFieldConfiguration>, I_CmsSearchFieldAppdender

直接已知子类:

CmsGallerySearchFieldConfiguration, CmsSearchFieldConfigurationOldCategories

public class CmsLuceneFieldConfiguration
extends CmsSearchFieldConfiguration

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

从以下版本开始:

7.0.0

字段概要

字段

限定符和类型	字段和说明
static CmsLuceneFieldConfiguration	DEFAULT_STANDARD The default for the standard search configuration.
static java.lang.String	STR_STANDARD_DESCRIPTION The description for the standard field configuration.

从类继承的字段 org.opencms.search.fields.CmsSearchFieldConfiguration

LAZY_FIELDS, STR_STANDARD

构造器概要

构造器

构造器和说明
CmsLuceneFieldConfiguration()

方法概要

方法

限定符和类型	方法和说明
void	addField(CmsSearchField field) Adds a field to this search field configuration.
org.apache.lucene.analysis.Analyzer	getAnalyzer(org.apache.lucene.analysis.Analyzer analyzer) Returns an analyzer that wraps the given base analyzer with the analyzers of this individual field configuration.
java.util.List<java.lang.String>	getExcerptFieldNames() Returns a list of all field names (Strings) that are used in generating the search excerpt.
java.util.Set<java.lang.String>	getExcerptFields() Returns the field names used for the excerpt generation.
java.util.List<CmsLuceneField>	getLuceneFields() Returns a list of the concrete Lucene search fields.
java.util.Set<java.lang.String>	getReturnFields() Returns the field names used for a regular result.

从类继承的方法 org.opencms.search.fields.CmsSearchFieldConfiguration

addAdditionalFields, addFields, appendCategories, appendContentBlob, appendDates, appendFieldMapping, appendFieldMappings, appendFields, appendFileSize, appendLocales, appendPath, appendProperties, appendType, compareTo, createDocument, equals, getDescription, getField, getFieldNames, getFields, getIndex, getLocaleExtendedName, getLocaleExtendedName, getName, getParentFolderTokens, hashCode, init, setBoost, setDescription, setIndex, setName

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEFAULT_STANDARD

public static final CmsLuceneFieldConfiguration 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_DESCRIPTION

public static final java.lang.String STR_STANDARD_DESCRIPTION

The description for the standard field configuration.

另请参阅:

常量字段值

构造器详细资料

CmsLuceneFieldConfiguration

public CmsLuceneFieldConfiguration()

方法详细资料

addField

public void addField(CmsSearchField field)

从类复制的说明: CmsSearchFieldConfiguration

Adds a field to this search field configuration.

覆盖:

addField 在类中 CmsSearchFieldConfiguration

参数:

field - the field to add

另请参阅:

CmsSearchFieldConfiguration.addField(org.opencms.search.fields.CmsSearchField)

getAnalyzer

public org.apache.lucene.analysis.Analyzer getAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)

Returns an analyzer that wraps the given base analyzer with the analyzers of this individual field configuration.

参数:

analyzer - the base analyzer to wrap

返回:

an analyzer that wraps the given base analyzer with the analyzers of this individual field configuration

getExcerptFieldNames

public java.util.List<java.lang.String> getExcerptFieldNames()

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

返回:

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

getExcerptFields

public java.util.Set<java.lang.String> getExcerptFields()

Returns the field names used for the excerpt generation.

返回:

the field names used for the excerpt generation

getLuceneFields

public java.util.List<CmsLuceneField> getLuceneFields()

Returns a list of the concrete Lucene search fields.

返回:

a list of lucene search fields

getReturnFields

public java.util.Set<java.lang.String> getReturnFields()

Returns the field names used for a regular result.

返回:

the field names used for a regular result