Package adams.data.groupupdate

Class AbstractGroupUpdater

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.groupupdate.AbstractGroupUpdater

All Implemented Interfaces:

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

Direct Known Subclasses:

PassThrough, ReportField

public abstract class AbstractGroupUpdater
extends AbstractOptionHandler
implements GroupUpdater

Ancestor for schemes that update the group 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
AbstractGroupUpdater()

Method Summary

Modifier and Type	Method	Description
protected String	check(Object obj, String group)	Performs checks on the object.
protected abstract String	doUpdateGroup(Object obj, String group)	Updates the group of the object.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	updateGroup(Object obj, String group)	Updates the group 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.groupupdate.GroupUpdater

handles

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

AbstractGroupUpdater

public AbstractGroupUpdater()

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 group)

Performs checks on the object.

Parameters:

obj - the object to check

group - the new group

Returns:

null if successful, otherwise error message

doUpdateGroup

protected abstract String doUpdateGroup(Object obj,
                                        String group)

Updates the group of the object.

Parameters:

obj - the object to process

group - the new group

Returns:

null if successful, otherwise error message

updateGroup

public String updateGroup(Object obj,
                          String group)

Updates the group of the object.

Specified by:

updateGroup in interface GroupUpdater

Parameters:

obj - the object to process

group - the new group

Returns:

null if successful, otherwise error message