Package weka.knowledgeflow.steps
Class AttributeSummarizer
java.lang.Object
weka.knowledgeflow.steps.BaseStep
weka.knowledgeflow.steps.BaseSimpleDataVisualizer
weka.knowledgeflow.steps.AttributeSummarizer
- All Implemented Interfaces:
Serializable
,BaseStepExtender
,DataCollector
,Step
@KFStep(name="AttributeSummarizer",
category="Visualization",
toolTipText="Visualize datasets in a matrix of histograms",
iconPath="weka/gui/knowledgeflow/icons/AttributeSummarizer.gif")
public class AttributeSummarizer
extends BaseSimpleDataVisualizer
Step that collects data to display in a summary overview of attribute
distributions
- Version:
- $Revision: $
- Author:
- Mark Hall (mhall{[at]}pentaho{[dot]}com)
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the fully qualified class name of the custom editor for this stepGet a map of popup viewers that can be used with this stepGet the additional options for the offscreen rendererGet the height (in pixels) of the offscreen image to generateGet the name of the renderer to use for offscreen chart rendering operationsGet the width (in pixels) of the offscreen image to generate.Get the name of the attribute for the x-axis in offscreen plotsGet a list of outgoing connections that this step can produce at this timevoid
processIncoming
(Data data) Process incoming datavoid
setOffscreenAdditionalOpts
(String additional) Set the additional options for the offscreen renderervoid
setOffscreenHeight
(String height) Set the height (in pixels) of the offscreen image to generatevoid
setOffscreenRendererName
(String rendererName) Set the name of the renderer to use for offscreen chart rendering operationsvoid
setOffscreenWidth
(String width) Set the width (in pixels) of the offscreen image to generate.void
setOffscreenXAxis
(String xAxis) Set the name of the attribute for the x-axis in offscreen plots.Methods inherited from class weka.knowledgeflow.steps.BaseSimpleDataVisualizer
getDatasets, getIncomingConnectionTypes, restoreData, retrieveData, stepInit
Methods inherited from class weka.knowledgeflow.steps.BaseStep
environmentSubstitute, getDefaultSettings, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, outputStructureForConnectionType, outputStructureForConnectionType, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop
-
Constructor Details
-
AttributeSummarizer
public AttributeSummarizer()
-
-
Method Details
-
setOffscreenXAxis
@OptionMetadata(displayName="X-axis attribute", description="Attribute name or /first, /last or /<index>", displayOrder=1) public void setOffscreenXAxis(String xAxis) Set the name of the attribute for the x-axis in offscreen plots. This defaults to "False Positive Rate" for threshold curves if not specified.- Parameters:
xAxis
- the name of the xAxis
-
getOffscreenXAxis
Get the name of the attribute for the x-axis in offscreen plots- Returns:
- the name of the xAxis
-
setOffscreenWidth
@OptionMetadata(displayName="Chart width (pixels)", description="Width of the rendered chart", displayOrder=2) public void setOffscreenWidth(String width) Set the width (in pixels) of the offscreen image to generate.- Parameters:
width
- the width in pixels.
-
getOffscreenWidth
Get the width (in pixels) of the offscreen image to generate.- Returns:
- the width in pixels.
-
setOffscreenHeight
@OptionMetadata(displayName="Chart height (pixels)", description="Height of the rendered chart", displayOrder=3) public void setOffscreenHeight(String height) Set the height (in pixels) of the offscreen image to generate- Parameters:
height
- the height in pixels
-
getOffscreenHeight
Get the height (in pixels) of the offscreen image to generate- Returns:
- the height in pixels
-
setOffscreenRendererName
Set the name of the renderer to use for offscreen chart rendering operations- Parameters:
rendererName
- the name of the renderer to use
-
getOffscreenRendererName
Get the name of the renderer to use for offscreen chart rendering operations- Returns:
- the name of the renderer to use
-
setOffscreenAdditionalOpts
Set the additional options for the offscreen renderer- Parameters:
additional
- additional options
-
getOffscreenAdditionalOpts
Get the additional options for the offscreen renderer- Returns:
- the additional options
-
processIncoming
Process incoming data- Specified by:
processIncoming
in interfaceBaseStepExtender
- Specified by:
processIncoming
in interfaceStep
- Overrides:
processIncoming
in classBaseSimpleDataVisualizer
- Parameters:
data
- the data to process
-
getInteractiveViewers
Get a map of popup viewers that can be used with this step- Specified by:
getInteractiveViewers
in interfaceStep
- Overrides:
getInteractiveViewers
in classBaseStep
- Returns:
- a map of popup viewers
-
getOutgoingConnectionTypes
Get a list of outgoing connections that this step can produce at this time- Specified by:
getOutgoingConnectionTypes
in interfaceBaseStepExtender
- Specified by:
getOutgoingConnectionTypes
in interfaceStep
- Overrides:
getOutgoingConnectionTypes
in classBaseSimpleDataVisualizer
- Returns:
- a list of outgoing connection types
-
getCustomEditorForStep
Get the fully qualified class name of the custom editor for this step- Specified by:
getCustomEditorForStep
in interfaceStep
- Overrides:
getCustomEditorForStep
in classBaseStep
- Returns:
- the class name of the custom editor for this step
-