adams.flow.transformer
Class WekaExperiment

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

All Implemented Interfaces:

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

public class WekaExperiment
extends AbstractTransformer

Represents a Weka experiment, stored in a file. Can be setup from inside the flow.
Via the input port, additional datasets can be inserted into the experiment. This allows one to define a template experiment and then just run it over various datasets without every having to change the experiment setup itself.

Input/output:
- accepts:
adams.flow.core.Unknown
java.io.File
java.io.File[]
java.lang.String
java.lang.String[]
- generates:
weka.experiment.Experiment

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: Experiment
 

-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.
 

-file <adams.data.ExperimentFile> (property: experimentFile)
    The file the experiment is stored in.
    default: .
 

-no-check (property: noCheck)
    If set to true, the experiment file must not be present at setUp-time; necessary
    if file gets generated on-the-fly.
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected WekaExperimentFile	m_ExperimentFile the experiment file.
protected boolean	m_NoCheck whether not to check for experiment file to exist (e.g., when it generated on the fly).

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, 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

Constructor Summary

WekaExperiment()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
String	experimentFileTipText() Returns the tip text for this property.
Class[]	generates() Returns the class of objects that it generates.
WekaExperimentFile	getExperimentFile() Returns the file the experiment is stored in.
boolean	getNoCheck() Returns whether to avoid the check at setUp time whether the experiment file is present or not.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo() Returns a string describing the object.
String	noCheckTipText() Returns the tip text for this property.
void	setExperimentFile(WekaExperimentFile value) Sets the file the experiment is stored in.
void	setNoCheck(boolean value) Sets whether to avoid the check at setUp time whether the experiment file is present or not.
String	setUp() Initializes the item for flow execution.

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, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, 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

Field Detail

m_ExperimentFile

protected WekaExperimentFile m_ExperimentFile

the experiment file.

m_NoCheck

protected boolean m_NoCheck

whether not to check for experiment file to exist (e.g., when it generated on the fly).

Constructor Detail

WekaExperiment

public WekaExperiment()

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

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setExperimentFile

public void setExperimentFile(WekaExperimentFile value)

Sets the file the experiment is stored in.

Parameters:

value - the file

getExperimentFile

public WekaExperimentFile getExperimentFile()

Returns the file the experiment is stored in.

Returns:

the file

experimentFileTipText

public String experimentFileTipText()

Returns the tip text for this property.

Returns:

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

setNoCheck

public void setNoCheck(boolean value)

Sets whether to avoid the check at setUp time whether the experiment file is present or not.

Parameters:

value - true if the file need not be there

getNoCheck

public boolean getNoCheck()

Returns whether to avoid the check at setUp time whether the experiment file is present or not.

Returns:

true if the file need not be there

noCheckTipText

public String noCheckTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

adams.flow.core.Unknown.class, java.io.File.class, java.io.File[].class, java.lang.String.class, java.lang.String[].class

setUp

public String setUp()

Initializes the item for flow execution.

Overrides:

setUp in class AbstractActor

Returns:

null if everything is fine, otherwise error message

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

weka.experiment.Experiment.class