Package org.opencms.search.documents

Class A_CmsVfsDocumentWithMetaData

java.lang.Object

org.opencms.search.documents.A_CmsVfsDocument

org.opencms.search.documents.A_CmsVfsDocumentWithMetaData

All Implemented Interfaces:

I_CmsDocumentFactory, I_CmsSearchExtractor

Direct Known Subclasses:

CmsDocumentMsOfficeOLE2, CmsDocumentMsOfficeOOXML, CmsDocumentPdf, CmsDocumentRtf

public abstract class A_CmsVfsDocumentWithMetaData
extends A_CmsVfsDocument

Base class for all document factories that allow to configure if meta data should be extracted or ignored.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_EXTRACT_METADATA	Parameter key for configuring if meta data should be extracted or not.

Fields inherited from class org.opencms.search.documents.A_CmsVfsDocument

DEFAULT_ALL_TYPES, DEFAULT_ALL_UNCONFIGURED_TYPES, m_name

Constructor Summary

Constructors

Constructor	Description
A_CmsVfsDocumentWithMetaData(String name)	Creates a new instance of this document factory.
A_CmsVfsDocumentWithMetaData(String name, boolean extractMetaDataByDefault)	Creates a new instance of this document factory.

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String key, String value)
boolean	isExtractMetaData()

Methods inherited from class org.opencms.search.documents.A_CmsVfsDocument

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.search.documents.I_CmsDocumentFactory

isLocaleDependend, isOnlyDependentOnContent, isUsingCache

Methods inherited from interface org.opencms.search.documents.I_CmsSearchExtractor

extractContent

Field Details

PARAM_EXTRACT_METADATA

public static final String PARAM_EXTRACT_METADATA

Parameter key for configuring if meta data should be extracted or not.

See Also:

• Constant Field Values

Constructor Details

A_CmsVfsDocumentWithMetaData

public A_CmsVfsDocumentWithMetaData(String name)

Creates a new instance of this document factory.

Parameters:

name - name of the documenttype

A_CmsVfsDocumentWithMetaData

public A_CmsVfsDocumentWithMetaData(String name,
 boolean extractMetaDataByDefault)

Creates a new instance of this document factory.

Parameters:

name - name of the documenttype

extractMetaDataByDefault - flag, indicating if meta data should be extracted by default.

Method Details

addConfigurationParameter

public void addConfigurationParameter(String key,
 String value)

Specified by:

addConfigurationParameter in interface I_CmsDocumentFactory

Overrides:

addConfigurationParameter in class A_CmsVfsDocument

See Also:

• I_CmsDocumentFactory.addConfigurationParameter(java.lang.String, java.lang.String)

isExtractMetaData

public boolean isExtractMetaData()

Returns:

flag, indicating if meta data should be extracted.