Package adams.flow.transformer.exiftagoperation

Class AbstractExifTagOperation<I,O>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.exiftagoperation.AbstractExifTagOperation<I,O>

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ExifTagOperation<I,O>, Serializable

Direct Known Subclasses:

AbstractApacheCommonsExifTagOperation

public abstract class AbstractExifTagOperation<I,O>
extends AbstractOptionHandler
implements ExifTagOperation<I,O>

Ancestor for operations on EXIF data.

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
AbstractExifTagOperation()

Method Summary

Modifier and Type	Method	Description
abstract Class[]	accepts()	Returns the type of data that we can process.
protected String	check(I input)	Hook method for performing checks before processing the data.
protected abstract O	doProcess(I input, MessageCollection errors)	Processes the incoming data.
abstract Class[]	generates()	Returns the type of data that we generate.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
O	process(I input, MessageCollection errors)	Processes the incoming data.

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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

AbstractExifTagOperation

public AbstractExifTagOperation()

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

accepts

public abstract Class[] accepts()

Returns the type of data that we can process.

Specified by:

accepts in interface ExifTagOperation<I,O>

Returns:

the type of data

generates

public abstract Class[] generates()

Returns the type of data that we generate.

Specified by:

generates in interface ExifTagOperation<I,O>

Returns:

the type of data

check

protected String check(I input)

Hook method for performing checks before processing the data.

Parameters:

input - the input to process

Returns:

null if successful, otherwise error message

doProcess

protected abstract O doProcess(I input,
                               MessageCollection errors)

Processes the incoming data.

Parameters:

input - the input to process

errors - for storing errors

Returns:

the generated output

process

public O process(I input,
                 MessageCollection errors)

Processes the incoming data.

Specified by:

process in interface ExifTagOperation<I,O>

Parameters:

input - the input to process

errors - for storing errors

Returns:

the generated output