Class WekaInstancesDisplay

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.TextSupporter, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ClearableDisplay, adams.flow.core.DisplayTypeSupporter, adams.flow.core.ErrorHandler, adams.flow.core.InputConsumer, adams.flow.sink.ComponentSupplier, adams.flow.sink.DisplayPanelProvider, adams.flow.sink.TextSupplier, adams.gui.core.MenuBarProvider, adams.gui.sendto.SendToActionSupporter, Serializable, Comparable

    public class WekaInstancesDisplay
    extends adams.flow.sink.AbstractGraphicalDisplay
    implements adams.flow.sink.DisplayPanelProvider, adams.flow.sink.TextSupplier, adams.flow.sink.ComponentSupplier
    Actor for displaying a weka.core.Instances object in table format.

    Input/output:
    - accepts:
       weka.core.Instances


    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: InstancesDisplay
     
    -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.
     
    -width <int> (property: width)
        The width of the dialog.
        default: 640
        minimum: 1
     
    -height <int> (property: height)
        The height of the dialog.
        default: 480
        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 [options]> (property: writer)
        The writer to use for generating the graphics output.
        default: adams.gui.print.NullWriter
     
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected InstancesTable m_Table
      the table with the instances.
      • Fields inherited from class adams.flow.sink.AbstractGraphicalDisplay

        m_GraphicFileChooser, m_MenuBar, m_MenuItemFileClear, m_MenuItemFileClose, m_MenuItemFileSaveAs, m_MenuItemFileSaveTextAs, m_MenuItemFlowPauseResume, m_MenuItemFlowStop, m_ShowFlowControlSubMenu, m_TextFileChooser, m_Writer
      • Fields inherited from class adams.flow.core.AbstractDisplay

        BACKUP_INPUT, m_CreateFrame, m_DisplayType, m_Frame, m_Height, m_InputToken, m_KeepOpen, 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_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated
      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager
      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel
      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      Returns the class that the consumer accepts.
      protected void cleanUpGUI()
      Removes all graphical components.
      void clearPanel()
      Clears the content of the panel.
      adams.flow.sink.AbstractDisplayPanel createDisplayPanel​(adams.flow.core.Token token)
      Creates a new panel for the token.
      protected void display​(adams.flow.core.Token token)
      Displays the token (the panel and dialog have already been created at this stage).
      boolean displayPanelRequiresScrollPane()
      Returns whether the created display panel requires a scroll pane or not.
      protected String doExecute()
      Executes the flow item.
      String getCustomSupplyTextMenuItemCaption()
      Returns the text for the menu item.
      adams.gui.core.ExtensionFileFilter getCustomTextFileFilter()
      Returns a custom file filter for the file chooser.
      protected int getDefaultHeight()
      Returns the default height for the dialog.
      protected int getDefaultWidth()
      Returns the default width for the dialog.
      Class[] getSendToClasses()
      Returns the classes that the supporter generates.
      Object getSendToItem​(Class[] cls)
      Returns the object to send.
      String globalInfo()
      Returns a string describing the object.
      protected adams.gui.core.BasePanel newPanel()
      Creates the panel to display in the dialog.
      JComponent supplyComponent()
      Supplies the component.
      String supplyText()
      Supplies the text.
      boolean supportsClear()
      Whether "clear" is supported and shows up in the menu.
      • Methods inherited from class adams.flow.sink.AbstractGraphicalDisplay

        canPauseOrResume, clear, close, createMenuBar, defineOptions, getGraphicFileChooser, getMenuBar, getShowFlowControlSubMenu, getTextFileChooser, getWriter, hasPanel, hasSendToItem, isPaused, pauseResumeFlow, saveAs, saveTextAs, setShowFlowControlSubMenu, setWriter, showFlowControlSubMenuTipText, stopFlow, updateMenu, wrapUp, writerTipText
      • Methods inherited from class adams.flow.sink.AbstractDisplay

        newDisplayRunnable, postDisplay, preDisplay
      • Methods inherited from class adams.flow.core.AbstractDisplay

        backupState, cleanUp, cleanUpGUIKeepOpen, closeFrame, createFrame, createTitle, currentInput, deregisterInWrapUp, deregisterWindow, deregisterWithEditor, displayTypeTipText, doCreateFrame, getCreateFrame, getDefaultDisplayType, getDefaultShortTitle, getDefaultX, getDefaultY, getDisplayType, getFrame, getFrameDefaultCloseOperation, getHeight, getKeepOpen, getPanel, getQuickInfo, getShortTitle, getWidth, getX, getY, hasInput, heightTipText, initialize, input, postCreateFrame, preCreateFrame, registerWindow, registerWithEditor, reset, restoreState, setCreateFrame, setDisplayType, setHeight, setKeepOpen, setShortTitle, setWidth, setX, setY, shortTitleTipText, stopExecution, widthTipText, xTipText, yTipText
      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, canInspectOptions, canPerformSetUpCheck, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged
      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString
      • Methods inherited from class adams.core.logging.LoggingObject

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled
      • Methods inherited from interface adams.flow.core.Actor

        cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp
      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation
      • Methods inherited from interface adams.flow.core.InputConsumer

        currentInput, hasInput, input
      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel, setLoggingLevel
      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled
      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, defineOptions, getOptionManager
      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions
    • Field Detail

      • m_Table

        protected InstancesTable m_Table
        the table with the instances.
    • Constructor Detail

      • WekaInstancesDisplay

        public WekaInstancesDisplay()
    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui
      • getDefaultWidth

        protected int getDefaultWidth()
        Returns the default width for the dialog.
        Overrides:
        getDefaultWidth in class adams.flow.core.AbstractDisplay
        Returns:
        the default width
      • getDefaultHeight

        protected int getDefaultHeight()
        Returns the default height for the dialog.
        Overrides:
        getDefaultHeight in class adams.flow.core.AbstractDisplay
        Returns:
        the default height
      • supportsClear

        public boolean supportsClear()
        Whether "clear" is supported and shows up in the menu.
        Specified by:
        supportsClear in interface adams.flow.core.ClearableDisplay
        Overrides:
        supportsClear in class adams.flow.sink.AbstractGraphicalDisplay
        Returns:
        true if supported
      • clearPanel

        public void clearPanel()
        Clears the content of the panel.
        Specified by:
        clearPanel in class adams.flow.core.AbstractDisplay
      • newPanel

        protected adams.gui.core.BasePanel newPanel()
        Creates the panel to display in the dialog.
        Specified by:
        newPanel in class adams.flow.core.AbstractDisplay
        Returns:
        the panel
      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface adams.flow.core.InputConsumer
        Returns:
        weka.core.Instances.class
      • display

        protected void display​(adams.flow.core.Token token)
        Displays the token (the panel and dialog have already been created at this stage).
        Specified by:
        display in class adams.flow.sink.AbstractDisplay
        Parameters:
        token - the token to display
      • doExecute

        protected String doExecute()
        Executes the flow item.

        Outputs the token on the command-line in headless mode.
        Overrides:
        doExecute in class adams.flow.core.AbstractDisplay
        Returns:
        null if everything is fine, otherwise error message
      • cleanUpGUI

        protected void cleanUpGUI()
        Removes all graphical components.
        Overrides:
        cleanUpGUI in class adams.flow.sink.AbstractGraphicalDisplay
      • getCustomSupplyTextMenuItemCaption

        public String getCustomSupplyTextMenuItemCaption()
        Returns the text for the menu item.
        Specified by:
        getCustomSupplyTextMenuItemCaption in interface adams.flow.sink.TextSupplier
        Returns:
        the menu item text, null for default
      • getCustomTextFileFilter

        public adams.gui.core.ExtensionFileFilter getCustomTextFileFilter()
        Returns a custom file filter for the file chooser.
        Specified by:
        getCustomTextFileFilter in interface adams.flow.sink.TextSupplier
        Returns:
        the file filter, null if to use default one
      • supplyText

        public String supplyText()
        Supplies the text.
        Specified by:
        supplyText in interface adams.flow.sink.TextSupplier
        Specified by:
        supplyText in interface adams.core.TextSupporter
        Returns:
        the text, null if none available
      • supplyComponent

        public JComponent supplyComponent()
        Supplies the component. May get called even before actor has been executed.
        Specified by:
        supplyComponent in interface adams.flow.sink.ComponentSupplier
        Overrides:
        supplyComponent in class adams.flow.sink.AbstractGraphicalDisplay
        Returns:
        the component, null if none available
      • createDisplayPanel

        public adams.flow.sink.AbstractDisplayPanel createDisplayPanel​(adams.flow.core.Token token)
        Creates a new panel for the token.
        Specified by:
        createDisplayPanel in interface adams.flow.sink.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 adams.flow.sink.DisplayPanelProvider
        Returns:
        true if the display panel requires a scroll pane
      • getSendToClasses

        public Class[] getSendToClasses()
        Returns the classes that the supporter generates.
        Specified by:
        getSendToClasses in interface adams.gui.sendto.SendToActionSupporter
        Overrides:
        getSendToClasses in class adams.flow.sink.AbstractGraphicalDisplay
        Returns:
        the classes
      • getSendToItem

        public Object getSendToItem​(Class[] cls)
        Returns the object to send.
        Specified by:
        getSendToItem in interface adams.gui.sendto.SendToActionSupporter
        Overrides:
        getSendToItem in class adams.flow.sink.AbstractGraphicalDisplay
        Parameters:
        cls - the requested classes
        Returns:
        the item to send