Package adams.flow.transformer

Class SpreadSheetSelectSubset

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, InteractiveActor, OutputProducer, StopModeSupporter, Serializable, Comparable
    public class SpreadSheetSelectSubset
extends AbstractInteractiveTransformerDialog
    Allows the user to select a subset of the incoming spreadsheet to be forwarded in the flow.

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
    - generates:
       adams.data.spreadsheet.SpreadSheet


    -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: SpreadSheetSelectSubset
 
    -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
 
    -width <int> (property: width)
    The width of the dialog.
    default: 600
    minimum: 1
 
    -height <int> (property: height)
    The height of the dialog.
    default: 400
    minimum: 1
 
    -x <int> (property: x)
    The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
    ).
    default: -2
    minimum: -3
 
    -y <int> (property: y)
    The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
    ).
    default: -2
    minimum: -3
 
    -stop-if-canceled <boolean> (property: stopFlowIfCanceled)
    If enabled, the flow gets stopped in case the user cancels the dialog.
    default: false
 
    -custom-stop-message <java.lang.String> (property: customStopMessage)
    The custom stop message to use in case a user cancelation stops the flow
    (default is the full name of the actor)
    default:
 
    -stop-mode <GLOBAL|STOP_RESTRICTOR> (property: stopMode)
    The stop mode to use.
    default: GLOBAL
 
    -message <java.lang.String> (property: message)
    The message to prompt the user with; variables get expanded prior to prompting
    user.
    default: Please make your selection
 
    -allow-search <boolean> (property: allowSearch)
    Whether to allow the user to search the list.
    default: false
 
    -multi-selection <boolean> (property: multiSelection)
    Whether to allow the user to select multiple rows or just a single one.
    default: true
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Message

        protected String m_Message
        the message for the user.

      • m_AllowSearch

        protected boolean m_AllowSearch
        whether to allow searching.

      • m_LabelMessage

        protected JLabel m_LabelMessage
        the label for the message.

      • m_MultiSelection

        protected boolean m_MultiSelection
        whether to allow multiple rows to be selected.

      • m_Accepted

        protected boolean m_Accepted
        whether the data was accepted.

    • Constructor Detail

      • SpreadSheetSelectSubset

        public SpreadSheetSelectSubset()

    • Method Detail

      • setMessage

        public void setMessage​(String value)
        Sets the message to prompt the user with.
        Parameters:
        value - the message

      • getMessage

        public String getMessage()
        Returns the message the user is prompted with.
        Returns:
        the message

      • messageTipText

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

      • setAllowSearch

        public void setAllowSearch​(boolean value)
        Sets whether to allow the user to search the table.
        Parameters:
        value - true if to allow search

      • getAllowSearch

        public boolean getAllowSearch()
        Returns whether to allow the user to search the table.
        Returns:
        true if to allow search

      • allowSearchTipText

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

      • setMultiSelection

        public void setMultiSelection​(boolean value)
        Sets whether to allow the user to select multiple rows.
        Parameters:
        value - true if to allow multiple row selection

      • getMultiSelection

        public boolean getMultiSelection()
        Returns whether to allow the user to select multiple rows.
        Returns:
        true if to allow multiple row selection

      • multiSelectionTipText

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

      • setPreview

        public void setPreview​(AbstractSpreadSheetPreview value)
        Sets the preview to use for selected rows.
        Parameters:
        value - the preview

      • previewTipText

        public String previewTipText()
        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.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens