Package weka.knowledgeflow.steps

Class CostBenefitAnalysis

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.BaseSimpleDataVisualizer

weka.knowledgeflow.steps.CostBenefitAnalysis

All Implemented Interfaces:

java.io.Serializable, BaseStepExtender, DataCollector, Step

@KFStep(name="CostBenefitAnalysis",
        category="Visualization",
        toolTipText="View threshold data in an interactive cost-benefit visualization",
        iconPath="weka/gui/knowledgeflow/icons/ModelPerformanceChart.gif")
public class CostBenefitAnalysis
extends BaseSimpleDataVisualizer

Step for storing and viewing threshold data in a cost-benefit visualization

Version:

$Revision: $

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CostBenefitAnalysis()

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getIncomingConnectionTypes()	Get a list of incoming connection types that this step can accept at this time
java.util.Map<java.lang.String,java.lang.String>	getInteractiveViewers()	When running in a graphical execution environment a step can make one or more popup Viewer components available.
void	processIncoming(Data data)	Process an incoming data payload (if the step accepts incoming connections)

Methods inherited from class weka.knowledgeflow.steps.BaseSimpleDataVisualizer

getDatasets, getOutgoingConnectionTypes, restoreData, retrieveData, stepInit

Methods inherited from class weka.knowledgeflow.steps.BaseStep

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CostBenefitAnalysis

public CostBenefitAnalysis()

Method Detail

getIncomingConnectionTypes

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

Description copied from class: BaseSimpleDataVisualizer

Get a list of incoming connection types that this step can accept at this time

Specified by:

getIncomingConnectionTypes in interface BaseStepExtender

Specified by:

getIncomingConnectionTypes in interface Step

Overrides:

getIncomingConnectionTypes in class BaseSimpleDataVisualizer

Returns:

a list of incoming connection types

processIncoming

public void processIncoming(Data data)

Process an incoming data payload (if the step accepts incoming connections)

Specified by:

processIncoming in interface BaseStepExtender

Specified by:

processIncoming in interface Step

Overrides:

processIncoming in class BaseSimpleDataVisualizer

Parameters:

data - the payload to process

getInteractiveViewers

public java.util.Map<java.lang.String,java.lang.String> getInteractiveViewers()

When running in a graphical execution environment a step can make one or more popup Viewer components available. These might be used to display results, graphics etc. Returning null indicates that the step has no such additional graphical views. The map returned by this method should be keyed by action name (e.g. "View results"), and values should be fully qualified names of the corresponding StepInteractiveView implementation. Furthermore, the contents of this map can (and should) be dependent on whether a particular viewer should be made available - i.e. if execution hasn't occurred yet, or if a particular incoming connection type is not present, then it might not be possible to view certain results. Viewers can implement StepInteractiveView directly (in which case they need to extends JPanel), or extends the AbstractInteractiveViewer class. The later extends JPanel, uses a BorderLayout, provides a "Close" button and a method to add additional buttons.

Specified by:

getInteractiveViewers in interface Step

Overrides:

getInteractiveViewers in class BaseStep

Returns:

a map of viewer component names, or null if this step has no graphical views