Package adams.flow.sink

Class ScatterDisplay

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, TextSupporter, VariablesInspectionHandler, SpreadSheetSupporter, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, FlowControlSubMenuSupporter, HeadlessExecutionSupporter, InputConsumer, ComponentSupplier, DisplayPanelProvider, TextSupplier, MenuBarProvider, SendToActionSupporter, Serializable, Comparable
    public class ScatterDisplay
extends AbstractGraphicalDisplay
implements DisplayPanelProvider, TextSupplier, SpreadSheetSupporter
    Actor for displaying a scatter plot of one attribute vs another. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ScatterDisplay
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -short-title <boolean> (property: shortTitle)
    If enabled uses just the name for the title instead of the actor's full 
    name.
    default: false
 
    -display-in-editor <boolean> (property: displayInEditor)
    If enabled displays the panel in a tab in the flow editor rather than in 
    a separate frame.
    default: false
 
    -width <int> (property: width)
    The width of the dialog.
    default: 800
    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
 
    -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: 
 
    -color-attribute-name <adams.core.base.BaseRegExp> (property: colorAttributeName)
    Attribute for the colors 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
 
    -color-attribute <java.lang.String> (property: colorAttribute)
    index of optional attribute to use for coloring, used only ifregular expression 
    not set, ignored if empty
    default: 
 
    -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 -color-provider adams.gui.visualization.core.DefaultColorProvider
 
    -mouse-click-action <adams.gui.visualization.stats.scatterplot.action.MouseClickAction> (property: mouseClickAction)
    How to process mouse clicks in the plot.
    default: adams.gui.visualization.stats.scatterplot.action.NullClickAction
    Author:
    msf8, FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • 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_ColorAttributeName

        protected BaseRegExp m_ColorAttributeName
        String for setting color 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 1-based index of the Y attribute.

      • m_ColorAttribute

        protected String m_ColorAttribute
        the 1-based index of the color attribute.

      • m_ScatterPlot

        protected ScatterPlot m_ScatterPlot
        scatter panel to display using the actor

      • m_MouseClickAction

        protected MouseClickAction m_MouseClickAction
        the mouse click action.

    • Constructor Detail

      • ScatterDisplay

        public ScatterDisplay()

    • Method Detail

      • getDefaultWidth

        protected int getDefaultWidth()
        Returns the default width for the dialog.
        Overrides:
        getDefaultWidth in class AbstractDisplay
        Returns:
        the default width

      • getDefaultHeight

        protected int getDefaultHeight()
        Returns the default height for the dialog.
        Overrides:
        getDefaultHeight in class AbstractDisplay
        Returns:
        the default height

      • 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

      • paintletTipText

        public String paintletTipText()
        Returns the tip text for the paintlet property
        Returns:
        tip text for this property

      • 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

      • setColorAttributeName

        public void setColorAttributeName​(BaseRegExp val)
        Set the color attribute on the scatter plot using a regular expression.
        Parameters:
        val - regular expression for color attribute

      • getColorAttributeName

        public BaseRegExp getColorAttributeName()
        Returns the attribute to be uses for determining the colors.
        Returns:
        regular expression for choosing attribute

      • colorAttributeNameTipText

        public String colorAttributeNameTipText()
        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

      • setColorAttribute

        public void setColorAttribute​(String val)
        Set the attribute to use for coloring the plot (optional).
        Parameters:
        val - 1-based index of attribute

      • getColorAttribute

        public String getColorAttribute()
        Get the index of the attribute displayed on the y axis
        Returns:
        The 1-based index of the attribute on the y axis

      • colorAttributeTipText

        public String colorAttributeTipText()
        Returns the tip text setting the color attribute using an index.
        Returns:
        1-based index for attribute

      • setMouseClickAction

        public void setMouseClickAction​(MouseClickAction value)
        Sets the mouse click action to use.
        Parameters:
        value - the action

      • getMouseClickAction

        public MouseClickAction getMouseClickAction()
        Returns the mouse click action in use.
        Returns:
        the action, null if non set

      • mouseClickActionTipText

        public String mouseClickActionTipText()
        Returns the tip text setting the y attribute using an index
        Returns:
        1-based index for attribute to display on y axis

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • 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

      • createDisplayPanel

        public DisplayPanel createDisplayPanel​(Token token)
        Creates a new display panel for the token.
        Specified by:
        createDisplayPanel in interface DisplayPanelProvider
        Parameters:
        token - the token to display in a new panel, can be null
        Returns:
        the generated panel

      • displayPanelRequiresScrollPane

        public boolean displayPanelRequiresScrollPane()
        Returns whether the created display panel requires a scroll pane or not.
        Specified by:
        displayPanelRequiresScrollPane in interface DisplayPanelProvider
        Returns:
        true if the display panel requires a scroll pane

      • supplyText

        public String supplyText()
        Supplies the text. May get called even if actor hasn't been executed yet.
        Specified by:
        supplyText in interface TextSupplier
        Specified by:
        supplyText in interface TextSupporter
        Returns:
        the text, null if none available