Package adams.data.groupextraction

Class AbstractGroupExtractor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.groupextraction.AbstractGroupExtractor

All Implemented Interfaces:

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

Direct Known Subclasses:

Manual, Null, ReportField, ReportFieldRegExp, SpreadSheetCell, SpreadSheetCellRegExp

public abstract class AbstractGroupExtractor
extends AbstractOptionHandler
implements GroupExtractor

Ancestor for schemes that extract the group from 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
AbstractGroupExtractor()

Method Summary

Modifier and Type	Method	Description
protected String	check(Object obj)	Performs checks on the object.
protected abstract String	doExtractGroup(Object obj)	Extracts the group from the object.
String	extractGroup(Object obj)	Extracts the group from the object.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.

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.groupextraction.GroupExtractor

handles

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

AbstractGroupExtractor

public AbstractGroupExtractor()

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)

Performs checks on the object.

Parameters:

obj - the object to check

Returns:

null if successful, otherwise error message

doExtractGroup

protected abstract String doExtractGroup(Object obj)

Extracts the group from the object.

Parameters:

obj - the object to process

Returns:

the extracted group, null if failed to extract or not handled

extractGroup

public String extractGroup(Object obj)

Extracts the group from the object.

Specified by:

extractGroup in interface GroupExtractor

Parameters:

obj - the object to process

Returns:

the extracted group, null if failed to extract or not handled