Package adams.flow.transformer.metadata

Class AbstractMetaDataExtractor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.metadata.AbstractMetaDataExtractor

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

Direct Known Subclasses:

ApacheCommons, MetaDataExtractor

public abstract class AbstractMetaDataExtractor
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor for algorithms that extract meta-data from image files.

Version:

$Revision: 78 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractMetaDataExtractor()

Method Summary

Modifier and Type	Method	Description
protected void	check(File file)	Checks whether the input can be used.
protected abstract SpreadSheet	doExtract(File file)	Performs the actual meta-data extraction.
SpreadSheet	extract(File file)	Extracts the meta-data from the image.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractMetaDataExtractor

public AbstractMetaDataExtractor()

Method Detail

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected void check(File file)

Checks whether the input can be used.

Default implementation ensures that the file is available.

Parameters:

file - the file to check

doExtract

protected abstract SpreadSheet doExtract(File file)
                                  throws Exception

Performs the actual meta-data extraction.

Parameters:

file - the file to process

Returns:

the meta-data

Throws:

Exception - if extraction fails

extract

public SpreadSheet extract(File file)
                    throws Exception

Extracts the meta-data from the image.

Parameters:

file - the file to process

Returns:

the meta-data

Throws:

Exception - if extraction fails