org.imirsel.m2k.util
Class AddIntMetadataToSignal

java.lang.Object
  java.util.Observable
      ncsa.d2k.core.modules.RootModule
          ncsa.d2k.core.modules.ConfigurableModule
              ncsa.d2k.core.modules.EmbeddedPipeModule
                  ncsa.d2k.core.modules.ExecModule
                      ncsa.d2k.core.modules.IOModule
                          ncsa.d2k.core.modules.DataPrepModule
                              org.imirsel.m2k.util.AddIntMetadataToSignal

All Implemented Interfaces:

java.lang.Cloneable, ncsa.d2k.core.modules.Module, java.io.Serializable, ncsa.d2k.core.modules.SystemModule

public class AddIntMetadataToSignal

extends ncsa.d2k.core.modules.DataPrepModule

Adds the input Integer to the input Signal's metadata hashmap

Author:

kw

See Also:

Serialized Form

Field Summary

Fields inherited from class ncsa.d2k.core.modules.ConfigurableModule

addedInputInfo, addedInputNames, addedInputTypes, addedOutputInfo, addedOutputNames, addedOutputTypes, addPortListeners

Fields inherited from class ncsa.d2k.core.modules.RootModule

alias, children, DEBUG_LEVEL, EMPTY_INPUT, ERROR_LEVEL, executionManager, FATAL_LEVEL, HAVE_INPUT, INFO_LEVEL, iPipes, iPipesIndex, iTriggers, oPipes, oPipesIndex, oTriggers, parents, pipesFullManager, stats, triggerChildren, triggerParents, WARN_LEVEL

Fields inherited from interface ncsa.d2k.core.modules.SystemModule

BLOCKED_STATE, IDLE_STATE, MEDIUM, MEDIUM_RARE, MEDIUM_WELL, RARE, READY_STATE, WELL, WORKING_STATE

Constructor Summary

AddIntMetadataToSignal()
Creates a new instance of AddIntMetadataToSignal

Method Summary

void	beginExecution() Clears variable before execution of any itinery containing this module
protected void	doit() Adds the input Integer to the input Signal's metadata hashmap
boolean	getForwardNulls() Returns the flag which determines whether nulls received as input are fowarded
java.lang.String	getInputInfo(int param) Returns a text description for the indicated input
java.lang.String	getInputName(int i) Returns a text name for the indicated inoutput
java.lang.String[]	getInputTypes() Returns an array of strings containing the Java data types of the input.
java.lang.String	getKey() Returns the key used store the new metadata under in the Signal object
java.lang.String	getModuleInfo() Returns information about the module
java.lang.String	getOutputInfo(int param) Returns a text description for the indicated output
java.lang.String	getOutputName(int i) Returns a text name for the indicated output
java.lang.String[]	getOutputTypes() Returns an array of strings containing the Java data types of the output.
ncsa.d2k.core.modules.PropertyDescription[]	getPropertiesDescriptions() Returns a description of each property
boolean	isReady() Controls whether the module can run based on the input flags
void	setForwardNulls(boolean val) Sets a flag which determines whether nulls received as input are fowarded
void	setKey(java.lang.String val) Sets the key used store the new metadata under in the Signal object

Methods inherited from class ncsa.d2k.core.modules.ExecModule

execute, setExecutionManager

Methods inherited from class ncsa.d2k.core.modules.ConfigurableModule

addAddPortListener, addInput, addInputTrigger, addOutput, addOutputTrigger, getAddedInputTypes, getAddedOutputTypes, getAddPortListeners, insertInput, insertOutput, removeAddPortListener, removeInput, removeInputTrigger, removeOutput, removeOutputTrigger, setAddedInputTypes, setInputType, setOutputType

Methods inherited from class ncsa.d2k.core.modules.RootModule

activateTriggers, begin, canRun, clone, debug, debug, disconnectInputPipe, disconnectInputTriggers, disconnectOutputPipe, disconnectOutputTriggers, end, endExecution, error, error, fatal, fatal, fetchInputs, getAlias, getChildIndex, getChildMux, getChildren, getExecutionManager, getFile, getFlags, getFullPipeManager, getGuiComponent, getImage, getInputPipes, getInputPipeSize, getInputTriggers, getModuleName, getModuleStatistics, getNumInputs, getNumOutputs, getOutputCounts, getOutputPipes, getOutputPipeSize, getOutputTriggers, getParentIndex, getParentMux, getParents, getPipesFull, getPriority, getPropertyEditor, getResource, getRootName, getState, info, info, initModule, isAborting, isHead, isInputPipeConnected, isOutputPipeConnected, pullInput, pushOutput, resetInputs, setAlias, setBlocked, setD2KModulesLoggingLevel, setFlags, setFullPipeManager, setIdle, setInputPipe, setLogLevel, setModuleStatistics, setModuleStatisticsByMachine, setOutputCounts, setOutputPipe, setPipesFull, setReady, setResource, setState, setThePriority, setWorking, trigger, triggersActivated, warn, warn

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddIntMetadataToSignal

public AddIntMetadataToSignal()

Creates a new instance of AddIntMetadataToSignal

Method Detail

getKey

public java.lang.String getKey()

Returns the key used store the new metadata under in the Signal object

Returns:

the key used store the new metadata under in the Signal object

setKey

public void setKey(java.lang.String val)

Sets the key used store the new metadata under in the Signal object

Parameters:

val - the key used store the new metadata under in the Signal object

setForwardNulls

public void setForwardNulls(boolean val)

Sets a flag which determines whether nulls received as input are fowarded

Parameters:

val - the flag

getForwardNulls

public boolean getForwardNulls()

Returns the flag which determines whether nulls received as input are fowarded

Returns:

the flag

getPropertiesDescriptions

public ncsa.d2k.core.modules.PropertyDescription[] getPropertiesDescriptions()

Returns a description of each property

Returns:

An array containing a description of each property

isReady

public boolean isReady()

Controls whether the module can run based on the input flags

Returns:

a flag indicating whether the module is ready

beginExecution

public void beginExecution()

Clears variable before execution of any itinery containing this module

doit

protected void doit()
             throws java.lang.Exception

Adds the input Integer to the input Signal's metadata hashmap

Throws:

java.lang.Exception - If an error occurs.

getInputInfo

public java.lang.String getInputInfo(int param)

Returns a text description for the indicated input

Parameters:

param - the index of the input

Returns:

a text description of the indexed input

getInputTypes

public java.lang.String[] getInputTypes()

Returns an array of strings containing the Java data types of the input.

Returns:

the fully qualified java types for each of the inputs

getInputName

public java.lang.String getInputName(int i)

Returns a text name for the indicated inoutput

Parameters:

i - the index of the input

Returns:

the name of the indexed input

getModuleInfo

public java.lang.String getModuleInfo()

Returns information about the module

Returns:

Module information

getOutputInfo

public java.lang.String getOutputInfo(int param)

Returns a text description for the indicated output

Parameters:

param - the index of the output

Returns:

a text description of the indexed output

getOutputTypes

public java.lang.String[] getOutputTypes()

Returns an array of strings containing the Java data types of the output.

Returns:

the fully qualified java types for each of the outputs

getOutputName

public java.lang.String getOutputName(int i)

Returns a text name for the indicated output

Parameters:

i - the index of the output

Returns:

the name of the indexed output