adams.flow.sink
Class ProbabilityPlotDisplay

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.core.AbstractDisplay
                  adams.flow.sink.AbstractDisplay
                      adams.flow.sink.AbstractGraphicalDisplay
                          adams.flow.sink.ProbabilityPlotDisplay

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, InputConsumer, ComponentSupplier, MenuBarProvider, SendToActionSupporter, Serializable, Comparable

public class ProbabilityPlotDisplay
extends AbstractGraphicalDisplay

Actor for displaying a probability plot

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

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

-width <int> (property: width)
    The width of the dialog.
    default: 900
    minimum: 1
 

-height <int> (property: height)
    The height of the dialog.
    default: 600
    minimum: 1
 

-x <int> (property: x)
    The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
    ).
    default: -1
    minimum: -3
 

-y <int> (property: y)
    The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
    ).
    default: -1
    minimum: -3
 

-writer <adams.gui.print.JComponentWriter> (property: writer)
    The writer to use for generating the graphics output.
    default: adams.gui.print.NullWriter
 

-regression <adams.gui.visualization.stats.paintlet.AbstractProbabilityPaintlet> (property: regression)
    Regression to display
    default: adams.gui.visualization.stats.paintlet.Normal
 

-grid (property: grid)
    Display a grid overlay
 

-regression-line (property: regressionLine)
    Display a best fit line overlay
 

-attribute-name <adams.core.base.BaseRegExp> (property: attributeName)
    Name of attribute to display, used if set,otherwise the index is used
    default:
 

-attribute <java.lang.String> (property: attribute)
    Set the attribute to display using an index, used only if regular expression
    not set
    default: last
 

Version:

$Revision: 6343 $

Author:

msf8

See Also:

Serialized Form

Field Summary

protected BaseRegExp	m_Att name of attribute to display
protected String	m_AttIndex Index of attribute to display
protected boolean	m_Grid Whether a grid overlay is drawn
protected ProbabilityPlot	m_Plot Probability plot to display
protected boolean	m_Regression Whether a best regression line is drawn
protected AbstractProbabilityPaintlet	m_Val Paintlet for plotting the data

Fields inherited from class adams.flow.sink.AbstractGraphicalDisplay

m_GraphicFileChooser, m_MenuBar, m_MenuItemFileClear, m_MenuItemFileClose, m_MenuItemFileSaveAs, m_MenuItemFileSaveTextAs, m_TextFileChooser, m_Writer

Fields inherited from class adams.flow.core.AbstractDisplay

BACKUP_INPUT, m_CreateFrame, m_Frame, m_Height, m_InputToken, m_Panel, m_ShortTitle, m_Updating, m_Width, m_X, m_Y

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, 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

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

ProbabilityPlotDisplay()

Method Summary

Class[]	accepts()
String	attributeNameTipText() Return a tip text for the attribute name property
String	attributeTipText() return a tip text for the attribute index property
void	clearPanel()
void	defineOptions()
protected void	display(Token token)
String	getAttribute() Get the string used to set the attribute using an index
BaseRegExp	getAttributeName() Get the string to set the attribute using a regular expression
protected int	getDefaultHeight()
protected int	getDefaultWidth()
boolean	getGrid() Get whether a grid overlay should be added
AbstractProbabilityPaintlet	getRegression() get the regression used to transform the data
boolean	getRegressionLine() Get whether a regression line should be added
String	globalInfo()
String	gridTipText() Tip text for the grid property
protected BasePanel	newPanel()
String	regressionLineTipText() Tip text for the regression line property
String	regressionTipText() Tip text for the regression property
void	setAttribute(String val) Set the string to use for setting the attribute using an index
void	setAttributeName(BaseRegExp val) Set the attribute to use with a regular expression
void	setGrid(boolean val) Set whether a grid overlay is added
void	setRegression(AbstractProbabilityPaintlet val) Set the regression used to transform the data
void	setRegressionLine(boolean val) Set whether a regression line overlay should be added

Methods inherited from class adams.flow.sink.AbstractGraphicalDisplay

cleanUpGUI, clear, close, createMenuBar, getGraphicFileChooser, getMenuBar, getSendToClasses, getSendToItem, getTextFileChooser, getWriter, hasPanel, hasSendToItem, postDisplay, preDisplay, saveAs, saveTextAs, setWriter, supplyComponent, supportsClear, updateMenu, writerTipText

Methods inherited from class adams.flow.sink.AbstractDisplay

newDisplayRunnable

Methods inherited from class adams.flow.core.AbstractDisplay

backupState, cleanUp, createFrame, createTitle, doCreateFrame, doExecute, getCreateFrame, getDefaultX, getDefaultY, getFrame, getHeight, getPanel, getQuickInfo, getShortTitle, getWidth, getX, getY, heightTipText, initialize, input, postCreateFrame, preCreateFrame, reset, restoreState, setCreateFrame, setHeight, setShortTitle, setWidth, setX, setY, shortTitleTipText, stopExecution, widthTipText, wrapUp, xTipText, yTipText

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, 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

Methods inherited from interface adams.flow.core.InputConsumer

input

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getQuickInfo, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_Plot

protected ProbabilityPlot m_Plot

Probability plot to display

m_Val

protected AbstractProbabilityPaintlet m_Val

Paintlet for plotting the data

m_Grid

protected boolean m_Grid

Whether a grid overlay is drawn

m_Regression

protected boolean m_Regression

Whether a best regression line is drawn

m_Att

protected BaseRegExp m_Att

name of attribute to display

m_AttIndex

protected String m_AttIndex

Index of attribute to display

Constructor Detail

ProbabilityPlotDisplay

public ProbabilityPlotDisplay()

Method Detail

accepts

public Class[] accepts()

clearPanel

public void clearPanel()

Specified by:

clearPanel in class AbstractDisplay

newPanel

protected BasePanel newPanel()

Specified by:

newPanel in class AbstractDisplay

display

protected void display(Token token)

Specified by:

display in class AbstractDisplay

defineOptions

public void defineOptions()

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractGraphicalDisplay

setAttribute

public void setAttribute(String val)

Set the string to use for setting the attribute using an index

Parameters:

val - String for the attribute index

getAttribute

public String getAttribute()

Get the string used to set the attribute using an index

Returns:

String for the index

attributeTipText

public String attributeTipText()

return a tip text for the attribute index property

Returns:

tip text for the property

setAttributeName

public void setAttributeName(BaseRegExp val)

Set the attribute to use with a regular expression

Parameters:

val - String for regular expression

getAttributeName

public BaseRegExp getAttributeName()

Get the string to set the attribute using a regular expression

Returns:

String for regular expression

attributeNameTipText

public String attributeNameTipText()

Return a tip text for the attribute name property

Returns:

tip text for the property

setGrid

public void setGrid(boolean val)

Set whether a grid overlay is added

Parameters:

val - true if grid overlay drawn

getGrid

public boolean getGrid()

Get whether a grid overlay should be added

Returns:

True if grid is to be added

gridTipText

public String gridTipText()

Tip text for the grid property

Returns:

String describing the property

setRegressionLine

public void setRegressionLine(boolean val)

Set whether a regression line overlay should be added

Parameters:

val - True if regression line added

getRegressionLine

public boolean getRegressionLine()

Get whether a regression line should be added

Returns:

true if regression line should be added

regressionLineTipText

public String regressionLineTipText()

Tip text for the regression line property

Returns:

String describing the property

setRegression

public void setRegression(AbstractProbabilityPaintlet val)

Set the regression used to transform the data

Parameters:

val - Paintlet for the regression

getRegression

public AbstractProbabilityPaintlet getRegression()

get the regression used to transform the data

Returns:

Paintlet used for the regression

regressionTipText

public String regressionTipText()

Tip text for the regression property

Returns:

String describing the property

globalInfo

public String globalInfo()

Specified by:

globalInfo in class AbstractOptionHandler

getDefaultHeight

protected int getDefaultHeight()

Overrides:

getDefaultHeight in class AbstractDisplay

getDefaultWidth

protected int getDefaultWidth()

Overrides:

getDefaultWidth in class AbstractDisplay