org.opencms.search.documents

类 CmsDocumentGeneric

java.lang.Object

org.opencms.search.documents.A_CmsVfsDocument

org.opencms.search.documents.CmsDocumentGeneric

所有已实现的接口:

I_CmsDocumentFactory, I_CmsSearchExtractor

public class CmsDocumentGeneric
extends A_CmsVfsDocument

Lucene document factory class for indexing data from a generic CmsResource.

Since the document type is generic, no content extraction is performed for the resource. However, meta data from the properties and attributes of the resource are indexed.

The class is useful for example to have images appear in the search result if the title of the image matched the search query. It's also used if no specific extraction method is available for a binary document type.

从以下版本开始:

6.0.0

字段概要

从类继承的字段 org.opencms.search.documents.A_CmsVfsDocument

m_name

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
I_CmsExtractionResult	extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Just returns an empty extraction result since the content can't be extracted form a generic resource.
boolean	isLocaleDependend() Returns true if this document factory is locale depended.
boolean	isUsingCache() Returns true if result caching is supported for this factory.

从类继承的方法 org.opencms.search.documents.A_CmsVfsDocument

createDocument, getCache, getDocumentKey, getDocumentKeys, getName, logContentExtraction, readFile, setCache

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

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

构造器详细资料

CmsDocumentGeneric

public CmsDocumentGeneric(java.lang.String name)

Creates a new instance of this lucene document factory.

参数:

name - name of the documenttype

方法详细资料

extractContent

public I_CmsExtractionResult extractContent(CmsObject cms,
                                   CmsResource resource,
                                   CmsSearchIndex index)
                                     throws CmsIndexException

Just returns an empty extraction result since the content can't be extracted form a generic resource.

参数:

cms - the cms object

resource - the resource to extract the content from

index - the index to extract the content for

返回:

the extracted content of the resource

抛出:

CmsIndexException

另请参阅:

I_CmsSearchExtractor.extractContent(CmsObject, CmsResource, CmsSearchIndex)

isLocaleDependend

public boolean isLocaleDependend()

从接口复制的说明: I_CmsDocumentFactory

Returns true if this document factory is locale depended.

返回:

true if this document factory is locale depended

另请参阅:

I_CmsDocumentFactory.isLocaleDependend()

isUsingCache

public boolean isUsingCache()

从接口复制的说明: I_CmsDocumentFactory

Returns true if result caching is supported for this factory.

返回:

true if result caching is supported for this factory

另请参阅:

I_CmsDocumentFactory.isUsingCache()