org.opencms.search.documents

类 A_CmsVfsDocument

java.lang.Object

org.opencms.search.documents.A_CmsVfsDocument

所有已实现的接口:

I_CmsDocumentFactory, I_CmsSearchExtractor

直接已知子类:

CmsDocumentContainerPage, CmsDocumentGeneric, CmsDocumentHtml, CmsDocumentMsOfficeOLE2, CmsDocumentMsOfficeOOXML, CmsDocumentOpenOffice, CmsDocumentPdf, CmsDocumentPlainText, CmsDocumentRtf, CmsDocumentXmlContent, CmsDocumentXmlPage

public abstract class A_CmsVfsDocument
extends java.lang.Object
implements I_CmsDocumentFactory

Base document factory class for a VFS CmsResource, just requires a specialized implementation of I_CmsSearchExtractor.extractContent(CmsObject, CmsResource, CmsSearchIndex) for text extraction from the binary document content.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	m_name Name of the document type.

构造器概要

构造器

构造器和说明
A_CmsVfsDocument(java.lang.String name) Creates a new instance of this lucene document factory.

方法概要

方法

限定符和类型	方法和说明
I_CmsSearchDocument	createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index) Generates a new lucene document instance from contents of the given resource for the provided index.
CmsExtractionResultCache	getCache() Returns the disk based cache used to store the raw extraction results.
static java.lang.String	getDocumentKey(java.lang.String type, java.lang.String mimeType) Creates a document factory lookup key for the given resource type name / MIME type configuration.
java.util.List<java.lang.String>	getDocumentKeys(java.util.List<java.lang.String> resourceTypes, java.util.List<java.lang.String> mimeTypes) Returns the list of accepted keys for the resource types that can be indexed using this document factory.
java.lang.String	getName() Returns the name of this document type factory.
protected void	logContentExtraction(CmsResource resource, CmsSearchIndex index) Logs content extraction for the specified resource and index.
protected CmsFile	readFile(CmsObject cms, CmsResource resource) Upgrades the given resource to a CmsFile with content.
void	setCache(CmsExtractionResultCache cache) Sets the disk based cache used to store the raw extraction results.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.opencms.search.documents.I_CmsDocumentFactory

isLocaleDependend, isUsingCache

从接口继承的方法 org.opencms.search.documents.I_CmsSearchExtractor

extractContent

字段详细资料

m_name

protected java.lang.String m_name

Name of the document type.

构造器详细资料

A_CmsVfsDocument

public A_CmsVfsDocument(java.lang.String name)

Creates a new instance of this lucene document factory.

参数:

name - name of the documenttype

方法详细资料

getDocumentKey

public static java.lang.String getDocumentKey(java.lang.String type,
                              java.lang.String mimeType)

Creates a document factory lookup key for the given resource type name / MIME type configuration.

If the given mimeType is null, this indicates that the key should match all VFS resource of the given resource type regardless of the MIME type.

参数:

type - the resource type name to use

mimeType - the MIME type to use

返回:

a document factory lookup key for the given resource id / MIME type configuration

createDocument

public I_CmsSearchDocument createDocument(CmsObject cms,
                                 CmsResource resource,
                                 CmsSearchIndex index)
                                   throws CmsException

Generates a new lucene document instance from contents of the given resource for the provided index.

指定者:

createDocument 在接口中 I_CmsDocumentFactory

参数:

cms - the OpenCms user context used to access the OpenCms VFS

resource - the search index resource to create the Lucene document from

index - the search index to create the Document for

返回:

the Search Document for the given index resource and the given search index

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsDocumentFactory.createDocument(CmsObject, CmsResource, CmsSearchIndex)

getCache

public CmsExtractionResultCache getCache()

从接口复制的说明: I_CmsDocumentFactory

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.

指定者:

getCache 在接口中 I_CmsDocumentFactory

返回:

the disk based cache used to store the raw extraction results

另请参阅:

I_CmsDocumentFactory.getCache()

getDocumentKeys

public java.util.List<java.lang.String> getDocumentKeys(java.util.List<java.lang.String> resourceTypes,
                                               java.util.List<java.lang.String> mimeTypes)
                                                 throws CmsException

从接口复制的说明: I_CmsDocumentFactory

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 getDocumentKey(String, String) 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.

指定者:

getDocumentKeys 在接口中 I_CmsDocumentFactory

参数:

resourceTypes - list of accepted resource types

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)

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsDocumentFactory.getDocumentKeys(java.util.List, java.util.List)

getName

public java.lang.String getName()

从接口复制的说明: I_CmsDocumentFactory

Returns the name of this document type factory.

指定者:

getName 在接口中 I_CmsDocumentFactory

返回:

the name of this document type factory

另请参阅:

I_CmsDocumentFactory.getName()

setCache

public void setCache(CmsExtractionResultCache cache)

从接口复制的说明: I_CmsDocumentFactory

Sets the disk based cache used to store the raw extraction results.

This should only be used for factories where I_CmsDocumentFactory.isUsingCache() returns true.

指定者:

setCache 在接口中 I_CmsDocumentFactory

参数:

cache - the disk based cache used to store the raw extraction results

另请参阅:

I_CmsDocumentFactory.setCache(org.opencms.search.documents.CmsExtractionResultCache)

logContentExtraction

protected void logContentExtraction(CmsResource resource,
                        CmsSearchIndex index)

Logs content extraction for the specified resource and index.

参数:

resource - the resource to log content extraction for

index - the search index to log content extraction for

readFile

protected CmsFile readFile(CmsObject cms,
               CmsResource resource)
                    throws CmsException,
                           CmsIndexNoContentException

Upgrades the given resource to a CmsFile with content.

参数:

cms - the current users OpenCms context

resource - the resource to upgrade

返回:

the given resource upgraded to a CmsFile with content

抛出:

CmsException - if the resource could not be read

CmsIndexNoContentException - if the resource has no content