Package org.alfresco.repo.content.metadata

Interface MetadataExtracter

All Superinterfaces:

ContentWorker

All Known Implementing Classes:

AbstractMappingMetadataExtracter, DWGMetadataExtracter, HtmlMetadataExtracter, JodConverterMetadataExtracter, MailMetadataExtracter, MP3MetadataExtracter, OfficeMetadataExtracter, OpenDocumentMetadataExtracter, PdfBoxMetadataExtracter, PoiMetadataExtracter, RFC822MetadataExtracter, TikaAudioMetadataExtracter, TikaAutoMetadataExtracter, TikaPoweredMetadataExtracter, TikaSpringConfiguredMetadataExtracter, XmlMetadataExtracter, XPathMetadataExtracter

@AlfrescoPublicApi
public interface MetadataExtracter
extends ContentWorker

Interface for document property extracters.

Please pardon the incorrect spelling of extractor.

Author:

Jesper Steen Møller, Derek Hulley

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MetadataExtracter.OverwritePolicy	A enumeration of functional property overwrite policies.

Method Summary

Modifier and Type	Method	Description
java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable>	extract(org.alfresco.service.cmr.repository.ContentReader reader, java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> destination)	Extracts the metadata values from the content provided by the reader and source mimetype to the supplied map.
java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable>	extract(org.alfresco.service.cmr.repository.ContentReader reader, MetadataExtracter.OverwritePolicy overwritePolicy, java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> destination)	Extracts the metadata values from the content provided by the reader and source mimetype to the supplied map.
java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable>	extract(org.alfresco.service.cmr.repository.ContentReader reader, MetadataExtracter.OverwritePolicy overwritePolicy, java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> destination, java.util.Map<java.lang.String,java.util.Set<org.alfresco.service.namespace.QName>> mapping)	Extracts the metadata from the content provided by the reader and source mimetype to the supplied map.
boolean	isSupported(java.lang.String mimetype)	Determines if the extracter works against the given mimetype.

Method Detail

isSupported

boolean isSupported(java.lang.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.

extract

java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> extract(org.alfresco.service.cmr.repository.ContentReader reader,
                                                                                       java.util.Map<org.alfresco.service.namespace.QName,java.io.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:

org.alfresco.service.cmr.repository.ContentIOException - if a detectable error occurs

See Also:

extract(ContentReader, OverwritePolicy, Map, Map)

extract

java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> extract(org.alfresco.service.cmr.repository.ContentReader reader,
                                                                                       MetadataExtracter.OverwritePolicy overwritePolicy,
                                                                                       java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> destination)

Extracts the metadata values from the content provided by the reader and source mimetype to the supplied map.

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

overwritePolicy - the policy stipulating how the system properties must be overwritten if present

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:

org.alfresco.service.cmr.repository.ContentIOException - if a detectable error occurs

See Also:

extract(ContentReader, OverwritePolicy, Map, Map)

extract

java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> extract(org.alfresco.service.cmr.repository.ContentReader reader,
                                                                                       MetadataExtracter.OverwritePolicy overwritePolicy,
                                                                                       java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> destination,
                                                                                       java.util.Map<java.lang.String,java.util.Set<org.alfresco.service.namespace.QName>> mapping)

Extracts the metadata from the content provided by the reader and source mimetype to the supplied map. The mapping from document metadata to system metadata is explicitly provided. The overwrite policy is also explictly set.

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

overwritePolicy - the policy stipulating how the system properties must be overwritten if present

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

mapping - a mapping of document-specific properties to system properties.

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:

org.alfresco.service.cmr.repository.ContentIOException - if a detectable error occurs

See Also:

extract(ContentReader, Map)