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.10 $
Author:
Alexander Kandzior

Field Summary
static java.lang.String ITEM_AUTHOR
          Key to access the document author name in the item map.
static java.lang.String ITEM_CATEGORY
          Key to access the document catrgory in the item map.
static java.lang.String ITEM_COMMENTS
          Key to access the document comments in the item map.
static java.lang.String ITEM_COMPANY
          Key to access the document company name in the item map.
static java.lang.String ITEM_CONTENT
          Key for accessing the default (combined) content in getContentItems().
static java.lang.String ITEM_CREATOR
          Key to access the document creator name in the item map.
static java.lang.String ITEM_KEYWORDS
          Key to access the document keywords in the item map.
static java.lang.String ITEM_MANAGER
          Key to access the document manager name in the item map.
static java.lang.String ITEM_PRODUCER
          Key to access the document producer name in the item map.
static java.lang.String ITEM_RAW
          Key for accessing the raw content in getContentItems().
static java.lang.String ITEM_SUBJECT
          Key to access the document subject in the item map.
static java.lang.String ITEM_TITLE
          Key to access the document title in the item map.
 
Method Summary
 java.lang.String getContent()
          Returns the extracted content combined as a String.
 java.util.Map getContentItems()
          Returns the extracted content as individual items.
 void release()
          Releases the information stored in this extraction result, to free up the memory used.
 

Field Detail

ITEM_AUTHOR

public static final java.lang.String ITEM_AUTHOR
Key to access the document author name in the item map.

See Also:
Constant Field Values

ITEM_CATEGORY

public static final java.lang.String ITEM_CATEGORY
Key to access the document catrgory in the item map.

See Also:
Constant Field Values

ITEM_COMMENTS

public static final java.lang.String ITEM_COMMENTS
Key to access the document comments in the item map.

See Also:
Constant Field Values

ITEM_COMPANY

public static final java.lang.String ITEM_COMPANY
Key to access the document company name in the item map.

See Also:
Constant Field Values

ITEM_CONTENT

public static final java.lang.String ITEM_CONTENT
Key for accessing the default (combined) content in getContentItems().

See Also:
Constant Field Values

ITEM_CREATOR

public static final java.lang.String ITEM_CREATOR
Key to access the document creator name in the item map.

See Also:
Constant Field Values

ITEM_KEYWORDS

public static final java.lang.String ITEM_KEYWORDS
Key to access the document keywords in the item map.

See Also:
Constant Field Values

ITEM_MANAGER

public static final java.lang.String ITEM_MANAGER
Key to access the document manager name in the item map.

See Also:
Constant Field Values

ITEM_PRODUCER

public static final java.lang.String ITEM_PRODUCER
Key to access the document producer name in the item map.

See Also:
Constant Field Values

ITEM_RAW

public static final java.lang.String ITEM_RAW
Key for accessing the raw content in getContentItems().

See Also:
Constant Field Values

ITEM_SUBJECT

public static final java.lang.String ITEM_SUBJECT
Key to access the document subject in the item map.

See Also:
Constant Field Values

ITEM_TITLE

public static final java.lang.String ITEM_TITLE
Key to access the document title in the item map.

See Also:
Constant Field Values
Method Detail

getContent

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

Returns:
the extracted content combined as a String

getContentItems

public java.util.Map getContentItems()
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:

Returns:
the extracted content as individual items

release

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