org.opencms.search.extractors
Interface I_CmsExtractionResult

All Known Implementing Classes:

CmsExtractionResult

public interface I_CmsExtractionResult

The result of a document text extraction.

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

Since:

6.0.0

Version:

$Revision: 1.7 $

Author:

Alexander Kandzior

Field Summary

static String	META_AUTHOR Key to access the document author name in the meta information map (the value is a String object).
static String	META_CATEGORY Key to access the document catrgory in the meta information map (the value is a String object).
static String	META_COMMENTS Key to access the document comments in the meta information map (the value is a String object).
static String	META_COMPANY Key to access the document company name in the meta information map (the value is a String object).
static String	META_CREATOR Key to access the document creator name in the meta information map (the value is a String object).
static String	META_DATE_CREATED Key to access the document creation date in the meta information map (the value is a Date object).
static String	META_DATE_LASTMODIFIED Key to access the document date of last modification in the meta information map (the value is a Date object).
static String	META_KEYWORDS Key to access the document keywords in the meta information map (the value is a String object).
static String	META_MANAGER Key to access the document manager name in the meta information map (the value is a String object).
static String	META_PRODUCER Key to access the document producer name in the meta information map (the value is a String object).
static String	META_SUBJECT Key to access the document subject in the meta information map (the value is a String object).
static String	META_TITLE Key to access the document title in the meta information map (the value is a String object).

Method Summary

String	getContent() Returns the extracted content as a String.
Map	getMetaInfo() Returns the extracted meta information.
void	release() Releases the information stored in this extraction result, to free up the memory used.

Field Detail

META_AUTHOR

static final String META_AUTHOR

Key to access the document author name in the meta information map (the value is a String object).

See Also:

Constant Field Values

META_CATEGORY

static final String META_CATEGORY

Key to access the document catrgory in the meta information map (the value is a String object).

See Also:

Constant Field Values

META_COMMENTS

static final String META_COMMENTS

Key to access the document comments in the meta information map (the value is a String object).

See Also:

Constant Field Values

META_COMPANY

static final String META_COMPANY

Key to access the document company name in the meta information map (the value is a String object).

See Also:

Constant Field Values

META_CREATOR

static final String META_CREATOR

Key to access the document creator name in the meta information map (the value is a String object).

See Also:

Constant Field Values

META_DATE_CREATED

static final String META_DATE_CREATED

Key to access the document creation date in the meta information map (the value is a Date object).

See Also:

Constant Field Values

META_DATE_LASTMODIFIED

static final String META_DATE_LASTMODIFIED

Key to access the document date of last modification in the meta information map (the value is a Date object).

See Also:

Constant Field Values

META_KEYWORDS

static final String META_KEYWORDS

Key to access the document keywords in the meta information map (the value is a String object).

See Also:

Constant Field Values

META_MANAGER

static final String META_MANAGER

Key to access the document manager name in the meta information map (the value is a String object).

See Also:

Constant Field Values

META_PRODUCER

static final String META_PRODUCER

Key to access the document producer name in the meta information map (the value is a String object).

See Also:

Constant Field Values

META_SUBJECT

static final String META_SUBJECT

Key to access the document subject in the meta information map (the value is a String object).

See Also:

Constant Field Values

META_TITLE

static final String META_TITLE

Key to access the document title in the meta information map (the value is a String object).

See Also:

Constant Field Values

Method Detail

getContent

String getContent()

Returns the extracted content as a String.

Returns:

the extracted content as a String

getMetaInfo

Map getMetaInfo()

Returns the extracted meta information.

The result Map contains all meta information extracted by the extractor. The key is always a String, and should be one of the constants defined in the I_CmsExtractionResult interface. For example META_TITLE will contain the document title as a String.

Returns:

the extracted meta information

release

void release()

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