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 java.lang.String META_AUTHOR
          Key to access the document author name in the meta information map (the value is a String object).
static java.lang.String META_CATEGORY
          Key to access the document catrgory in the meta information map (the value is a String object).
static java.lang.String META_COMMENTS
          Key to access the document comments in the meta information map (the value is a String object).
static java.lang.String META_COMPANY
          Key to access the document company name in the meta information map (the value is a String object).
static java.lang.String META_CREATOR
          Key to access the document creator name in the meta information map (the value is a String object).
static java.lang.String META_DATE_CREATED
          Key to access the document creation date in the meta information map (the value is a Date object).
static java.lang.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 java.lang.String META_KEYWORDS
          Key to access the document keywords in the meta information map (the value is a String object).
static java.lang.String META_MANAGER
          Key to access the document manager name in the meta information map (the value is a String object).
static java.lang.String META_PRODUCER
          Key to access the document producer name in the meta information map (the value is a String object).
static java.lang.String META_SUBJECT
          Key to access the document subject in the meta information map (the value is a String object).
static java.lang.String META_TITLE
          Key to access the document title in the meta information map (the value is a String object).
 
Method Summary
 java.lang.String getContent()
          Returns the extracted content as a String.
 java.util.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

public static final java.lang.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

public static final java.lang.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

public static final java.lang.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

public static final java.lang.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

public static final java.lang.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

public static final java.lang.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

public static final java.lang.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

public static final java.lang.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

public static final java.lang.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

public static final java.lang.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

public static final java.lang.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

public static final java.lang.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

public java.lang.String getContent()
Returns the extracted content as a String.

Returns:
the extracted content as a String

getMetaInfo

public java.util.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

public void release()
Releases the information stored in this extraction result, to free up the memory used.