adams.flow.sink
Class ScatterDisplay

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

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

Actor for displaying a scatter 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: ScatterDisplay
 

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

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

-x-attribute-name <adams.core.base.BaseRegExp> (property: xAttributeName)
    Attribute for x axis using regular expression used if set, otherwise the
    index is used
    default:
 

-y-attribute-name <adams.core.base.BaseRegExp> (property: yAttributeName)
    Attribute for y axis using regular expression used if set,otherwise the
    index is used
    default:
 

-x-attribute <java.lang.String> (property: xAttribute)
    Index of attribute to display on x axis, used onlyif regular expression
    not set
    default: 1
 

-y-attribute <java.lang.String> (property: yAttribute)
    index of attribute to display on y axis, used only ifregular expression
    not set
    default: 1
 

-overlay <adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay> [-overlay ...] (property: overlays)
    add overlays to the scatterplot
    default:
 

-paintlet <adams.gui.visualization.stats.paintlet.AbstractScatterPlotPaintlet> (property: paintlet)
    Paintlet for plotting data
    default: adams.gui.visualization.stats.paintlet.ScatterPaintletCircle
 

Version:

$Revision: 5502 $

Author:

msf8

See Also:

Serialized Form

Field Summary

protected AbstractScatterPlotOverlay[]	m_Overlays Array containing scatter plot overlays
protected AbstractScatterPlotPaintlet	m_Paintlet Paintlet to draw original data with
protected ScatterPlot	m_ScatPlot scatter panel to display using the actor
protected String	m_XAttribute the 0-based index of the X attribute.
protected BaseRegExp	m_XAttributeName String for setting x attribute using regular expression
protected String	m_YAttribute the 0-based index of the Y attribute.
protected BaseRegExp	m_YAttributeName String for setting y attribute using regular expression

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

ScatterDisplay()

Method Summary

Class[]	accepts()
void	clearPanel()
void	defineOptions() Adds options to the internal list of options.
protected void	display(Token token) Displays the token (the panel and dialog have already been created at this stage).
protected int	getDefaultHeight()
protected int	getDefaultWidth()
AbstractScatterPlotOverlay[]	getOverlays() Get the overlays to be drawn on the scatter plot
AbstractScatterPlotPaintlet	getPaintlet() get the paintlet used to draw the data with
String	getXAttribute() Get the index of the attribute displayed on the x axis
BaseRegExp	getXAttributeName() Returns the regular expression for the attribute to be displayed on the x axis
String	getYAttribute() Get the index of the attribute displayed on the y axis
BaseRegExp	getYAttributeName() Returns the attribute to be displayed on the y axis
String	globalInfo()
protected BasePanel	newPanel()
String	overlaysTipText() Returns the tip text for the overlays property.
String	paintletTipText() Returns the tip text for the paintlet property
void	setOverlays(AbstractScatterPlotOverlay[] over) Set the overlays to be drawn on the scatter plot
void	setPaintlet(AbstractScatterPlotPaintlet pain) Set the paintlet to draw the data points with
void	setXAttribute(String val) Sets the index of the attribute to display on x axis
void	setXAttributeName(BaseRegExp val) Set the x attribute on the scatter plot using a regular expression
void	setYAttribute(String val) Set the attribute to be displayed on the y axis using an index
void	setYAttributeName(BaseRegExp val) Set the y attribute on the scatter plot using a regular expression
String	xAttributeNameTipText() Tip text to display for x attribute regular expression
String	xAttributeTipText() Returns the tip text for x attribute set using index.
String	yAttributeNameTipText() Tip text to display for y attribute regular expression
String	yAttributeTipText() Returns the tip text setting the y attribute using an index

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_XAttributeName

protected BaseRegExp m_XAttributeName

String for setting x attribute using regular expression

m_YAttributeName

protected BaseRegExp m_YAttributeName

String for setting y attribute using regular expression

m_XAttribute

protected String m_XAttribute

the 0-based index of the X attribute.

m_YAttribute

protected String m_YAttribute

the 0-based index of the Y attribute.

m_ScatPlot

protected ScatterPlot m_ScatPlot

scatter panel to display using the actor

m_Overlays

protected AbstractScatterPlotOverlay[] m_Overlays

Array containing scatter plot overlays

m_Paintlet

protected AbstractScatterPlotPaintlet m_Paintlet

Paintlet to draw original data with

Constructor Detail

ScatterDisplay

public ScatterDisplay()

Method Detail

globalInfo

public String globalInfo()

Specified by:

globalInfo in class AbstractOptionHandler

accepts

public Class[] accepts()

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractGraphicalDisplay

setOverlays

public void setOverlays(AbstractScatterPlotOverlay[] over)

Set the overlays to be drawn on the scatter plot

Parameters:

over - Array containing overlays

getOverlays

public AbstractScatterPlotOverlay[] getOverlays()

Get the overlays to be drawn on the scatter plot

Returns:

Array containing the overlays

overlaysTipText

public String overlaysTipText()

Returns the tip text for the overlays property.

Returns:

tip text for this property

setPaintlet

public void setPaintlet(AbstractScatterPlotPaintlet pain)

Set the paintlet to draw the data points with

Parameters:

pain - paintlet used

getPaintlet

public AbstractScatterPlotPaintlet getPaintlet()

get the paintlet used to draw the data with

Returns:

Paintlet used

paintletTipText

public String paintletTipText()

Returns the tip text for the paintlet property

Returns:

tip text for this property

getDefaultWidth

protected int getDefaultWidth()

Overrides:

getDefaultWidth in class AbstractDisplay

getDefaultHeight

protected int getDefaultHeight()

Overrides:

getDefaultHeight in class AbstractDisplay

setXAttributeName

public void setXAttributeName(BaseRegExp val)

Set the x attribute on the scatter plot using a regular expression

Parameters:

val - name of attribute for axis

getXAttributeName

public BaseRegExp getXAttributeName()

Returns the regular expression for the attribute to be displayed on the x axis

Returns:

name of attribute

xAttributeNameTipText

public String xAttributeNameTipText()

Tip text to display for x attribute regular expression

Returns:

String to display

setYAttributeName

public void setYAttributeName(BaseRegExp val)

Set the y attribute on the scatter plot using a regular expression

Parameters:

val - regular expression for attribute on y axis

getYAttributeName

public BaseRegExp getYAttributeName()

Returns the attribute to be displayed on the y axis

Returns:

regular expression for choosing attribute

yAttributeNameTipText

public String yAttributeNameTipText()

Tip text to display for y attribute regular expression

Returns:

String to display

setXAttribute

public void setXAttribute(String val)

Sets the index of the attribute to display on x axis

Parameters:

val - 1-based index of attribute for x axis

getXAttribute

public String getXAttribute()

Get the index of the attribute displayed on the x axis

Returns:

1-based index of attribute to be displayed

xAttributeTipText

public String xAttributeTipText()

Returns the tip text for x attribute set using index.

Returns:

Set the attribute to be used for the x axis using a 1-based index

setYAttribute

public void setYAttribute(String val)

Set the attribute to be displayed on the y axis using an index

Parameters:

val - 1-based index of attribute to be displayed on y axis

getYAttribute

public String getYAttribute()

Get the index of the attribute displayed on the y axis

Returns:

The 1-based index of the attribute on the y axis

yAttributeTipText

public String yAttributeTipText()

Returns the tip text setting the y attribute using an index

Returns:

1-based index for attribute to display on y axis

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)

Displays the token (the panel and dialog have already been created at this stage).

Specified by:

display in class AbstractDisplay

Parameters:

token - the token to display