org.opencms.search.galleries

类 CmsGallerySearchFieldMapping

java.lang.Object

org.opencms.search.fields.CmsSearchFieldMapping

org.opencms.search.galleries.CmsGallerySearchFieldMapping

所有已实现的接口:

java.io.Serializable, I_CmsSearchFieldMapping

public class CmsGallerySearchFieldMapping
extends CmsSearchFieldMapping

Special search field mapping class for the gallery search.

从以下版本开始:

8.0.0

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	FIELD_ADDITIONAL_INFO Name of the field that contains the gallery index additional information.
static java.lang.String	FIELD_CONTAINER_TYPES Name of the field that contains the gallery index container information.
static java.lang.String	FIELD_RESOURCE_DATE_EXPIRED Name of the field that contains the date the resource has expired.
static java.lang.String	FIELD_RESOURCE_DATE_RELEASED Name of the field that contains the date the resource was released.
static java.lang.String	FIELD_RESOURCE_LENGTH Name of the field that contains the resource length.
static java.lang.String	FIELD_RESOURCE_STATE Name of the field that contains the resource state.
static java.lang.String	FIELD_RESOURCE_STRUCTURE_ID Name of the field that contains the structure id the resource.
static java.lang.String	FIELD_RESOURCE_USER_CREATED Name of the field that contains the name of the user who created the resource.
static java.lang.String	FIELD_RESOURCE_USER_LASTMODIFIED Name of the field that contains the name of the user who last modified the resource.

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
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.

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

equals, getDefaultDateExpired, getDefaultValue, getParam, getType, hashCode, setDefaultValue, setParam, setType, setType

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

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

字段详细资料

FIELD_ADDITIONAL_INFO

public static final java.lang.String FIELD_ADDITIONAL_INFO

Name of the field that contains the gallery index additional information.

另请参阅:

常量字段值

FIELD_CONTAINER_TYPES

public static final java.lang.String FIELD_CONTAINER_TYPES

Name of the field that contains the gallery index container information.

另请参阅:

常量字段值

FIELD_RESOURCE_DATE_EXPIRED

public static final java.lang.String FIELD_RESOURCE_DATE_EXPIRED

Name of the field that contains the date the resource has expired.

另请参阅:

常量字段值

FIELD_RESOURCE_DATE_RELEASED

public static final java.lang.String FIELD_RESOURCE_DATE_RELEASED

Name of the field that contains the date the resource was released.

另请参阅:

常量字段值

FIELD_RESOURCE_LENGTH

public static final java.lang.String FIELD_RESOURCE_LENGTH

Name of the field that contains the resource length.

另请参阅:

常量字段值

FIELD_RESOURCE_STATE

public static final java.lang.String FIELD_RESOURCE_STATE

Name of the field that contains the resource state.

另请参阅:

常量字段值

FIELD_RESOURCE_STRUCTURE_ID

public static final java.lang.String FIELD_RESOURCE_STRUCTURE_ID

Name of the field that contains the structure id the resource.

另请参阅:

常量字段值

FIELD_RESOURCE_USER_CREATED

public static final java.lang.String FIELD_RESOURCE_USER_CREATED

Name of the field that contains the name of the user who created the resource.

另请参阅:

常量字段值

FIELD_RESOURCE_USER_LASTMODIFIED

public static final java.lang.String FIELD_RESOURCE_USER_LASTMODIFIED

Name of the field that contains the name of the user who last modified the resource.

另请参阅:

常量字段值

构造器详细资料

CmsGallerySearchFieldMapping

public CmsGallerySearchFieldMapping()

Public constructor for a new search field mapping.

CmsGallerySearchFieldMapping

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

Public constructor for a new search field mapping.

参数:

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

param - the mapping parameter, see CmsSearchFieldMapping.setParam(String)

方法详细资料

getStringValue

public 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.

指定者:

getStringValue 在接口中 I_CmsSearchFieldMapping

覆盖:

getStringValue 在类中 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)