Package adams.data.idupdate

Class AbstractIDUpdater

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.idupdate.AbstractIDUpdater

All Implemented Interfaces:

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

Direct Known Subclasses:

IDHandler, PassThrough, ReportField

public abstract class AbstractIDUpdater
extends AbstractOptionHandler
implements IDUpdater

Ancestor for schemes that update the ID of objects.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(Object obj, String id)	Performs checks on the object.
protected abstract String	doUpdateID(Object obj, String id)	Updates the ID of the object.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	updateID(Object obj, String id)	Updates the ID of the object.

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.data.idupdate.IDUpdater

handles

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

AbstractIDUpdater

public AbstractIDUpdater()

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(Object obj,
                       String id)

Performs checks on the object.

Parameters:

obj - the object to check

id - the new ID

Returns:

null if successful, otherwise error message

doUpdateID

protected abstract String doUpdateID(Object obj,
                                     String id)

Updates the ID of the object.

Parameters:

obj - the object to process

id - the new ID

Returns:

null if successful, otherwise error message

updateID

public String updateID(Object obj,
                       String id)

Updates the ID of the object.

Specified by:

updateID in interface IDUpdater

Parameters:

obj - the object to process

id - the new ID

Returns:

null if successful, otherwise error message