Package adams.data.groupextraction

Class SpreadSheetCell

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.groupextraction.AbstractGroupExtractor

adams.data.groupextraction.SpreadSheetCell

All Implemented Interfaces:

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

Direct Known Subclasses:

SpreadSheetCellWithLookUp

public class SpreadSheetCell
extends AbstractGroupExtractor
implements SpreadSheetRowGroupExtractorWithColumn

Returns the cell value of the spreadsheet row.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SpreadSheetColumnIndex	m_Column	the column index.

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

Method Summary

Modifier and Type	Method	Description
String	columnTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExtractGroup(Object obj)	Extracts the group from the object.
SpreadSheetColumnIndex	getColumn()	Returns the column to get the group from.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
boolean	handles(Object obj)	Checks whether the data type is handled.
void	setColumn(SpreadSheetColumnIndex value)	Sets the column to get the group from.

Methods inherited from class adams.data.groupextraction.AbstractGroupExtractor

check, extractGroup

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

extractGroup

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Column

protected SpreadSheetColumnIndex m_Column

the column index.

Constructor Detail

SpreadSheetCell

public SpreadSheetCell()

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

setColumn

public void setColumn(SpreadSheetColumnIndex value)

Sets the column to get the group from.

Specified by:

setColumn in interface SpreadSheetRowGroupExtractorWithColumn

Parameters:

value - the column

getColumn

public SpreadSheetColumnIndex getColumn()

Returns the column to get the group from.

Specified by:

getColumn in interface SpreadSheetRowGroupExtractorWithColumn

Returns:

the column

columnTipText

public String columnTipText()

Returns the tip text for this property.

Specified by:

columnTipText in interface SpreadSheetRowGroupExtractorWithColumn

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractGroupExtractor

Returns:

null if no info available, otherwise short string

handles

public boolean handles(Object obj)

Checks whether the data type is handled.

Specified by:

handles in interface GroupExtractor

Parameters:

obj - the object to check

Returns:

true if handled

doExtractGroup

protected String doExtractGroup(Object obj)

Extracts the group from the object.

Specified by:

doExtractGroup in class AbstractGroupExtractor

Parameters:

obj - the object to process

Returns:

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