adams.flow.sink
Class FourInOneDisplay

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

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 FourInOneDisplay
extends AbstractGraphicalDisplay

Actor for displaying a four-in-one plot. Contains a histogram, a normal probability plot, vs fit plot and vs order 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: FourInOneDisplay
 

-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: 1200
    minimum: 1
 

-height <int> (property: height)
    The height of the dialog.
    default: 750
    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
 

-actual-attribute <java.lang.String> (property: actualAttribute)
    1-based index of the actual attribute
    default: 1
 

-predicted-attribute <java.lang.String> (property: predictedAttribute)
    1-based index of the predicted attribute
    default: 2
 

-normal-plot-options <adams.gui.visualization.stats.probabilityplot.NormalPlotOptions> (property: normalPlotOptions)
    options for normal plot
    default: adams.gui.visualization.stats.probabilityplot.NormalPlotOptions
 

-versus-fit-options <adams.gui.visualization.stats.fourinone.VersusFitOptions> (property: versusFitOptions)
    options for the versus fit graph
    default: adams.gui.visualization.stats.fourinone.VersusFitOptions -paintlet adams.gui.visualization.stats.paintlet.VsFitPaintlet
 

-histogram-options <adams.gui.visualization.stats.histogram.HistogramOptions> (property: histogramOptions)
    options for the histogram graph
    default: adams.gui.visualization.stats.histogram.HistogramOptions -paintlet adams.gui.visualization.stats.paintlet.HistogramPaintlet
 

-versus-order-options <adams.gui.visualization.stats.fourinone.VersusOrderOptions> (property: versusOrderOptions)
    options for the versus order graph
    default: adams.gui.visualization.stats.fourinone.VersusOrderOptions -paintlet adams.gui.visualization.stats.paintlet.VsOrderPaintlet
 

Version:

$Revision: 4584 $

Author:

msf8

See Also:

Serialized Form

Field Summary

protected String	m_Act the 0-based index of the actual attribute.
protected HistogramOptions	m_HistogramOptions Options for the histogram
protected NormalPlotOptions	m_NormalPlotOptions options for the normal plot
protected FourInOne	m_Plot panel to display the actor
protected String	m_pred the 0-based index of the predicted attribute.
protected VersusFitOptions	m_VersusFitOptions Options for the vs fit
protected VersusOrderOptions	m_VersusOrderOptions Options for the vs order

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

FourInOneDisplay()

Method Summary

Class[]	accepts()
String	actualAttributeTipText() Tip text for the actual attribute property
void	clearPanel()
void	defineOptions()
protected void	display(Token token)
String	getActualAttribute() Get the string used for the index for the actual attribute
protected int	getDefaultHeight()
protected int	getDefaultWidth()
HistogramOptions	getHistogramOptions() Get the options for the histogram
NormalPlotOptions	getNormalPlotOptions() get the options for the normal plot
String	getPredictedAttribute() Get the string used for the index for the predicted attribute
VersusFitOptions	getVersusFitOptions() Get the options for the vsfit plot
VersusOrderOptions	getVersusOrderOptions() Get the options for the vsorder plot
String	globalInfo()
String	histogramOptionsTipText() Tip text for the histogram options property
protected BasePanel	newPanel()
String	normalPlotOptionsTipText() tip text for the normalplot options property
String	predictedAttributeTipText() Tip text for the predicted attribute property
void	setActualAttribute(String val) Set the string to use as an index for the actual attribute
void	setHistogramOptions(HistogramOptions val) Set the options for the histogram
void	setNormalPlotOptions(NormalPlotOptions val) Set the options for the normal plot
void	setPredictedAttribute(String val) Set the string to use as an index for the predicted attribute
void	setVersusFitOptions(VersusFitOptions val) Set the options for the vsfit plot
void	setVersusOrderOptions(VersusOrderOptions val) Set the options for the vs order plot
String	versusFitOptionsTipText() Tip text for the vs fit options property
String	versusOrderOptionsTipText() Tip text for the vsorder options property

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 FourInOne m_Plot

panel to display the actor

m_NormalPlotOptions

protected NormalPlotOptions m_NormalPlotOptions

options for the normal plot

m_HistogramOptions

protected HistogramOptions m_HistogramOptions

Options for the histogram

m_VersusFitOptions

protected VersusFitOptions m_VersusFitOptions

Options for the vs fit

m_VersusOrderOptions

protected VersusOrderOptions m_VersusOrderOptions

Options for the vs order

m_Act

protected String m_Act

the 0-based index of the actual attribute.

m_pred

protected String m_pred

the 0-based index of the predicted attribute.

Constructor Detail

FourInOneDisplay

public FourInOneDisplay()

Method Detail

accepts

public Class[] accepts()

defineOptions

public void defineOptions()

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractGraphicalDisplay

setActualAttribute

public void setActualAttribute(String val)

Set the string to use as an index for the actual attribute

Parameters:

val - String for the index

getActualAttribute

public String getActualAttribute()

Get the string used for the index for the actual attribute

Returns:

String for the index

actualAttributeTipText

public String actualAttributeTipText()

Tip text for the actual attribute property

Returns:

String describing the property

setPredictedAttribute

public void setPredictedAttribute(String val)

Set the string to use as an index for the predicted attribute

Parameters:

val - String for the index

getPredictedAttribute

public String getPredictedAttribute()

Get the string used for the index for the predicted attribute

Returns:

String for the index

predictedAttributeTipText

public String predictedAttributeTipText()

Tip text for the predicted attribute property

Returns:

String describing the property

setHistogramOptions

public void setHistogramOptions(HistogramOptions val)

Set the options for the histogram

Parameters:

val - Histogramoptions object containing the options

getHistogramOptions

public HistogramOptions getHistogramOptions()

Get the options for the histogram

Returns:

Histogramoptions object containing the options for the histogram

histogramOptionsTipText

public String histogramOptionsTipText()

Tip text for the histogram options property

Returns:

String describing the property

setVersusOrderOptions

public void setVersusOrderOptions(VersusOrderOptions val)

Set the options for the vs order plot

Parameters:

val - Versusorderoptions object containing the options

getVersusOrderOptions

public VersusOrderOptions getVersusOrderOptions()

Get the options for the vsorder plot

Returns:

Versusorder object containing the options

versusOrderOptionsTipText

public String versusOrderOptionsTipText()

Tip text for the vsorder options property

Returns:

String describing the property

setVersusFitOptions

public void setVersusFitOptions(VersusFitOptions val)

Set the options for the vsfit plot

Parameters:

val - Vsfiroptions object containing the options

getVersusFitOptions

public VersusFitOptions getVersusFitOptions()

Get the options for the vsfit plot

Returns:

vsfitoptions object containing the options

versusFitOptionsTipText

public String versusFitOptionsTipText()

Tip text for the vs fit options property

Returns:

String describing the property

setNormalPlotOptions

public void setNormalPlotOptions(NormalPlotOptions val)

Set the options for the normal plot

Parameters:

val - Normalplotoptions object containing the options

getNormalPlotOptions

public NormalPlotOptions getNormalPlotOptions()

get the options for the normal plot

Returns:

Normalplotoptions object containing the options

normalPlotOptionsTipText

public String normalPlotOptionsTipText()

tip text for the normalplot options property

Returns:

String describing the property

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

getDefaultWidth

protected int getDefaultWidth()

Overrides:

getDefaultWidth in class AbstractDisplay

getDefaultHeight

protected int getDefaultHeight()

Overrides:

getDefaultHeight in class AbstractDisplay

globalInfo

public String globalInfo()

Specified by:

globalInfo in class AbstractOptionHandler