com.exlibris.dps.sdk.techmd

Interface MDExtractorPlugin

All Superinterfaces:

TechnicalMDExtractorPlugin

public interface MDExtractorPlugin
extends TechnicalMDExtractorPlugin

Interface for metadata extractors. Each extractor handles a specific format and extracts its attributes.
This plugin interface only supports java implementation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormatName() Returns the format name of the file that is fetched by the extraction.
java.lang.String	getFormatVersion() Returns the format version of the file that is fetched by the extraction.
java.lang.Integer	getImageCount() This method is relevant only for image extractors.
java.lang.String	getMimeType() Returns the MIME type of the file that is fetched by the extraction.
default java.lang.String	getProfile() Extracts a file's attributes according to the given file path.
boolean	isValid() Implementation of a general file validation.
boolean	isWellFormed() Implementation of a file formed check.

Methods inherited from interface com.exlibris.dps.sdk.techmd.TechnicalMDExtractorPlugin

extract, getAgent, getAttributeByName, getExtractionErrorIds, getExtractionErrors, getSupportedAttributeNames

Method Detail

getProfile

default java.lang.String getProfile()

Extracts a file's attributes according to the given file path. Extraction of all attributes relevant to the format implementation.
The attribute values can be given using the getAttributeByName(String) method

Parameters:

file - the file path to extract

Throws:

java.lang.Exception - if an unexpected exception occurs, such as IOException.

getFormatName

java.lang.String getFormatName()

Returns the format name of the file that is fetched by the extraction.

Returns:

the format name of the file.

getFormatVersion

java.lang.String getFormatVersion()

Returns the format version of the file that is fetched by the extraction.

Returns:

the format version of the file.

getMimeType

java.lang.String getMimeType()

Returns the MIME type of the file that is fetched by the extraction.

Returns:

the MIME type of the file.

getImageCount

java.lang.Integer getImageCount()

This method is relevant only for image extractors. Returns the number of images if the file (such as TIFF, JPEG, etc.) contains several pages/images

Returns:

the number of images that are part of the full image in the case of a complex image.

isValid

boolean isValid()

Implementation of a general file validation. If there is no specific implementation, return true.

Returns:

validation result if implemented, otherwise true.

isWellFormed

boolean isWellFormed()

Implementation of a file formed check. If there is no specific implementation, return true.

Returns:

file formed result if implemented, otherwise true.