MetadataExtracter (Alfresco 5.0.3 Public API)

Method Summary
Map<QName,Serializable>	extract(ContentReader reader, Map<QName,Serializable> destination) Extracts the metadata values from the content provided by the reader and source mimetype to the supplied map.
Map<QName,Serializable>	extract(ContentReader reader, MetadataExtracter.OverwritePolicy overwritePolicy, Map<QName,Serializable> destination) Extracts the metadata values from the content provided by the reader and source mimetype to the supplied map.
Map<QName,Serializable>	extract(ContentReader reader, MetadataExtracter.OverwritePolicy overwritePolicy, Map<QName,Serializable> destination, Map<String,Set<QName>> mapping) Extracts the metadata from the content provided by the reader and source mimetype to the supplied map.
long	getExtractionTime() Deprecated. Generally not useful or used. Extraction is normally specifically configured.
double	getReliability(String mimetype) Deprecated. This method is replaced by isSupported(String)
boolean	isSupported(String mimetype) Determines if the extracter works against the given mimetype.

Method Detail

getReliability

double getReliability(String mimetype)

Deprecated. This method is replaced by isSupported(String)

Get an estimate of the extracter's reliability on a scale from 0.0 to 1.0.

Parameters:

mimetype - the mimetype to check

Returns:

Returns a reliability indicator from 0.0 to 1.0

isSupported

boolean isSupported(String mimetype)

Determines if the extracter works against the given mimetype.

Parameters:

mimetype - the document mimetype

Returns:

Returns true if the mimetype is supported, otherwise false.

getExtractionTime

long getExtractionTime()

Deprecated. Generally not useful or used. Extraction is normally specifically configured.

Provides an estimate, usually a worst case guess, of how long an extraction will take.

This method is used to determine, up front, which of a set of equally reliant transformers will be used for a specific extraction.

Returns:

Returns the approximate number of milliseconds per transformation

extract

Map<QName,Serializable> extract(ContentReader reader,
Map<QName,Serializable> destination)

Extracts the metadata values from the content provided by the reader and source mimetype to the supplied map. The internal mapping and overwrite policy between document metadata and system metadata will be used.

The extraction viability can be determined by an up front call to isSupported(String).

The source mimetype must be available on the ContentAccessor.getMimetype() method of the reader.

Parameters:

reader - the source of the content

destination - the map of properties to populate (essentially a return value)

Returns:

Returns a map of all properties on the destination map that were added or modified. If the return map is empty, then no properties were modified.

Throws:

ContentIOException - if a detectable error occurs