| org.opencms.search.documents.I_CmsDocumentFactory
All known Subclasses: org.opencms.search.documents.A_CmsVfsDocument,
| I_CmsDocumentFactory | | public interface I_CmsDocumentFactory extends I_CmsSearchExtractor(Code) | | Used to create index Lucene Documents for OpenCms resources,
controls the text extraction algorithm used for a specific OpenCms resource type / MIME type combination.
The configuration of the search index is defined in opencms-search.xml.
There you can associate a combintion of OpenCms resource types and MIME types to an instance
of this factory. This rather complex configuration is required because only the combination of
OpenCms resource type and MIME type can decide what to use for search indexing.
For example, if the OpenCms resource type is plain,
the extraction algorithm for MIME types .html and .txt must be different.
On the other hand, the MIME type .html in OpenCms can be almost any resource type,
like xmlpage, xmlcontent or even jsp.
author:
Carsten Weinholz
author:
Thomas Weckert
author:
Alexander Kandzior
version:
$Revision: 1.27 $
since:
6.0.0 |
| createDocument | | Document createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index) throws CmsException(Code) | | Creates the Lucene Document for the given index resource and the given search index.
This triggers the indexing process for the given index resource accoring to the configuration
of the provided index.
The provided index resource contains the basic contents to index.
The provided search index contains the configuration what to index, such as the locale and
possible special field mappings.
Parameters:
cms - the cms object used to access the OpenCms VFS
Parameters:
resource - the search index resource to create the Lucene document from
Parameters:
index - the search index to create the Document for the Lucene Document for the given index resource and the given search index
throws:
CmsException - if something goes wrong |
| getCache | | CmsExtractionResultCache getCache()(Code) | | Returns the disk based cache used to store the raw extraction results.
In case null is returned, then result caching is not supported for this factory.
the disk based cache used to store the raw extraction results |
| getDocumentKeys | | List getDocumentKeys(List resourceTypes, List mimeTypes) throws CmsException(Code) | | Returns the list of accepted keys for the resource types that can be indexed using this document factory.
The result List contains String objects.
This String is later matched against
A_CmsVfsDocument.getDocumentKey(StringString) to find
the corrospondig
I_CmsDocumentFactory for a resource to index.
The list of accepted resource types may contain a catch-all entry "*";
in this case, a list for all possible resource types is returned,
calculated by a logic depending on the document handler class.
Parameters:
resourceTypes - list of accepted resource types
Parameters:
mimeTypes - list of accepted mime types the list of accepted keys for the resource types that can be indexed using this document factory (String objects)
throws:
CmsException - if something goes wrong |
| getName | | String getName()(Code) | | Returns the name of this document type factory.
the name of this document type factory |
| isLocaleDependend | | boolean isLocaleDependend()(Code) | | Returns true if this document factory is locale depended.
true if this document factory is locale depended |
| isUsingCache | | boolean isUsingCache()(Code) | | Returns true if result caching is supported for this factory.
true if result caching is supported for this factory |
|
|