org.opencms.search.extractors

类 CmsExtractionResult

java.lang.Object

org.opencms.search.extractors.CmsExtractionResult

所有已实现的接口:

java.io.Serializable, I_CmsExtractionResult

public class CmsExtractionResult
extends java.lang.Object
implements I_CmsExtractionResult, java.io.Serializable

The result of a document text extraction.

This data structure contains the extracted text as well as (optional) meta information extracted from the document.

从以下版本开始:

6.0.0

另请参阅:

序列化表格

字段概要

从接口继承的字段 org.opencms.search.extractors.I_CmsExtractionResult

ITEM_AUTHOR, ITEM_CATEGORY, ITEM_COMMENTS, ITEM_COMPANY, ITEM_CONTENT, ITEM_CREATOR, ITEM_KEYWORDS, ITEM_MANAGER, ITEM_PRODUCER, ITEM_RAW, ITEM_SUBJECT, ITEM_TITLE

构造器概要

构造器

构造器和说明
CmsExtractionResult(java.lang.String content) Creates a new extraction result without meta information and without additional fields.
CmsExtractionResult(java.lang.String content, java.util.Map<java.lang.String,java.lang.String> contentItems) Creates a new extraction result.

方法概要

方法

限定符和类型	方法和说明
static CmsExtractionResult	fromBytes(byte[] bytes) Creates an extraction result from a serialized byte array.
byte[]	getBytes() Returns this extraction result serialized as a byte array.
java.lang.String	getContent() Returns the extracted content combined as a String.
java.util.Map<java.lang.String,java.lang.String>	getContentItems() Returns the extracted content as individual items.
void	release() Releases the information stored in this extraction result, to free up the memory used.

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

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

构造器详细资料

CmsExtractionResult

public CmsExtractionResult(java.lang.String content)

Creates a new extraction result without meta information and without additional fields.

参数:

content - the extracted content

CmsExtractionResult

public CmsExtractionResult(java.lang.String content,
                   java.util.Map<java.lang.String,java.lang.String> contentItems)

Creates a new extraction result.

参数:

content - the extracted content

contentItems - the individual extracted content items

方法详细资料

fromBytes

public static final CmsExtractionResult fromBytes(byte[] bytes)

Creates an extraction result from a serialized byte array.

参数:

bytes - the serialized version of the extraction result

返回:

extraction result created from the serialized byte array

getBytes

public byte[] getBytes()

从接口复制的说明: I_CmsExtractionResult

Returns this extraction result serialized as a byte array.

指定者:

getBytes 在接口中 I_CmsExtractionResult

返回:

this extraction result serialized as a byte array

另请参阅:

I_CmsExtractionResult.getBytes()

getContent

public java.lang.String getContent()

从接口复制的说明: I_CmsExtractionResult

Returns the extracted content combined as a String.

指定者:

getContent 在接口中 I_CmsExtractionResult

返回:

the extracted content combined as a String

另请参阅:

I_CmsExtractionResult.getContent()

getContentItems

public java.util.Map<java.lang.String,java.lang.String> getContentItems()

从接口复制的说明: I_CmsExtractionResult

Returns the extracted content as individual items.

The result Map contains all content items extracted by the extractor. The key is always a String, and contains the name of the item. The value is also a String and contains the extracted text.

The detailed form will depend on the resource type indexed:

• For a xmlpage, the key will be the element name, and the value will be the text of the element.
• For a xmlcontent, the key will be the xpath of the XML node, and the value will be the text of that XML node.
• In case the document contains meta information (for example PDF or MS Office documents), the meta information is stored with the name of the meta field as key and the content as value.
• For all other resource types, there will be only ony key I_CmsExtractionResult.ITEM_CONTENT, which will contain the value of the complete content.

指定者:

getContentItems 在接口中 I_CmsExtractionResult

返回:

the extracted content as individual items

另请参阅:

I_CmsExtractionResult.getContentItems()

release

public void release()

从接口复制的说明: I_CmsExtractionResult

Releases the information stored in this extraction result, to free up the memory used.

指定者:

release 在接口中 I_CmsExtractionResult

另请参阅:

I_CmsExtractionResult.release()