Package adams.data.idupdate

Class IDHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.idupdate.AbstractIDUpdater

adams.data.idupdate.IDHandler

All Implemented Interfaces:

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

public class IDHandler
extends AbstractIDUpdater

Updates the ID of (mutable) ID handlers.

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

Method Summary

Modifier and Type	Method	Description
protected String	doUpdateID(Object obj, String id)	Updates the ID of the object.
String	globalInfo()	Returns a string describing the object.
boolean	handles(Object obj)	Checks whether the data type is handled.

Methods inherited from class adams.data.idupdate.AbstractIDUpdater

check, getQuickInfo, updateID

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, 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, defineOptions, getOptionManager, toCommandLine

Constructor Detail

IDHandler

public IDHandler()

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

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