Package org.opencms.search
Class CmsSearchResource
- java.lang.Object
-
- org.opencms.file.CmsResource
-
- org.opencms.search.CmsSearchResource
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.lang.Comparable<I_CmsResource>
,I_CmsResource
public class CmsSearchResource extends CmsResource
A resource implementation that combines the Solr document together with a OpenCms VFS resource.- Since:
- 8.5.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.opencms.file.CmsResource
CmsResource.CmsResourceCopyMode, CmsResource.CmsResourceDeleteMode, CmsResource.CmsResourceUndoMode
-
Nested classes/interfaces inherited from interface org.opencms.file.I_CmsResource
I_CmsResource.CmsResourceAttribute
-
-
Field Summary
-
Fields inherited from class org.opencms.file.CmsResource
COPY_AS_NEW, COPY_AS_SIBLING, COPY_PRESERVE_SIBLING, DATE_EXPIRED_DEFAULT, DATE_RELEASED_DEFAULT, DATE_RELEASED_EXPIRED_IGNORE, DELETE_PRESERVE_SIBLINGS, DELETE_REMOVE_SIBLINGS, FLAG_INTERNAL, FLAG_LABELED, FLAG_TEMPFILE, m_dateContent, m_length, NAME_CONSTRAINTS, STATE_CHANGED, STATE_DELETED, STATE_KEEP, STATE_NEW, STATE_UNCHANGED, TEMP_FILE_PREFIX, TOUCH_DATE_UNCHANGED, UNDO_CONTENT, UNDO_CONTENT_RECURSIVE, UNDO_MOVE_CONTENT, UNDO_MOVE_CONTENT_RECURSIVE, VFS_FOLDER_SITES, VFS_FOLDER_SYSTEM
-
Fields inherited from interface org.opencms.file.I_CmsResource
COMPARE_DATE_LAST_MODIFIED, COMPARE_DATE_RELEASED, COMPARE_ROOT_PATH, COMPARE_ROOT_PATH_IGNORE_CASE, COMPARE_ROOT_PATH_IGNORE_CASE_FOLDERS_FIRST
-
-
Constructor Summary
Constructors Constructor Description 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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.-
Methods inherited from class org.opencms.file.CmsResource
checkResourceName, clone, compareTo, equals, getCopy, getDateContent, getDateCreated, getDateExpired, getDateLastModified, getDateReleased, getExtension, getFlags, getFolderPath, getLength, getName, getName, getParentFolder, getPathLevel, getPathPart, getProjectLastModified, getResourceId, getRootPath, getSiblingCount, getState, getStructureId, getTypeId, getUserCreated, getUserLastModified, getVersion, hashCode, isExpired, isFile, isFolder, isFolder, isInternal, isInternalOrInInternalFolder, isLabeled, isReleased, isReleasedAndNotExpired, isTemporaryFile, isTemporaryFileName, isTouched, setDateExpired, setDateLastModified, setDateReleased, setFlags, setInternal, setState, setType, setUserLastModified, toString
-
-
-
-
Constructor Detail
-
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.- Parameters:
resource
- the base resource object to create a file fromdoc
- 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.- Parameters:
structureId
- the id of this resources structure recordresourceId
- the id of this resources resource recordpath
- the filename of this resourcetype
- the type of this resourceflags
- the flags of this resourceprojectId
- the project id this resource was last modified instate
- the state of this resourcedateCreated
- the creation date of this resourceuserCreated
- the id of the user who created this resourcedateLastModified
- the date of the last modification of this resourceuserLastModified
- the id of the user who did the last modification of this resourcedateReleased
- the release date of this resourcedateExpired
- the expiration date of this resourcelinkCount
- the count of all siblings of this resourcelength
- the size of the file content of this resourcedateContent
- the date of the last modification of the content of this resourceversion
- the version number of this resourcedoc
- the search document
-
-
Method Detail
-
getDateField
public java.util.Date getDateField(java.lang.String fieldName)
- Parameters:
fieldName
- the field name to get the value for- Returns:
- the value
-
getDocument
public I_CmsSearchDocument getDocument()
Returns the document.- Returns:
- the document
-
getField
public java.lang.String getField(java.lang.String fieldName)
- Parameters:
fieldName
- the field name to get the value for- Returns:
- the value
-
getMultivaluedField
public java.util.List<java.lang.String> getMultivaluedField(java.lang.String fieldName)
- Parameters:
fieldName
- the field name to get the value for- Returns:
- the value
-
getScore
public int getScore(float maxScore)
Delegator.I_CmsSearchDocument.getScore()
Returns the score of this document.- Parameters:
maxScore
- the maximum score of this search- Returns:
- the score
-
-