adams.flow.source
Class WekaClustererGenerator

java.lang.Object
  extended by adams.core.ConsoleObject
      extended by adams.core.option.AbstractOptionHandler
          extended by adams.flow.core.AbstractActor
              extended by adams.flow.source.AbstractSource
                  extended by adams.flow.source.AbstractWekaSetupGenerator<weka.clusterers.Clusterer>
                      extended by adams.flow.source.WekaClustererGenerator
All Implemented Interfaces:
AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, OutputProducer, Serializable, Comparable

public class WekaClustererGenerator
extends AbstractWekaSetupGenerator<weka.clusterers.Clusterer>

Generates multiple clusterer setups.

Input/output:
- generates:
   weka.clusterers.Clusterer

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: ClustererGenerator
 
-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.
 
-setup <java.lang.Object [options]> (property: setup)
    The base clusterer to use for the setups.
    default: weka.clusterers.SimpleKMeans -N 2 -A \"weka.core.EuclideanDistance -R first-last\" -I 500 -S 10
 
-parameter <weka.core.setupgenerator.AbstractParameter [options]> [-parameter ...] (property: parameters)
    The parameters to use for generating the setups.
    default: weka.core.setupgenerator.MathParameter -property numClusters -min 2.0 -max 5.0 -step 1.0 -base 10.0 -expression I
 
-array (property: outputArray)
    If set to true, then an array of setups will be output instead of a sequence.
 

Version:
$Revision: 4584 $
Author:
fracpete (fracpete at waikato dot ac dot nz)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class adams.flow.source.AbstractWekaSetupGenerator
m_Generator, m_OutputArray, m_Setups
 
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
WekaClustererGenerator()
           
 
Method Summary
protected  AbstractParameter[] getDefaultParameters()
          Returns the default parameters.
protected  weka.clusterers.Clusterer getDefaultSetup()
          Returns the default setup.
protected  Class getDefaultSuperClass()
          Returns the default super class, the same as the type "T" when defining the generics.
 weka.clusterers.Clusterer getSetup()
          Returns the base clusterer.
 String globalInfo()
          Returns a string describing the object.
 void setSetup(weka.clusterers.Clusterer value)
          Sets the base clusterer.
 String setupTipText()
          Returns the tip text for this property.
 
Methods inherited from class adams.flow.source.AbstractWekaSetupGenerator
defineOptions, doExecute, generates, getDefaultPackage, getOutputArray, getParameters, getQuickInfo, hasPendingOutput, initialize, output, outputArrayTipText, parametersTipText, setOutputArray, setParameters, wrapUp
 
Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, execute, 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, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, reset, restoreState, 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
 

Constructor Detail

WekaClustererGenerator

public WekaClustererGenerator()
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

getDefaultSetup

protected weka.clusterers.Clusterer getDefaultSetup()
Returns the default setup. Used in the options as default value.

Specified by:
getDefaultSetup in class AbstractWekaSetupGenerator<weka.clusterers.Clusterer>
Returns:
the default setup
See Also:
AbstractWekaSetupGenerator.defineOptions()

getDefaultParameters

protected AbstractParameter[] getDefaultParameters()
Returns the default parameters. Used in the options as default value.

Specified by:
getDefaultParameters in class AbstractWekaSetupGenerator<weka.clusterers.Clusterer>
Returns:
the default parameters
See Also:
AbstractWekaSetupGenerator.defineOptions()

getDefaultSuperClass

protected Class getDefaultSuperClass()
Returns the default super class, the same as the type "T" when defining the generics.

Specified by:
getDefaultSuperClass in class AbstractWekaSetupGenerator<weka.clusterers.Clusterer>
Returns:
the default super class

setSetup

public void setSetup(weka.clusterers.Clusterer value)
Sets the base clusterer.

Parameters:
value - the clusterer

getSetup

public weka.clusterers.Clusterer getSetup()
Returns the base clusterer.

Returns:
the clusterer

setupTipText

public String setupTipText()
Returns the tip text for this property.

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


Copyright © 2012 University of Waikato, Hamilton, NZ. All Rights Reserved.