adams.data.imagemagick

Class AbstractImageOperation

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.imagemagick.AbstractImageOperation

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDcrawOperation, AbstractIMOperation, AbstractUfrawOperation

public abstract class AbstractImageOperation
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor for image operations.

Version:

$Revision$

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 and Description
AbstractImageOperation()

Method Summary

Modifier and Type	Method and Description
String	apply(PlaceholderFile input, PlaceholderFile output) Applies the operation to the input file and stores the result in the output file.
protected String	check(PlaceholderFile input, PlaceholderFile output) Hook method for performing checks before applying the operation.
protected abstract String	doApply(PlaceholderFile input, PlaceholderFile output) Applies the actual operation to the input file and stores the result in the output file.
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

AbstractImageOperation

public AbstractImageOperation()

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 String check(PlaceholderFile input,
                       PlaceholderFile output)

Hook method for performing checks before applying the operation.

Parameters:

input - the input file

output - the output file

Returns:

null if successful, otherwise error message

doApply

protected abstract String doApply(PlaceholderFile input,
                                  PlaceholderFile output)

Applies the actual operation to the input file and stores the result in the output file.

Parameters:

input - the input file

output - the output file

Returns:

null if successful, otherwise error message

apply

public String apply(PlaceholderFile input,
                    PlaceholderFile output)

Applies the operation to the input file and stores the result in the output file.

Parameters:

input - the input file

output - the output file

Returns:

null if successful, otherwise error message