|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.search.A_CmsIndexResource
An index resource is a wrapper class that contains the data of a Cms resource specified by a Lucene search result document.
Field Summary | |
protected java.lang.Object |
m_data
Concrete data object. |
protected CmsUUID |
m_id
Id of the object. |
protected java.lang.String |
m_mimeType
Mimetype of the object, null if the object is a CmsMasterDataSet . |
protected java.lang.String |
m_name
Name of the object. |
protected java.lang.String |
m_path
Path to access the object. |
protected int |
m_type
Type of the object. |
Constructor Summary | |
A_CmsIndexResource()
|
Method Summary | |
java.lang.Object |
getData()
Returns the wrapped data object. |
abstract java.lang.String |
getDocumentKey(boolean withMimeType)
Returns the document key for the search manager. |
CmsUUID |
getId()
Returns the id of the wrapped object. |
java.lang.String |
getMimetype()
Returns the mimetype of the wrapped object. |
java.lang.String |
getName()
Returns the name of the wrapped object. |
java.lang.String |
getRootPath()
Returns the access path of the wrapped object. |
int |
getType()
Returns the type of the wrapped object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.lang.Object m_data
protected CmsUUID m_id
protected java.lang.String m_mimeType
null
if the object is a CmsMasterDataSet
.
protected java.lang.String m_name
protected java.lang.String m_path
protected int m_type
Constructor Detail |
public A_CmsIndexResource()
Method Detail |
public java.lang.Object getData()
The concrete type of the data object is either CmsResource
or CmsMasterDataSet
public abstract java.lang.String getDocumentKey(boolean withMimeType)
withMimeType
- true if the mime type should be included in the key
public CmsUUID getId()
public java.lang.String getMimetype()
null
public java.lang.String getName()
public java.lang.String getRootPath()
public int getType()
The type is either the type of the wrapped CmsResource
or the SubId of the CmsMasterDataSet
.
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |