com.exlibris.dps.sdk.techmd

Interface TechnicalMDExtractorPlugin

All Known Subinterfaces:

MDExtractorPlugin

public interface 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
void	extract(java.lang.String file) Extracts a file's attributes according to the given file path.
java.lang.String	getAgent() Returns the software agent key compatible with the application key in the application library.
java.lang.String	getAttributeByName(java.lang.String attributeName) Returns the attribute value according to the given attribute name.
default java.util.List<java.lang.String>	getExtractionErrorIds() Return extraction errors ids.
java.util.List<java.lang.String>	getExtractionErrors() Return extraction errors.
java.util.List<java.lang.String>	getSupportedAttributeNames() Returns a list of all attributes that are supported by the extractor implementation.

Method Detail

extract

void extract(java.lang.String file)
      throws java.lang.Exception

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.

getAttributeByName

java.lang.String getAttributeByName(java.lang.String attributeName)

Returns the attribute value according to the given attribute name. AttributesName is one of the supported attributes that is extracted using the extract(String file) method.

Parameters:

attributeName -

Returns:

the attribute value.

getSupportedAttributeNames

java.util.List<java.lang.String> getSupportedAttributeNames()

Returns a list of all attributes that are supported by the extractor implementation.

Returns:

a list of supported attributes.

getAgent

java.lang.String getAgent()

Returns the software agent key compatible with the application key in the application library.

Returns:

the application key.

getExtractionErrors

java.util.List<java.lang.String> getExtractionErrors()

Return extraction errors.

Returns:

null in case there are no errors

getExtractionErrorIds

default java.util.List<java.lang.String> getExtractionErrorIds()

Return extraction errors ids.

Returns:

null in case there are no errors