org.opencms.search

类 CmsSearchResource

java.lang.Object

org.opencms.file.CmsResource

org.opencms.search.CmsSearchResource

public class CmsSearchResource
extends CmsResource

A resource implementation that combines the Solr document together with a OpenCms VFS resource.

从以下版本开始:

8.5.0

字段概要

从类继承的字段 org.opencms.file.CmsResource

STATE_CHANGED, STATE_DELETED, STATE_KEEP, STATE_NEW, STATE_UNCHANGED, TEMP_FILE_PREFIX

构造器概要

构造器

构造器和说明
CmsSearchResource(CmsResource resource, I_CmsSearchDocument doc) Constructor, creates a new file Object from the given resource with an empty byte array as file content, if the resource does not implement a file.
CmsSearchResource(CmsUUID structureId, CmsUUID resourceId, java.lang.String path, int type, int flags, CmsUUID projectId, CmsResourceState state, long dateCreated, CmsUUID userCreated, long dateLastModified, CmsUUID userLastModified, long dateReleased, long dateExpired, int linkCount, int length, long dateContent, int version, I_CmsSearchDocument doc) Constructor, creates a new file object.

方法概要

方法

限定符和类型	方法和说明
java.util.Date	getDateField(java.lang.String fieldName) Delegator.
I_CmsSearchDocument	getDocument() Returns the document.
java.lang.String	getField(java.lang.String fieldName) Delegator.
java.util.List<java.lang.String>	getMultivaluedField(java.lang.String fieldName) Delegator.
int	getScore(float maxScore) Delegator.

从类继承的方法 org.opencms.file.CmsResource

getFolderPath, getName, getParentFolder, getPathLevel, getPathPart, isFolder, isTemporaryFileName

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

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

构造器详细资料

CmsSearchResource

public CmsSearchResource(CmsResource resource,
                 I_CmsSearchDocument doc)

Constructor, creates a new file Object from the given resource with an empty byte array as file content, if the resource does not implement a file.

参数:

resource - the base resource object to create a file from

doc - the search document

CmsSearchResource

public CmsSearchResource(CmsUUID structureId,
                 CmsUUID resourceId,
                 java.lang.String path,
                 int type,
                 int flags,
                 CmsUUID projectId,
                 CmsResourceState state,
                 long dateCreated,
                 CmsUUID userCreated,
                 long dateLastModified,
                 CmsUUID userLastModified,
                 long dateReleased,
                 long dateExpired,
                 int linkCount,
                 int length,
                 long dateContent,
                 int version,
                 I_CmsSearchDocument doc)

Constructor, creates a new file object.

参数:

structureId - the id of this resources structure record

resourceId - the id of this resources resource record

path - the filename of this resource

type - the type of this resource

flags - the flags of this resource

projectId - the project id this resource was last modified in

state - the state of this resource

dateCreated - the creation date of this resource

userCreated - the id of the user who created this resource

dateLastModified - the date of the last modification of this resource

userLastModified - the id of the user who did the last modification of this resource

dateReleased - the release date of this resource

dateExpired - the expiration date of this resource

linkCount - the count of all siblings of this resource

length - the size of the file content of this resource

dateContent - the date of the last modification of the content of this resource

version - the version number of this resource

doc - the search document

方法详细资料

getDateField

public java.util.Date getDateField(java.lang.String fieldName)

Delegator.

I_CmsSearchDocument.getFieldValueAsDate(String)

参数:

fieldName - the field name to get the value for

返回:

the value

getDocument

public I_CmsSearchDocument getDocument()

Returns the document.

返回:

the document

getField

public java.lang.String getField(java.lang.String fieldName)

Delegator.

I_CmsSearchDocument.getFieldValueAsString(String)

参数:

fieldName - the field name to get the value for

返回:

the value

getMultivaluedField

public java.util.List<java.lang.String> getMultivaluedField(java.lang.String fieldName)

Delegator.

I_CmsSearchDocument.getFieldValueAsString(String)

参数:

fieldName - the field name to get the value for

返回:

the value

getScore

public int getScore(float maxScore)

Delegator.

I_CmsSearchDocument.getScore() Returns the score of this document.

参数:

maxScore - the maximum score of this search

返回:

the score