Package adams.flow.transformer.exiftagoperation

Class ApacheCommonsExifTagWrite

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

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

adams.flow.transformer.exiftagoperation.AbstractApacheCommonsExifTagOperation<Object,Object>

adams.flow.transformer.exiftagoperation.ApacheCommonsExifTagWrite

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ExifTagOperation<Object,Object>, ExifTagWriteOperation<Object,Object>, Serializable

public class ApacheCommonsExifTagWrite
extends AbstractApacheCommonsExifTagOperation<Object,Object>
implements ExifTagWriteOperation<Object,Object>

Sets the specified tag value in the file.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Value	the value to write.

Fields inherited from class adams.flow.transformer.exiftagoperation.AbstractApacheCommonsExifTagOperation

m_Tag

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

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the type of data that we can process.
protected String	check(Object input)	Hook method for performing checks before processing the data.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doProcess(Object input, MessageCollection errors)	Processes the incoming data.
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.
String	getValue()	Returns the value to store.
String	globalInfo()	Returns a string describing the object.
void	setValue(String value)	Sets the value to store.
String	valueTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.exiftagoperation.AbstractApacheCommonsExifTagOperation

getTag, setTag, tagTipText

Methods inherited from class adams.flow.transformer.exiftagoperation.AbstractExifTagOperation

process

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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.flow.transformer.exiftagoperation.ExifTagOperation

process

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Value

protected String m_Value

the value to write.

Constructor Detail

ApacheCommonsExifTagWrite

public ApacheCommonsExifTagWrite()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractApacheCommonsExifTagOperation<Object,Object>

setValue

public void setValue(String value)

Sets the value to store.

Parameters:

value - the value

getValue

public String getValue()

Returns the value to store.

Returns:

the value

valueTipText

public String valueTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractApacheCommonsExifTagOperation<Object,Object>

Returns:

null if no info available, otherwise short string

accepts

public Class[] accepts()

Returns the type of data that we can process.

Specified by:

accepts in interface ExifTagOperation<Object,Object>

Specified by:

accepts in class AbstractExifTagOperation<Object,Object>

Returns:

the type of data

generates

public Class[] generates()

Returns the type of data that we generate.

Specified by:

generates in interface ExifTagOperation<Object,Object>

Specified by:

generates in class AbstractExifTagOperation<Object,Object>

Returns:

the type of data

check

protected String check(Object input)

Hook method for performing checks before processing the data.

Overrides:

check in class AbstractExifTagOperation<Object,Object>

Parameters:

input - the input to process

Returns:

null if successful, otherwise error message

doProcess

protected Object doProcess(Object input,
                           MessageCollection errors)

Processes the incoming data.

Specified by:

doProcess in class AbstractExifTagOperation<Object,Object>

Parameters:

input - the input to process

errors - for storing errors

Returns:

the generated output