Package adams.flow.sink

Class SpreadSheetRowViewer

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, TextSupporter, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, FlowControlSubMenuSupporter, HeadlessExecutionSupporter, InputConsumer, ComponentSupplier, DisplayPanelProvider, TextSupplier, MenuBarProvider, SendToActionSupporter, ColorProviderHandler, Serializable, Comparable
    public class SpreadSheetRowViewer
extends AbstractGraphicalDisplay
implements DisplayPanelProvider, TextSupplier, ColorProviderHandler
    Actor for displaying spreadsheet rows in a graphical way, like the 'Spreadsheet Explorer' tool.

    Input/output:
    - accepts:
       adams.data.spreadsheet.Row
       adams.gui.visualization.spreadsheet.SpreadSheetRow


    -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: SpreadSheetRowViewer
 
    -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; 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: 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
 
    -color-provider <adams.gui.visualization.core.ColorProvider> (property: colorProvider)
    The color provider in use for coloring the rows.
    default: adams.gui.visualization.core.DefaultColorProvider
 
    -paintlet <adams.gui.visualization.spreadsheet.AbstractSpreadSheetRowPaintlet> (property: paintlet)
    The paintlet to use for drawing the rows.
    default: adams.gui.visualization.spreadsheet.SpreadSheetRowLinePaintlet
 
    -zoom-overview <boolean> (property: zoomOverview)
    If enabled, a zoom overview panel gets displayed as well.
    default: false
 
    -id <java.lang.String> (property: ID)
    The name of the attribute/field to use as the ID in the display.
    default: 
 
    -updater <adams.gui.visualization.spreadsheet.AbstractSpreadSheetRowPanelUpdater> (property: updater)
    The updater in use for refreshing the visualization.
    default: adams.gui.visualization.spreadsheet.SimpleSpreadSheetRowPanelUpdater
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • SpreadSheetRowViewer

        public SpreadSheetRowViewer()

    • 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

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

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

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

      • setID

        public void setID​(String value)
        Sets the name of the attribute/field to use as ID in the display.
        Parameters:
        value - the attribute/field name

      • getID

        public String getID()
        Returns the name of the attribute/field to use as ID in the display.
        Returns:
        the attribute/field name

      • IDTipText

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

      • updaterTipText

        public String updaterTipText()
        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.spreadsheet.Row.class, adams.gui.visualization.spreadsheet.SpreadSheetRow.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

      • supplyText

        protected static String supplyText​(SpreadSheetRowPanel panel)
        Returns the displayed instances as ARFF.
        Parameters:
        panel - the panel to obtain the data form
        Returns:
        the generated ARFF content or null if no data available

      • 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