Package adams.data.groupextraction

Class SpreadSheetCellWithLookUp

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.groupextraction.AbstractGroupExtractor

adams.data.groupextraction.SpreadSheetCell

adams.data.groupextraction.SpreadSheetCellWithLookUp

All Implemented Interfaces:

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

public class SpreadSheetCellWithLookUp
extends SpreadSheetCell

Returns the cell value of the spreadsheet row.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpreadSheetCellWithLookUp.MissingLookUpKey	Describes the behaviors if a lookup key is not found.

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseKeyValuePair[]	m_LookUps	the lookup values.
protected SpreadSheetCellWithLookUp.MissingLookUpKey	m_MissingKey	the behavior for missing keys.
protected String	m_MissingValue	the missing value.
protected boolean	m_SuppressMissingKeyWarnings	whether to suppress warnings when key is not present.
protected Map<String,String>	m_Table	the lookup table.

Fields inherited from class adams.data.groupextraction.SpreadSheetCell

m_Column

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doExtractGroup(Object obj)	Extracts the group from the object.
BaseKeyValuePair[]	getLookUps()	Returns the lookup pairs.
SpreadSheetCellWithLookUp.MissingLookUpKey	getMissingKey()	Returns the behavior for missing keys.
String	getMissingValue()	Returns the value used if behavior is SpreadSheetCellWithLookUp.MissingLookUpKey.OUTPUT_MISSING_VALUE.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
boolean	getSuppressMissingKeyWarnings()	Returns whether to suppress warnings about missing keys.
String	globalInfo()	Returns a string describing the object.
String	lookUpsTipText()	Returns the tip text for this property.
String	missingKeyTipText()	Returns the tip text for this property.
String	missingValueTipText()	Returns the tip text for this property.
protected void	reset()	Resets the scheme.
void	setLookUps(BaseKeyValuePair[] value)	Sets the lookup pairs.
void	setMissingKey(SpreadSheetCellWithLookUp.MissingLookUpKey value)	Sets the behavior for missing keys.
void	setMissingValue(String value)	Sets the value to be used if behavior is SpreadSheetCellWithLookUp.MissingLookUpKey.OUTPUT_MISSING_VALUE.
void	setSuppressMissingKeyWarnings(boolean value)	Sets whether to suppress warnings about missing keys.
String	suppressMissingKeyWarningsTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.groupextraction.SpreadSheetCell

columnTipText, getColumn, handles, setColumn

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, 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_LookUps

protected BaseKeyValuePair[] m_LookUps

the lookup values.

m_MissingKey

protected SpreadSheetCellWithLookUp.MissingLookUpKey m_MissingKey

the behavior for missing keys.

m_MissingValue

protected String m_MissingValue

the missing value.

m_SuppressMissingKeyWarnings

protected boolean m_SuppressMissingKeyWarnings

whether to suppress warnings when key is not present.

m_Table

protected transient Map<String,String> m_Table

the lookup table.

Constructor Detail

SpreadSheetCellWithLookUp

public SpreadSheetCellWithLookUp()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Overrides:

globalInfo in class SpreadSheetCell

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 SpreadSheetCell

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractOptionHandler

setLookUps

public void setLookUps(BaseKeyValuePair[] value)

Sets the lookup pairs.

Parameters:

value - the lookups

getLookUps

public BaseKeyValuePair[] getLookUps()

Returns the lookup pairs.

Returns:

the lookups

lookUpsTipText

public String lookUpsTipText()

Returns the tip text for this property.

Returns:

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

setMissingKey

public void setMissingKey(SpreadSheetCellWithLookUp.MissingLookUpKey value)

Sets the behavior for missing keys.

Parameters:

value - the behavior

getMissingKey

public SpreadSheetCellWithLookUp.MissingLookUpKey getMissingKey()

Returns the behavior for missing keys.

Returns:

the behavior

missingKeyTipText

public String missingKeyTipText()

Returns the tip text for this property.

Returns:

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

setMissingValue

public void setMissingValue(String value)

Sets the value to be used if behavior is SpreadSheetCellWithLookUp.MissingLookUpKey.OUTPUT_MISSING_VALUE.

Parameters:

value - the value to use

See Also:

SpreadSheetCellWithLookUp.MissingLookUpKey.OUTPUT_MISSING_VALUE

getMissingValue

public String getMissingValue()

Returns the value used if behavior is SpreadSheetCellWithLookUp.MissingLookUpKey.OUTPUT_MISSING_VALUE.

Returns:

the value in use

See Also:

SpreadSheetCellWithLookUp.MissingLookUpKey.OUTPUT_MISSING_VALUE

missingValueTipText

public String missingValueTipText()

Returns the tip text for this property.

Returns:

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

setSuppressMissingKeyWarnings

public void setSuppressMissingKeyWarnings(boolean value)

Sets whether to suppress warnings about missing keys.

Parameters:

value - true if to suppress warnings

getSuppressMissingKeyWarnings

public boolean getSuppressMissingKeyWarnings()

Returns whether to suppress warnings about missing keys.

Returns:

true if warnings suppressed

suppressMissingKeyWarningsTipText

public String suppressMissingKeyWarningsTipText()

Returns the tip text for this property.

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 SpreadSheetCell

Returns:

null if no info available, otherwise short string

doExtractGroup

protected String doExtractGroup(Object obj)

Extracts the group from the object.

Overrides:

doExtractGroup in class SpreadSheetCell

Parameters:

obj - the object to process

Returns:

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