weka.knowledgeflow.steps

Class ClassAssigner

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.ClassAssigner

All Implemented Interfaces:

java.io.Serializable, BaseStepExtender, Step

@KFStep(name="ClassAssigner",
        category="Evaluation",
        toolTipText="Designate which column is to be considered the class column in incoming data.",
        iconPath="weka/gui/knowledgeflow/icons/ClassAssigner.gif")
public class ClassAssigner
extends BaseStep

Knowledge Flow step for assigning a class attribute in incoming data

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_classAssigned True if the class has already been assigned
protected java.lang.String	m_classCol Holds user-specified class column/index
protected java.lang.String	m_classColumnS Holds resoved class column/index
protected boolean	m_isInstanceStream True if processing an instance stream
protected int	m_streamCount Counter used for streams

Fields inherited from class weka.knowledgeflow.steps.BaseStep

m_stepIsResourceIntensive, m_stepManager, m_stepName

Constructor Summary

Constructors

Constructor and Description
ClassAssigner()

Method Summary

Modifier and Type	Method and Description
protected void	assignClass(Instances dataSet) Assign the class to a set of instances
java.lang.String	getClassColumn() Get the class column to use
java.lang.String	getCustomEditorForStep() Get the custom editor for this step
java.util.List<java.lang.String>	getIncomingConnectionTypes() Get the incoming connections that this step can accept at this time
java.util.List<java.lang.String>	getOutgoingConnectionTypes() Get the outgoing connection types that this step can produce at this time
Instances	outputStructureForConnectionType(java.lang.String connectionName) Return the structure of data output by this step for a given incoming connection type
void	processIncoming(Data data) Process incoming data
void	setClassColumn(java.lang.String col) Set the class column to use
void	stepInit() Initialize the step prior to execution

Methods inherited from class weka.knowledgeflow.steps.BaseStep

environmentSubstitute, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop

Methods inherited from class java.lang.Object

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

Field Detail

m_classColumnS

protected java.lang.String m_classColumnS

Holds resoved class column/index

m_classCol

protected java.lang.String m_classCol

Holds user-specified class column/index

m_classAssigned

protected boolean m_classAssigned

True if the class has already been assigned

m_isInstanceStream

protected boolean m_isInstanceStream

True if processing an instance stream

m_streamCount

protected int m_streamCount

Counter used for streams

Constructor Detail

ClassAssigner

public ClassAssigner()

Method Detail

setClassColumn

public void setClassColumn(java.lang.String col)

Set the class column to use

Parameters:

col - the class column to use

getClassColumn

public java.lang.String getClassColumn()

Get the class column to use

Returns:

the class column to use

stepInit

public void stepInit()
              throws WekaException

Initialize the step prior to execution

Throws:

WekaException - if a problem occurs

processIncoming

public void processIncoming(Data data)
                     throws WekaException

Process incoming data

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

assignClass

protected void assignClass(Instances dataSet)
                    throws WekaException

Assign the class to a set of instances

Parameters:

dataSet - the instances to assign the class to

Throws:

WekaException - if a problem occurs

getIncomingConnectionTypes

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

Get the incoming connections that this step can accept at this time

Returns:

a list of incoming connection types that can be accepted

getOutgoingConnectionTypes

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

Get the outgoing connection types that this step can produce at this time

Returns:

a list of outgoing connections that can be produced

outputStructureForConnectionType

public Instances outputStructureForConnectionType(java.lang.String connectionName)
                                           throws WekaException

Return the structure of data output by this step for a given incoming connection type

Specified by:

outputStructureForConnectionType in interface Step

Overrides:

outputStructureForConnectionType in class BaseStep

Parameters:

connectionName - the incoming connection type

Returns:

the structure (header-only instances) of the output

Throws:

WekaException - if a problem occurs

getCustomEditorForStep

public java.lang.String getCustomEditorForStep()

Get the custom editor for this step

Specified by:

getCustomEditorForStep in interface Step

Overrides:

getCustomEditorForStep in class BaseStep

Returns:

the fully qualified class name of the clustom editor for this step