weka.knowledgeflow.steps

Class ExampleClassifier

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.ExampleClassifier

All Implemented Interfaces:

java.io.Serializable, BaseStepExtender, PairedDataHelper.PairedProcessor<Classifier>, Step

@KFStep(name="ExampleClassifier",
        category="Examples",
        toolTipText="A simple custom classifier processing example",
        iconPath="weka/gui/knowledgeflow/icons/DefaultClassifier.gif")
public class ExampleClassifier
extends BaseStep
implements PairedDataHelper.PairedProcessor<Classifier>

A simple paired processing example that trains and evaluates a classifier.

Version:

$Revision: $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

PairedDataHelper, PairedDataHelper.PairedProcessor, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExampleClassifier()

Method Summary

Modifier and Type	Method and Description
Classifier	getClassifier() Get the classifier to train/eval
java.util.List<java.lang.String>	getIncomingConnectionTypes() Incoming connections we can accept.
java.util.List<java.lang.String>	getOutgoingConnectionTypes() Outgoing connections we can produce
void	processIncoming(Data data) Process some incoming data (either train or test sets)
Classifier	processPrimary(java.lang.Integer setNum, java.lang.Integer maxSetNum, Data data, PairedDataHelper<Classifier> helper) Process training data
void	processSecondary(java.lang.Integer setNum, java.lang.Integer maxSetNum, Data data, PairedDataHelper<Classifier> helper) Process test data
void	setClassifier(Classifier classifier) Set the classifier to train/eval
void	stepInit() Initialize the step

Methods inherited from class weka.knowledgeflow.steps.BaseStep

environmentSubstitute, getCustomEditorForStep, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, outputStructureForConnectionType, setName, setStepIsResourceIntensive, setStepManager, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

ExampleClassifier

public ExampleClassifier()

Method Detail

setClassifier

@OptionMetadata(displayName="The classifier to use",
                description="The classifier to train")
public void setClassifier(Classifier classifier)

Set the classifier to train/eval

Parameters:

classifier - the classifier to use

getClassifier

public Classifier getClassifier()

Get the classifier to train/eval

Returns:

the classifier to use

stepInit

public void stepInit()
              throws WekaException

Initialize the step

Specified by:

stepInit in interface BaseStepExtender

Specified by:

stepInit in interface Step

Throws:

WekaException - if a problem occurs

getIncomingConnectionTypes

public java.util.List<java.lang.String> getIncomingConnectionTypes()

Incoming connections we can accept.

Specified by:

getIncomingConnectionTypes in interface BaseStepExtender

Specified by:

getIncomingConnectionTypes in interface Step

Returns:

the list of incoming connections that can be made given our current state

getOutgoingConnectionTypes

public java.util.List<java.lang.String> getOutgoingConnectionTypes()

Outgoing connections we can produce

Specified by:

getOutgoingConnectionTypes in interface BaseStepExtender

Specified by:

getOutgoingConnectionTypes in interface Step

Returns:

the list of outgoing connections we can produce given our current state

processIncoming

public void processIncoming(Data data)
                     throws WekaException

Process some incoming data (either train or test sets)

Specified by:

processIncoming in interface BaseStepExtender

Specified by:

processIncoming in interface Step

Overrides:

processIncoming in class BaseStep

Parameters:

data - the data to process

Throws:

WekaException - if a problem occurs

processPrimary

public Classifier processPrimary(java.lang.Integer setNum,
                                 java.lang.Integer maxSetNum,
                                 Data data,
                                 PairedDataHelper<Classifier> helper)
                          throws WekaException

Process training data

Specified by:

processPrimary in interface PairedDataHelper.PairedProcessor<Classifier>

Parameters:

setNum - the set number of this piece of training data

maxSetNum - the maximum set number in the batch

data - the data object containing the training data

helper - the PairedDataHelper to use

Returns:

a trained classifier

Throws:

WekaException - if a problem occurs

processSecondary

public void processSecondary(java.lang.Integer setNum,
                             java.lang.Integer maxSetNum,
                             Data data,
                             PairedDataHelper<Classifier> helper)
                      throws WekaException

Process test data

Specified by:

processSecondary in interface PairedDataHelper.PairedProcessor<Classifier>

Parameters:

setNum - the set number of this piece of test data

maxSetNum - the maximum set number in the batch

data - the data object containing the test data

helper - the PairedDataHelper to use

Throws:

WekaException - if a problem occurs