org.opencms.search
Class CmsVfsIndexResource

java.lang.Object
  extended byorg.opencms.search.A_CmsIndexResource
      extended byorg.opencms.search.CmsVfsIndexResource

public class CmsVfsIndexResource
extends A_CmsIndexResource

Contains the data of a VFS Cms resource specified by a Lucene search result document.

Since:
6.0.0
Version:
$Revision: 1.20 $
Author:
Carsten Weinholz, Thomas Weckert

Field Summary
 
Fields inherited from class org.opencms.search.A_CmsIndexResource
m_data, m_id, m_mimeType, m_name, m_path, m_type
 
Constructor Summary
CmsVfsIndexResource(CmsResource res)
          Creates a new instance to wrap the given CmsResource.
 
Method Summary
 java.lang.String getDocumentKey(boolean withMimeType)
          Returns the document key for the search manager.
 
Methods inherited from class org.opencms.search.A_CmsIndexResource
getData, getId, getMimetype, getName, getRootPath, getType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsVfsIndexResource

public CmsVfsIndexResource(CmsResource res)
Creates a new instance to wrap the given CmsResource.

Parameters:
res - the data object
Method Detail

getDocumentKey

public java.lang.String getDocumentKey(boolean withMimeType)
Description copied from class: A_CmsIndexResource
Returns the document key for the search manager.

Specified by:
getDocumentKey in class A_CmsIndexResource
Parameters:
withMimeType - true if the mime type should be included in the key
Returns:
the document key for the search manager
See Also:
A_CmsIndexResource.getDocumentKey(boolean)