|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
All implementations of OpenCMS Document-building classes must implement this interface.
This interface provides a framework for building Documents in a way that they can be used within OpenCMS. Documents are used by the Lucene search engine to build intelligent representations of data. Documents vary from source to source (e.g. there is a different Document representation for a Page than for a JSP), and extensions to the core document types for OpenCMS might require a new Document factory.
Make sure your implementation is thread safe. No attempt is made to synchronized hits to the Document method. ALSO, the Document methods may be called any number of times on one instance of the object.
Method Summary | |
Document |
Document(CmsObject cmso,
CmsFile f)
Takes a CmsFile instance and builds a Lucene Document suitable for index generation. |
Document |
Document(CmsObject cmso,
CmsFile f,
java.util.HashMap params)
Takes a CmsFile instance and builds a Lucene Document suitable for index generation. |
Method Detail |
public Document Document(CmsObject cmso, CmsFile f) throws CmsException
CmsException
- it cannot work with the CmsFile or CmsObject.public Document Document(CmsObject cmso, CmsFile f, java.util.HashMap params) throws CmsException
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 |