adams.flow.transformer
Class LookUpInit

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.AbstractSpreadSheetTransformer
                      adams.flow.transformer.LookUpInit

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public class LookUpInit
extends AbstractSpreadSheetTransformer

Creates a lookup table from a spreadsheet, using one column as key and another one as value. The lookup table itself gets stored in the internal storage under the specified name.

Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
adams.data.spreadsheet.SpreadSheet

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: LookUpInit
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-storage-name <adams.flow.control.StorageName> (property: storageName)
    The name for the lookup table in the internal storage.
    default: lookup
 

-key-column <adams.core.Index> (property: keyColumn)
    The index of the column in the spreadsheet to use as key; An index is a 
    number starting with 1; the following placeholders can be used as well: 
    first, second, third, last_2, last_1, last
    default: 1
 

-value-column <adams.core.Index> (property: valueColumn)
    The index of the column in the spreadsheet to use as value; An index is 
    a number starting with 1; the following placeholders can be used as well:
     first, second, third, last_2, last_1, last
    default: 2
 

Version:

$Revision: 6529 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected Index	m_KeyColumn the index of the column to use as key.
protected StorageName	m_StorageName the name of the lookup table in the internal storage.
protected Index	m_ValueColumn the index of the column to use as value.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

LookUpInit()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
Index	getKeyColumn() Returns the index of the column to act as key in the lookup table.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
StorageName	getStorageName() Returns the name for the lookup table in the internal storage.
Index	getValueColumn() Returns the index of the column to act as value in the lookup table.
String	globalInfo() Returns a string describing the object.
String	keyColumnTipText() Returns the tip text for this property.
void	setKeyColumn(Index value) Sets the index of the column to act as key in the lookup table.
void	setStorageName(StorageName value) Sets the name for the lookup table in the internal storage.
void	setValueColumn(Index value) Sets the index of the column to act as value in the lookup table.
String	storageNameTipText() Returns the tip text for this property.
String	valueColumnTipText() Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.AbstractSpreadSheetTransformer

accepts, generates

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, hasPendingOutput, input, output, postExecute, reset, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, debug, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_StorageName

protected StorageName m_StorageName

the name of the lookup table in the internal storage.

m_KeyColumn

protected Index m_KeyColumn

the index of the column to use as key.

m_ValueColumn

protected Index m_ValueColumn

the index of the column to use as value.

Constructor Detail

LookUpInit

public LookUpInit()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

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 AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in interface Actor

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setStorageName

public void setStorageName(StorageName value)

Sets the name for the lookup table in the internal storage.

Parameters:

value - the name

getStorageName

public StorageName getStorageName()

Returns the name for the lookup table in the internal storage.

Returns:

the name

storageNameTipText

public String storageNameTipText()

Returns the tip text for this property.

Returns:

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

setKeyColumn

public void setKeyColumn(Index value)

Sets the index of the column to act as key in the lookup table.

Parameters:

value - the index

getKeyColumn

public Index getKeyColumn()

Returns the index of the column to act as key in the lookup table.

Returns:

the index

keyColumnTipText

public String keyColumnTipText()

Returns the tip text for this property.

Returns:

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

setValueColumn

public void setValueColumn(Index value)

Sets the index of the column to act as value in the lookup table.

Parameters:

value - the index

getValueColumn

public Index getValueColumn()

Returns the index of the column to act as value in the lookup table.

Returns:

the index

valueColumnTipText

public String valueColumnTipText()

Returns the tip text for this property.

Returns:

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

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message