adams.flow.transformer
Class WekaClustering

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.AbstractProcessWekaInstanceWithModel<weka.clusterers.Clusterer>
                      adams.flow.transformer.WekaClustering

All Implemented Interfaces:

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

public class WekaClustering
extends AbstractProcessWekaInstanceWithModel<weka.clusterers.Clusterer>

Uses a serialized model to cluster data being passed through.
The model can also be obtained from a global actor, if the model file is pointing to a directory.

Input/output:
- accepts:
weka.core.Instance
- generates:
adams.flow.container.WekaClusteringContainer

Container information:
- adams.flow.container.WekaClusteringContainer:

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

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

-model <adams.core.io.PlaceholderFile> (property: modelFile)
    The model file to load (when not pointing to a directory).
    default: .
 

-model-actor <adams.flow.core.GlobalActorReference> (property: modelActor)
    The global actor to use for obtaining the model in case serialized model
    file points to a directory.
    default:
 

-on-the-fly (property: onTheFly)
    If set to true, the model file is not required to be present at set up time
    (eg if built on the fly), only at execution time.
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.transformer.AbstractProcessWekaInstanceWithModel

BACKUP_MODEL, m_Model, m_ModelActor, m_ModelFile, m_OnTheFly

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

WekaClustering()

Method Summary

Class[]	generates() Returns the class of objects that it generates.
String	globalInfo() Returns a string describing the object.
protected Token	processInstance(weka.core.Instance inst) Processes the instance and generates the output token.

Methods inherited from class adams.flow.transformer.AbstractProcessWekaInstanceWithModel

accepts, backupState, defineOptions, doExecute, getModelActor, getModelFile, getOnTheFly, getQuickInfo, modelActorTipText, modelFileTipText, onTheFlyTipText, pruneBackup, restoreState, setModelActor, setModelFile, setOnTheFly, setUp, setUpModel, wrapUp

Methods inherited from class adams.flow.transformer.AbstractTransformer

execute, hasPendingOutput, input, output, postExecute, reset

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

Constructor Detail

WekaClustering

public WekaClustering()

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

generates

public Class[] generates()

Returns the class of objects that it generates.

Specified by:

generates in interface OutputProducer

Specified by:

generates in class AbstractProcessWekaInstanceWithModel<weka.clusterers.Clusterer>

Returns:

adams.flow.container.WekaClusteringContainer.class

processInstance

protected Token processInstance(weka.core.Instance inst)
                         throws Exception

Processes the instance and generates the output token.

Specified by:

processInstance in class AbstractProcessWekaInstanceWithModel<weka.clusterers.Clusterer>

Parameters:

inst - the instance to process

Returns:

the generated output token (e.g., container)

Throws:

Exception - if processing fails