|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--net.grcomputing.opencms.search.lucene.BodylessDocument
This class serves as a document factory for OpenCMS resources. It produces Lucene Document objects that contain the correct fields for indexing OpenCMS resources. Unlike some of the other Lucene implementations, this one is highly coupled with the OpenCMS API - thereby taking advantage of properties security settings, etc.
Essentially, the main purpose of this method is to provide factories for Document instances that are specific to the types of resources in OpenCMS. For instance, we know that a Page will have a name, a title, and probably description and keywords. We also know that it is an XML document with HTML stored in the CDATA section. These bits of information provide information that we can use to generate an appropriate Document representation.
Field Summary |
Fields inherited from interface net.grcomputing.opencms.search.lucene.I_DocumentConstants |
FIELD_BODY, FIELD_DESC, FIELD_INITIAL_ADD, FIELD_KEYWORDS, FIELD_LAST_MOD, FIELD_PATH, FIELD_TITLE |
Constructor Summary | |
BodylessDocument()
|
Method Summary | |
Document |
Document(CmsObject cmso,
CmsFile f)
Takes an instance of some type and builds a Lucene Document suitable for index generation. |
Document |
Document(CmsObject cmso,
CmsFile f,
java.util.HashMap h)
Takes an instance of some type and builds a Lucene Document suitable for index generation. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BodylessDocument()
Method Detail |
public Document Document(CmsObject cmso, CmsFile f) throws CmsException
Document
in interface I_DocumentFactory
CmsException
- it cannot work with the CmsFile or CmsObject.public Document Document(CmsObject cmso, CmsFile f, java.util.HashMap h) throws CmsException
Document
in interface I_DocumentFactory
CmsException
- it cannot work with the CmsFile or CmsObject.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |