|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetadataExtracter
Interface for document property extracters.
Please pardon the incorrect spelling of extractor.
Nested Class Summary | |
---|---|
static class |
MetadataExtracter.OverwritePolicy
A enumeration of functional property overwrite policies. |
Method Summary | |
---|---|
java.util.Map |
extract(ContentReader reader,
java.util.Map destination)
Extracts the metadata values from the content provided by the reader and source mimetype to the supplied map. |
java.util.Map |
extract(ContentReader reader,
MetadataExtracter.OverwritePolicy overwritePolicy,
java.util.Map destination)
Extracts the metadata values from the content provided by the reader and source mimetype to the supplied map. |
java.util.Map |
extract(ContentReader reader,
MetadataExtracter.OverwritePolicy overwritePolicy,
java.util.Map destination,
java.util.Map 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(java.lang.String mimetype)
Deprecated. This method is replaced by MetadataExtracter.isSupported(String) |
boolean |
isSupported(java.lang.String mimetype)
Determines if the extracter works against the given mimetype. |
Method Detail |
---|
double getReliability(java.lang.String mimetype)
MetadataExtracter.isSupported(String)
mimetype
- the mimetype to check
boolean isSupported(java.lang.String mimetype)
mimetype
- the document mimetype
long getExtractionTime()
This method is used to determine, up front, which of a set of equally reliant transformers will be used for a specific extraction.
java.util.Map extract(ContentReader reader, java.util.Map destination)
overwrite policy
between document metadata and system metadata will be used.
The extraction viability can be determined by an up front call to MetadataExtracter.isSupported(String)
.
The source mimetype must be available on the
ContentAccessor.getMimetype()
method
of the reader.
reader
- the source of the contentdestination
- the map of properties to populate (essentially a return value)
ContentIOException
- if a detectable error occursMetadataExtracter.extract(ContentReader, OverwritePolicy, Map, Map)
java.util.Map extract(ContentReader reader, MetadataExtracter.OverwritePolicy overwritePolicy, java.util.Map destination)
The extraction viability can be determined by an up front call to MetadataExtracter.isSupported(String)
.
The source mimetype must be available on the
ContentAccessor.getMimetype()
method
of the reader.
reader
- the source of the contentoverwritePolicy
- the policy stipulating how the system properties must be
overwritten if presentdestination
- the map of properties to populate (essentially a return value)
ContentIOException
- if a detectable error occursMetadataExtracter.extract(ContentReader, OverwritePolicy, Map, Map)
java.util.Map extract(ContentReader reader, MetadataExtracter.OverwritePolicy overwritePolicy, java.util.Map destination, java.util.Map mapping)
overwrite policy
is also explictly
set.
The extraction viability can be determined by an up front call to
MetadataExtracter.isSupported(String)
.
The source mimetype must be available on the
ContentAccessor.getMimetype()
method
of the reader.
reader
- the source of the contentoverwritePolicy
- the policy stipulating how the system properties must be
overwritten if presentdestination
- the map of properties to populate (essentially a return value)mapping
- a mapping of document-specific properties to system properties.
ContentIOException
- if a detectable error occursMetadataExtracter.extract(ContentReader, Map)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |