org.opencms.search.fields

类 CmsLuceneField

java.lang.Object

org.opencms.search.fields.CmsSearchField

org.opencms.search.fields.CmsLuceneField

所有已实现的接口:

java.io.Serializable

public class CmsLuceneField
extends CmsSearchField

An individual field configuration in a Lucene search index.

从以下版本开始:

7.0.0

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	IGNORE_DISPLAY_NAME Value of m_displayName if field should not be displayed.
static java.lang.String	STR_COMPRESS Constant for the "compress" index setting.
static java.lang.String	STR_NO Constant for the "no" index setting.
static java.lang.String	STR_TOKENIZED Constant for the "tokenized" index setting.
static java.lang.String	STR_UN_TOKENIZED Constant for the "untokenized" index setting.
static java.lang.String	STR_YES Constant for the "yes" index setting.

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

BOOST_DEFAULT, FIELD_CATEGORY, FIELD_CONTENT, FIELD_CONTENT_BLOB, FIELD_CONTENT_LOCALES, FIELD_DATE_CONTENT, FIELD_DATE_CREATED, FIELD_DATE_CREATED_LOOKUP, FIELD_DATE_EXPIRED, FIELD_DATE_LASTMODIFIED, FIELD_DATE_LASTMODIFIED_LOOKUP, FIELD_DATE_LOOKUP_SUFFIX, FIELD_DATE_RELEASED, FIELD_DEPENDENCY_TYPE, FIELD_DESCRIPTION, FIELD_DYNAMIC_EXACT, FIELD_DYNAMIC_PROPERTIES, FIELD_EXCERPT, FIELD_FILENAME, FIELD_ID, FIELD_KEYWORDS, FIELD_LINK, FIELD_META, FIELD_MIMETYPE, FIELD_PARENT_FOLDERS, FIELD_PATH, FIELD_PREFIX_DEPENDENCY, FIELD_PREFIX_DYNAMIC, FIELD_PREFIX_TEXT, FIELD_PRIORITY, FIELD_RESOURCE_LOCALES, FIELD_SCORE, FIELD_SEARCH_EXCLUDE, FIELD_SIZE, FIELD_SORT_TITLE, FIELD_STATE, FIELD_SUFFIX, FIELD_TEXT, FIELD_TITLE, FIELD_TITLE_UNSTORED, FIELD_TYPE, FIELD_USER_CREATED, FIELD_USER_LAST_MODIFIED, FIELD_VERSION

构造器概要

构造器

构造器和说明
CmsLuceneField() Creates a new search field configuration.
CmsLuceneField(java.lang.String name, java.lang.String displayName, boolean isStored, boolean isIndexed) Creates a new search field configuration.
CmsLuceneField(java.lang.String name, java.lang.String displayName, boolean isStored, boolean isCompressed, boolean isIndexed, boolean isTokenized, boolean isInExcerpt, org.apache.lucene.analysis.Analyzer analyzer, float boost, java.lang.String defaultValue) Creates a new search field configuration.
CmsLuceneField(java.lang.String name, java.lang.String displayName, boolean isStored, boolean isIndexed, boolean isTokenized, boolean isInExcerpt, float boost, java.lang.String defaultValue) Creates a new search field configuration.

方法概要

方法

限定符和类型	方法和说明
void	closeAnalyzer() Closes the analyzer.
org.apache.lucene.document.Field	createField(java.lang.String content) Creates a field from the configuration and the provided content.
org.apache.lucene.document.Field	createField(java.lang.String name, java.lang.String content) Creates a field with the given name from the configuration and the provided content.
org.apache.lucene.analysis.Analyzer	getAnalyzer() Returns the analyzer used for this field.
java.lang.String	getBoostDisplay() Returns the boost factor of this field as String value for display use.
java.lang.String	getDisplayName() Returns the display name of the field.
java.lang.String	getDisplayNameForConfiguration() Returns the displayNameForConfiguration.
java.lang.String	getIndexed() Returns the String value state of this field if it is indexed (and possibly tokenized) in the Lucene index.
java.lang.String	getType() Returns the type.
boolean	isCompressed() Returns true if the content of this field is compressed.
boolean	isDisplayed() Returns true if the field should be displayed.
boolean	isInExcerptAndStored() Returns true if this fields content is used in the search result excerpt.
boolean	isTokenized() Returns true if the content of this field is tokenized in the Lucene index.
boolean	isTokenizedAndIndexed() Returns true if the content of this field is tokenized in the Lucene index.
void	setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer) Sets the analyzer used for this field.
void	setAnalyzer(java.lang.String analyzerName) Sets the analyzer used for this field.
void	setBoostDisplay(java.lang.String boost) Sets the boost factor of this field (only for display use).
void	setCompressed(boolean compressed) Controls if this field value will be stored compressed or not.
void	setDisplayed(boolean displayed) Controls if the field is displayed or not.
void	setDisplayName(java.lang.String displayName) Sets the display name.
void	setDisplayNameForConfiguration(java.lang.String displayNameForConfiguration) Sets the displayNameForConfiguration.
void	setIndexed(java.lang.String indexed) Controls if the content of this field is indexed (and possibly tokenized) in the Lucene index from a String parameter.
void	setInExcerpt(java.lang.String excerpt) Controls if this fields content is used in the search result excerpt.
void	setStored(java.lang.String stored) Controls if the content of this field is stored in the Lucene index from a String parameter.
void	setTokenized(boolean tokenized) Controls if the content of this field is tokenized in the Lucene index.
void	setType(java.lang.String type) Sets the type.

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

addMapping, equals, getBoost, getDefaultValue, getMappings, getName, hashCode, isIndexed, isInExcerpt, isStored, setBoost, setBoost, setDefaultValue, setIndexed, setInExcerpt, setName, setStored, toString

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

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

字段详细资料

IGNORE_DISPLAY_NAME

public static final java.lang.String IGNORE_DISPLAY_NAME

Value of m_displayName if field should not be displayed.

另请参阅:

常量字段值

STR_COMPRESS

public static final java.lang.String STR_COMPRESS

Constant for the "compress" index setting.

另请参阅:

常量字段值

STR_NO

public static final java.lang.String STR_NO

Constant for the "no" index setting.

另请参阅:

常量字段值

STR_TOKENIZED

public static final java.lang.String STR_TOKENIZED

Constant for the "tokenized" index setting.

另请参阅:

常量字段值

STR_UN_TOKENIZED

public static final java.lang.String STR_UN_TOKENIZED

Constant for the "untokenized" index setting.

另请参阅:

常量字段值

STR_YES

public static final java.lang.String STR_YES

Constant for the "yes" index setting.

另请参阅:

常量字段值

构造器详细资料

CmsLuceneField

public CmsLuceneField()

Creates a new search field configuration.

CmsLuceneField

public CmsLuceneField(java.lang.String name,
              java.lang.String displayName,
              boolean isStored,
              boolean isIndexed)

Creates a new search field configuration.

The field will be tokenized if it is indexed. The field will not be in the excerpt. The boost value is the default, that is no special boost is used. There is no default value.

参数:

name - the name of the field, see CmsSearchField.setName(String)

displayName - the display name of this field, see setDisplayName(String)

isStored - controls if the field is stored and in the excerpt, see CmsSearchField.setStored(boolean)

isIndexed - controls if the field is indexed and tokenized, see CmsSearchField.setIndexed(boolean)

CmsLuceneField

public CmsLuceneField(java.lang.String name,
              java.lang.String displayName,
              boolean isStored,
              boolean isCompressed,
              boolean isIndexed,
              boolean isTokenized,
              boolean isInExcerpt,
              org.apache.lucene.analysis.Analyzer analyzer,
              float boost,
              java.lang.String defaultValue)

Creates a new search field configuration.

参数:

name - the name of the field, see CmsSearchField.setName(String)

displayName - the display name of this field, see setDisplayName(String)

isStored - controls if the field is stored, see CmsSearchField.setStored(boolean)

isCompressed - controls if the filed is compressed, see setCompressed(boolean)

isIndexed - controls if the field is indexed, see CmsSearchField.setIndexed(boolean)

isTokenized - controls if the field is tokenized, see CmsSearchField.setStored(boolean)

isInExcerpt - controls if the field is in the excerpt, see isInExcerptAndStored()

analyzer - the analyzer to use, see setAnalyzer(Analyzer)

boost - the boost factor for the field, see CmsSearchField.setBoost(float)

defaultValue - the default value for the field, see CmsSearchField.setDefaultValue(String)

CmsLuceneField

public CmsLuceneField(java.lang.String name,
              java.lang.String displayName,
              boolean isStored,
              boolean isIndexed,
              boolean isTokenized,
              boolean isInExcerpt,
              float boost,
              java.lang.String defaultValue)

Creates a new search field configuration.

参数:

name - the name of the field, see CmsSearchField.setName(String)

displayName - the display name of this field, see setDisplayName(String)

isStored - controls if the field is stored, see CmsSearchField.setStored(boolean)

isIndexed - controls if the field is indexed, see CmsSearchField.setIndexed(boolean)

isTokenized - controls if the field is tokenized, see CmsSearchField.setStored(boolean)

isInExcerpt - controls if the field is in the excerpt, see isInExcerptAndStored()

boost - the boost factor for the field, see CmsSearchField.setBoost(float)

defaultValue - the default value for the field, see CmsSearchField.setDefaultValue(String)

方法详细资料

createField

public org.apache.lucene.document.Field createField(java.lang.String content)

Creates a field from the configuration and the provided content.

The configured name of the field as provided by CmsSearchField.getName() is used.

If no valid content is provided (that is the content is either null or only whitespace), then no field is created and null is returned.

参数:

content - the content to create the field with

返回:

a field created from the configuration and the provided content

createField

public org.apache.lucene.document.Field createField(java.lang.String name,
                                           java.lang.String content)

Creates a field with the given name from the configuration and the provided content.

If no valid content is provided (that is the content is either null or only whitespace), then no field is created and null is returned.

参数:

name - the name of the field to create

content - the content to create the field with

返回:

a field with the given name from the configuration and the provided content

getAnalyzer

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

Returns the analyzer used for this field.

返回:

the analyzer used for this field

getBoostDisplay

public java.lang.String getBoostDisplay()

Returns the boost factor of this field as String value for display use.

返回:

the boost factor of this field as String value for display use

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of the field.

返回:

the display name of the field

getDisplayNameForConfiguration

public java.lang.String getDisplayNameForConfiguration()

Returns the displayNameForConfiguration.

返回:

the displayNameForConfiguration

getIndexed

public java.lang.String getIndexed()

Returns the String value state of this field if it is indexed (and possibly tokenized) in the Lucene index.

覆盖:

getIndexed 在类中 CmsSearchField

返回:

the String value state of this field if it is indexed (and possibly tokenized) in the Lucene index

另请参阅:

isTokenizedAndIndexed(), CmsSearchField.isIndexed()

getType

public java.lang.String getType()

Returns the type.

返回:

the type

isCompressed

public boolean isCompressed()

Returns true if the content of this field is compressed.

If the field is compressed, it must also be stored, this means CmsSearchField.isStored() will always return true for compressed fields.

返回:

true if the content of this field is compressed

isDisplayed

public boolean isDisplayed()

Returns true if the field should be displayed.

返回:

returns true if the field should be displayed otherwise false

isInExcerptAndStored

public boolean isInExcerptAndStored()

Returns true if this fields content is used in the search result excerpt.

A field can only be used in the excerpt if it is stored, see CmsSearchField.isStored().

返回:

true if this fields content is used in the search result excerpt

另请参阅:

CmsSearchField.isStored()

isTokenized

public boolean isTokenized()

Returns true if the content of this field is tokenized in the Lucene index.

Please refer to the Lucene documentation about the concept behind tokenized and untokenized fields.

返回:

true if the content of this field is tokenized in the Lucene index

isTokenizedAndIndexed

public boolean isTokenizedAndIndexed()

Returns true if the content of this field is tokenized in the Lucene index.

A field can only be tokenized if it is also indexed, see CmsSearchField.isIndexed().

Please refer to the Lucene documentation about the concept behind tokenized and untokenized fields.

返回:

true if the content of this field is tokenized in the Lucene index

另请参阅:

CmsSearchField.isStored(), CmsSearchField.isIndexed()

closeAnalyzer

public void closeAnalyzer()

Closes the analyzer.

setAnalyzer

public void setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)

Sets the analyzer used for this field.

参数:

analyzer - the analyzer to set

setAnalyzer

public void setAnalyzer(java.lang.String analyzerName)
                 throws java.lang.Exception

Sets the analyzer used for this field.

The parameter must be a name of a class the implements the Lucene Analyzer interface.

参数:

analyzerName - the analyzer class name to set

抛出:

java.lang.Exception - in case of problems creating the analyzer class instance

setBoostDisplay

public void setBoostDisplay(java.lang.String boost)

Sets the boost factor of this field (only for display use).

参数:

boost - the boost factor to set

另请参阅:

CmsSearchField.setBoost(String)

setCompressed

public void setCompressed(boolean compressed)

Controls if this field value will be stored compressed or not.

If this is set to true, the value for CmsSearchField.isStored() will also be set to true, since compressed fields are always stored.

参数:

compressed - if true, the field value will be stored compressed

setDisplayed

public void setDisplayed(boolean displayed)

Controls if the field is displayed or not.

参数:

displayed - if true the field is displayed

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name. If the given name equals IGNORE_DISPLAY_NAME the field is not displayed.

参数:

displayName - the display name to set

setDisplayNameForConfiguration

public void setDisplayNameForConfiguration(java.lang.String displayNameForConfiguration)

Sets the displayNameForConfiguration.

参数:

displayNameForConfiguration - the displayNameForConfiguration to set

setIndexed

public void setIndexed(java.lang.String indexed)

Controls if the content of this field is indexed (and possibly tokenized) in the Lucene index from a String parameter.

This sets the values for CmsSearchField.isIndexed() as well as isTokenizedAndIndexed().

The parameter can have the following values:

• "true" or "tokenized": The field is indexed and tokenized.
• "false" or "no": The field is not indexed and not tokenized.
• "untokenized": The field is indexed but not tokenized.

参数:

indexed - the index setting to use

另请参阅:

CmsSearchField.setIndexed(boolean), setTokenized(boolean)

setInExcerpt

public void setInExcerpt(java.lang.String excerpt)

Controls if this fields content is used in the search result excerpt.

参数:

excerpt - if "true", then this fields content is used in the search excerpt

另请参阅:

CmsSearchField.setInExcerpt(boolean)

setStored

public void setStored(java.lang.String stored)

Controls if the content of this field is stored in the Lucene index from a String parameter.

参数:

stored - if "true", then the field content is stored

另请参阅:

CmsSearchField.setStored(boolean)

setTokenized

public void setTokenized(boolean tokenized)

Controls if the content of this field is tokenized in the Lucene index.

Please refer to the Lucene documentation about the concept behind tokenized and untokenized fields.

参数:

tokenized - if true, then the field content is tokenized

另请参阅:

CmsSearchField.setStored(boolean)

setType

public void setType(java.lang.String type)

Sets the type.

参数:

type - the type to set