Package adams.data.idupdate

Class ReportField

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.idupdate.AbstractIDUpdater

adams.data.idupdate.ReportField

All Implemented Interfaces:

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

public class ReportField
extends AbstractIDUpdater

Sets the ID under the specified field in the report (either report or report handler).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Field	m_Field	the report field.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doUpdateID(Object obj, String id)	Updates the ID of the object.
String	fieldTipText()	Returns the tip text for this property.
Field	getField()	Returns the field to set the ID under.
String	globalInfo()	Returns a string describing the object.
boolean	handles(Object obj)	Checks whether the data type is handled.
void	setField(Field value)	Sets the field to set the ID under.

Methods inherited from class adams.data.idupdate.AbstractIDUpdater

check, getQuickInfo, updateID

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.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Field

protected Field m_Field

the report field.

Constructor Detail

ReportField

public ReportField()

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 AbstractOptionHandler

setField

public void setField(Field value)

Sets the field to set the ID under.

Parameters:

value - the field

getField

public Field getField()

Returns the field to set the ID under.

Returns:

the field

fieldTipText

public String fieldTipText()

Returns the tip text for this property.

Returns:

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

handles

public boolean handles(Object obj)

Checks whether the data type is handled.

Parameters:

obj - the object to check

Returns:

true if handled

doUpdateID

protected String doUpdateID(Object obj,
                            String id)

Updates the ID of the object.

Specified by:

doUpdateID in class AbstractIDUpdater

Parameters:

obj - the object to process

id - the new ID

Returns:

null if successful, otherwise error message