Package adams.flow.sink

Class BoxPlot

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, InputConsumer, ComponentSupplier, DisplayPanelProvider, MenuBarProvider, SendToActionSupporter, Serializable, Comparable
    public class BoxPlot
extends AbstractGraphicalDisplay
implements DisplayPanelProvider
    * Actor for displaying box plots.
    *
    * For more information, see:
    * http://en.wikipedia.org/wiki/Box_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: BoxPlot
 
    -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.
 
    -short-title (property: shortTitle)
    If enabled uses just the name for the title instead of the actor's full 
    name.
 
    -width <int> (property: width)
    The width of the dialog.
    default: 1000
    minimum: -1
 
    -height <int> (property: height)
    The height of the dialog.
    default: 700
    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
 
    -width-plot <int> (property: widthPlot)
    Width of each box plot
    default: 200
    minimum: 50
    maximum: 500
 
    -height-plot <int> (property: heightPlot)
    Height of each box plot
    default: 200
    minimum: 50
    maximum: 500
 
    -width-ax <int> (property: widthAx)
    Width of box plot y axis
    default: 50
    minimum: 20
    maximum: 100
 
    -num-horizontal <int> (property: numHorizontal)
    Number of box plots to display on each row, -1 and 0 aredefault and will 
    display all the box plots in one row
    default: -1
    minimum: -1
 
    -fill-box (property: fillBox)
    Fill the box plots with color
 
    -color <java.awt.Color> (property: color)
    Color to fill box plots
    default: #ff0000
 
    -same-axis (property: sameAxis)
    Box plots have same axis
 
    -attributes <adams.core.Range> (property: attributes)
    Attributes to display in box plots; A range is a comma-separated list of 
    single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)'
     inverts the range '...'; the following placeholders can be used as well:
     first, second, third, last_2, last_1, last
    default: first-last
    Version:
    $Revision$
    Author:
    msf8
    See Also:
    Serialized Form

    • Field Detail

      • m_BoxPlot

        protected BoxPlotManager m_BoxPlot
        panel to display on the actor

      • m_SameAxis

        protected boolean m_SameAxis
        same axis for each box plot

      • m_AttString

        protected Range m_AttString
        range of box plots to display, in string form

      • m_WidthPlot

        protected int m_WidthPlot
        width of plots to be drawn

      • m_HeightPlot

        protected int m_HeightPlot
        height of plots to be drawn

      • m_WidthAx

        protected int m_WidthAx
        same axis for each box plot

      • m_NumHorizontal

        protected int m_NumHorizontal
        Number of plots on each row

      • m_Fill

        protected boolean m_Fill
        Fill the box with color

      • m_Color

        protected Color m_Color
        Color to fill the box

    • Constructor Detail

      • BoxPlot

        public BoxPlot()

    • Method Detail

      • accepts

        public Class[] accepts()
        Description copied from interface: InputConsumer
        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)
        Description copied from class: AbstractDisplay
        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

      • setFillBox

        public void setFillBox​(boolean val)
        Set whether the box plots should be filled with color
        Parameters:
        val - True if box should be filled in

      • getFillBox

        public boolean getFillBox()
        get whether the box should be filled with color
        Returns:

      • fillBoxTipText

        public String fillBoxTipText()
        Tip Text for the fill box property
        Returns:
        String to explain the property

      • setColor

        public void setColor​(Color val)
        Set the color to fill the box plots
        Parameters:
        val - Color to fill plots

      • getColor

        public Color getColor()
        Get the color to fill the box plots
        Returns:
        Color used to fill

      • colorTipText

        public String colorTipText()
        Tip text for the color property
        Returns:
        String to explain the property

      • setWidthPlot

        public void setWidthPlot​(int val)
        Set the width of each box plot
        Parameters:
        val - Width in pixels

      • getWidthPlot

        public int getWidthPlot()
        Get the width of each box plot
        Returns:
        Width in pixels

      • widthPlotTipText

        public String widthPlotTipText()
        Tip text to display for the option
        Returns:
        Message string

      • setHeightPlot

        public void setHeightPlot​(int val)
        Set the height of each box plot
        Parameters:
        val - Height in pixels

      • getHeightPlot

        public int getHeightPlot()
        get the height of each box plot
        Returns:
        Height in pixels

      • heightPlotTipText

        public String heightPlotTipText()
        Tip text to display for the option
        Returns:
        Message string

      • setWidthAx

        public void setWidthAx​(int val)
        Set the width of the left axis for each box plot
        Parameters:
        val - Width in pixels

      • getWidthAx

        public int getWidthAx()
        Get the width of the left axis of each box plot
        Returns:
        Width in pixels

      • widthAxTipText

        public String widthAxTipText()
        Tip text to display for the option
        Returns:
        Message string

      • setNumHorizontal

        public void setNumHorizontal​(int val)
        Set the number of box plots to display on each row
        Parameters:
        val - Number on each row

      • getNumHorizontal

        public int getNumHorizontal()
        Get the number of box plots to display on each row
        Returns:
        number on each row

      • numHorizontalTipText

        public String numHorizontalTipText()
        Return a tip text for the number of box plots on each row property
        Returns:
        tip text for the property

      • setAttributes

        public void setAttributes​(Range val)
        Set the attributes to be displayed initially
        Parameters:
        val - String to create the range object

      • getAttributes

        public Range getAttributes()
        get the attributes to be displayed initially
        Returns:
        String to create the range object

      • attributesTipText

        public String attributesTipText()
        Tip text to display for the option
        Returns:
        String to display

      • setSameAxis

        public void setSameAxis​(boolean val)
        Set whether the box plots use the same axis scale
        Parameters:
        val - True if box plots use same axis

      • getSameAxis

        public boolean getSameAxis()
        gets whether the box plots are drawn using the same axis
        Returns:
        true if box plots use the same axis scale

      • sameAxisTipText

        public String sameAxisTipText()
        Returns the tip text for this property
        Returns:
        Tip text for this property

      • 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