Package adams.flow.sink

Class TimeseriesDisplay

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DataPlotUpdaterHandler<AbstractPlotUpdater>, DataPlotUpdaterSupporter<AbstractPlotUpdater>, DisplayTypeSupporter, ErrorHandler, FlowControlSubMenuSupporter, HeadlessExecutionSupporter, InputConsumer, ComponentSupplier, DisplayPanelProvider, MenuBarProvider, SendToActionSupporter, ColorProviderHandler, Serializable, Comparable
    public class TimeseriesDisplay
extends AbstractGraphicalDisplay
implements DisplayPanelProvider, DataPlotUpdaterHandler<AbstractPlotUpdater>, ColorProviderHandler
    Actor that displays timeseries.

    Input/output:
    - accepts:
       adams.data.timeseries.Timeseries


    -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: TimeseriesDisplay
 
    -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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    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: 1000
    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
 
    -paintlet <adams.gui.visualization.timeseries.AbstractTimeseriesPaintlet> (property: paintlet)
    The paintlet to use.
    default: adams.gui.visualization.timeseries.TimeseriesPaintlet
 
    -axis-x <adams.gui.visualization.timeseries.TimeseriesXAxisPanelOptions> (property: axisX)
    The setup for the X axis.
    default: adams.gui.visualization.timeseries.DefaultTimeseriesXAxisPanelOptions -label time -type DATE -tick-generator adams.gui.visualization.core.axis.PeriodicityTickGenerator -width 40
 
    -axis-y <adams.gui.visualization.timeseries.TimeseriesYAxisPanelOptions> (property: axisY)
    The setup for the Y axis.
    default: adams.gui.visualization.timeseries.DefaultTimeseriesYAxisPanelOptions -label value -tick-generator adams.gui.visualization.core.axis.FancyTickGenerator -nth-value 2 -width 60 -custom-format 0.0
 
    -color-provider <adams.gui.visualization.core.ColorProvider> (property: colorProvider)
    The color provider in use for generating the colors for the various plots.
    default: adams.gui.visualization.core.DefaultColorProvider
 
    -show-side-panel <boolean> (property: showSidePanel)
    If enabled, the side panel with the list of loaded spectra gets displayed.
    default: true
 
    -zoom-overview <boolean> (property: zoomOverview)
    If enabled, a zoom overview panel gets displayed as well.
    default: false
 
    -overlay <adams.gui.visualization.core.Paintlet> [-overlay ...] (property: overlays)
    The paintlets to use for overlays.
    default: 
 
    -plot-updater <adams.flow.sink.timeseriesdisplay.AbstractPlotUpdater> (property: plotUpdater)
    The updating strategy for the plot.
    default: adams.flow.sink.timeseriesdisplay.SimplePlotUpdater
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ColorProvider

        protected ColorProvider m_ColorProvider
        the color provider to use.

      • m_ShowSidePanel

        protected boolean m_ShowSidePanel
        whether to show the side panel or not.

      • m_ZoomOverview

        protected boolean m_ZoomOverview
        whether to display the zoom overview.

      • m_Overlays

        protected Paintlet[] m_Overlays
        the paintlets to use as overlay.

    • Constructor Detail

      • TimeseriesDisplay

        public TimeseriesDisplay()

    • 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

      • getDefaultPaintlet

        protected AbstractTimeseriesPaintlet getDefaultPaintlet()
        Returns the default paintlet.
        Returns:
        the default paintlet

      • setPaintlet

        public void setPaintlet​(AbstractTimeseriesPaintlet value)
        Sets the paintlet to use.
        Parameters:
        value - the paintlet

      • paintletTipText

        public String paintletTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • axisXTipText

        public String axisXTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • axisYTipText

        public String axisYTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • colorProviderTipText

        public String colorProviderTipText()
        Returns the tip text for this property.
        Specified by:
        colorProviderTipText in interface ColorProviderHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setShowSidePanel

        public void setShowSidePanel​(boolean value)
        Sets whether to show the side panel or not.
        Parameters:
        value - if true the side panel gets displayed

      • getShowSidePanel

        public boolean getShowSidePanel()
        Returns whether to show the side panel or not.
        Returns:
        true if the side panel gets displayed

      • showSidePanelTipText

        public String showSidePanelTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setZoomOverview

        public void setZoomOverview​(boolean value)
        Sets whether to display the zoom overview.
        Parameters:
        value - if true then the zoom overview will get displayed

      • getZoomOverview

        public boolean getZoomOverview()
        Returns whether the zoom overview gets displayed.
        Returns:
        true if the zoom overview gets displayed

      • zoomOverviewTipText

        public String zoomOverviewTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOverlays

        public void setOverlays​(Paintlet[] value)
        Sets the overlay paintlets.
        Parameters:
        value - the overlay paintlets

      • getOverlays

        public Paintlet[] getOverlays()
        Returns the overlay paintlets.
        Returns:
        the overlay paintlets

      • overlaysTipText

        public String overlaysTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        adams.data.timeseries.Timeseries.class

      • 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

      • 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