adams.flow.template
Class InstanceDumperVariable

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.template.AbstractActorTemplate
              adams.flow.template.InstanceDumperVariable

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<AbstractActorTemplate>, SizeOfHandler, Serializable

public class InstanceDumperVariable
extends AbstractActorTemplate

Generates a sub-flow that sets a variable for the adams.flow.transformer.WekaInstanceDumper transformer's outputPrefix property using a prefix based on the full flow name. In other words, the ARFF/CSV file will get generated in the same location as the flow.

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 new name for the actor; leave empty to use current.
    default: 
 

-variable <adams.core.VariableName> (property: variableName)
    The variable to be used for the 'outputPrefix' property.
    default: variable
 

Version:

$Revision: 5701 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected VariableName

m_VariableName the variable to update.

Fields inherited from class adams.flow.template.AbstractActorTemplate

m_Name

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

InstanceDumperVariable()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected AbstractActor	doGenerate() Generates the actor.
VariableName	getVariableName() Returns the variable name to generate the sub-flow for.
String	globalInfo() Returns a string describing the object.
void	setVariableName(VariableName value) Sets the variable name to generate the sub-flow for.
String	variableNameTipText() Returns the tip text for this property.

Methods inherited from class adams.flow.template.AbstractActorTemplate

compareTo, equals, forCommandLine, forName, generate, getBaselineCorrections, getName, nameTipText, postGenerate, preGenerate, setName, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

m_VariableName

protected VariableName m_VariableName

the variable to update.

Constructor Detail

InstanceDumperVariable

public InstanceDumperVariable()

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 AbstractActorTemplate

setVariableName

public void setVariableName(VariableName value)

Sets the variable name to generate the sub-flow for.

Parameters:

value - the variable

getVariableName

public VariableName getVariableName()

Returns the variable name to generate the sub-flow for.

Returns:

the variable

variableNameTipText

public String variableNameTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

doGenerate

protected AbstractActor doGenerate()

Generates the actor.

Specified by:

doGenerate in class AbstractActorTemplate

Returns:

the generated acto