org.opencms.search.fields

类 CmsSearchFieldMapping

java.lang.Object

org.opencms.search.fields.CmsSearchFieldMapping

所有已实现的接口:

java.io.Serializable, I_CmsSearchFieldMapping

直接已知子类:

CmsGallerySearchFieldMapping

public class CmsSearchFieldMapping
extends java.lang.Object
implements I_CmsSearchFieldMapping

Describes a mapping of a piece of content from an OpenCms VFS resource to a field of a search index.

从以下版本开始:

7.0.0

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
CmsSearchFieldMapping() Public constructor for a new search field mapping.
CmsSearchFieldMapping(CmsSearchFieldMappingType type, java.lang.String param) Public constructor for a new search field mapping.

方法概要

方法

限定符和类型	方法和说明
boolean	equals(java.lang.Object obj) Two mappings are equal if the type and the parameter is equal.
static java.util.Date	getDefaultDateExpired() Returns the default expiration date, meaning the resource never expires.
java.lang.String	getDefaultValue() Returns the default value used for this field mapping in case no content is available.
java.lang.String	getParam() Returns the mapping parameter.
java.lang.String	getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Returns the String value extracted form the provided data according to the rules of this mapping type.
CmsSearchFieldMappingType	getType() Returns the mapping type.
int	hashCode() The hash code depends on the type and the parameter.
void	setDefaultValue(java.lang.String defaultValue) Sets the default value for this field mapping in case no content is available.
void	setParam(java.lang.String param) Sets the mapping parameter.
void	setType(CmsSearchFieldMappingType type) Sets the mapping type.
void	setType(java.lang.String type) Sets the mapping type as a String.

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

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

构造器详细资料

CmsSearchFieldMapping

public CmsSearchFieldMapping()

Public constructor for a new search field mapping.

CmsSearchFieldMapping

public CmsSearchFieldMapping(CmsSearchFieldMappingType type,
                     java.lang.String param)

Public constructor for a new search field mapping.

参数:

type - the type to use, see setType(CmsSearchFieldMappingType)

param - the mapping parameter, see setParam(String)

方法详细资料

getDefaultDateExpired

public static java.util.Date getDefaultDateExpired()
                                            throws java.text.ParseException

Returns the default expiration date, meaning the resource never expires.

返回:

the default expiration date

抛出:

java.text.ParseException - if something goes wrong parsing the default date string

equals

public boolean equals(java.lang.Object obj)

Two mappings are equal if the type and the parameter is equal.

覆盖:

equals 在类中 java.lang.Object

另请参阅:

Object.equals(java.lang.Object)

getDefaultValue

public java.lang.String getDefaultValue()

从接口复制的说明: I_CmsSearchFieldMapping

Returns the default value used for this field mapping in case no content is available.

指定者:

getDefaultValue 在接口中 I_CmsSearchFieldMapping

返回:

the default value used for this field mapping in case no content is available

另请参阅:

I_CmsSearchFieldMapping.getDefaultValue()

getParam

public java.lang.String getParam()

从接口复制的说明: I_CmsSearchFieldMapping

Returns the mapping parameter.

The parameter is used depending on the implementation of the rules of the selected CmsSearchFieldMappingType.

指定者:

getParam 在接口中 I_CmsSearchFieldMapping

返回:

the mapping parameter

另请参阅:

I_CmsSearchFieldMapping.getParam()

getStringValue

public java.lang.String getStringValue(CmsObject cms,
                              CmsResource res,
                              I_CmsExtractionResult extractionResult,
                              java.util.List<CmsProperty> properties,
                              java.util.List<CmsProperty> propertiesSearched)

从接口复制的说明: I_CmsSearchFieldMapping

Returns the String value extracted form the provided data according to the rules of this mapping type.

指定者:

getStringValue 在接口中 I_CmsSearchFieldMapping

参数:

cms - the OpenCms context used for building the search index

res - the resource that is indexed

extractionResult - the plain text extraction result from the resource

properties - the list of all properties directly attached to the resource (not searched)

propertiesSearched - the list of all searched properties of the resource

返回:

the String value extracted form the provided data according to the rules of this mapping type

另请参阅:

I_CmsSearchFieldMapping.getStringValue(org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.extractors.I_CmsExtractionResult, java.util.List, java.util.List)

getType

public CmsSearchFieldMappingType getType()

从接口复制的说明: I_CmsSearchFieldMapping

Returns the mapping type.

指定者:

getType 在接口中 I_CmsSearchFieldMapping

返回:

the mapping type

另请参阅:

I_CmsSearchFieldMapping.getType()

hashCode

public int hashCode()

The hash code depends on the type and the parameter.

覆盖:

hashCode 在类中 java.lang.Object

另请参阅:

Object.hashCode()

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

从接口复制的说明: I_CmsSearchFieldMapping

Sets the default value for this field mapping in case no content is available.

指定者:

setDefaultValue 在接口中 I_CmsSearchFieldMapping

参数:

defaultValue - the default value to set

另请参阅:

I_CmsSearchFieldMapping.setDefaultValue(java.lang.String)

setParam

public void setParam(java.lang.String param)

从接口复制的说明: I_CmsSearchFieldMapping

Sets the mapping parameter.

The parameter is used depending on the implementation of the rules of the selected CmsSearchFieldMappingType.

指定者:

setParam 在接口中 I_CmsSearchFieldMapping

参数:

param - the parameter to set

另请参阅:

I_CmsSearchFieldMapping.setParam(java.lang.String)

setType

public void setType(CmsSearchFieldMappingType type)

从接口复制的说明: I_CmsSearchFieldMapping

Sets the mapping type.

指定者:

setType 在接口中 I_CmsSearchFieldMapping

参数:

type - the type to set

另请参阅:

I_CmsSearchFieldMapping.setType(org.opencms.search.fields.CmsSearchFieldMappingType)

setType

public void setType(java.lang.String type)

从接口复制的说明: I_CmsSearchFieldMapping

Sets the mapping type as a String.

指定者:

setType 在接口中 I_CmsSearchFieldMapping

参数:

type - the name of the type to set

另请参阅:

I_CmsSearchFieldMapping.setType(java.lang.String)