Package adams.flow.source

Class EnterManyValues

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, AutomatableInteraction, AutomatableInteractiveActor, ErrorHandler, InteractionDisplayLocationSupporter, InteractiveActor, InteractiveActorWithCustomParentComponent, OutputProducer, RestorableActor, StopModeSupporter, Serializable, Comparable
    public class EnterManyValues
extends AbstractInteractiveSource
implements AutomatableInteractiveActor, RestorableActor, InteractionDisplayLocationSupporter
    Pops up a dialog, prompting the user to enter one or more values.

    Input/output:
    - 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
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: EnterManyValues
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -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
 
    -parent-component-actor <adams.flow.core.CallableActorReference> (property: parentComponentActor)
    The (optional) callable actor to use as parent component instead of the
    flow panel.
    default: unknown
    min-user-mode: Expert
 
    -use-outer-window <boolean> (property: useOuterWindow)
    If enabled, the outer window (dialog/frame) is used instead of the component
    of the callable actor.
    default: false
    min-user-mode: Expert
 
    -message <java.lang.String> (property: message)
    The message to prompt the user with; variables get automatically expanded.
    default: Please enter values
 
    -value <adams.flow.source.valuedefinition.AbstractValueDefinition> [-value ...] (property: values)
    The value definitions that define the dialog prompting the user to enter
    the values.
    default:
 
    -output-type <SPREADSHEET|KEY_VALUE_PAIRS|KEY_VALUE_PAIRS_ARRAY|MAP> (property: outputType)
    How to output the entered data.
    default: SPREADSHEET
 
    -display-location <DIALOG|NOTIFICATION_AREA> (property: displayLocation)
    Determines where the interaction is being displayed.
    default: DIALOG
 
    -non-interactive <boolean> (property: nonInteractive)
    If enabled, the initial value is forwarded without user interaction.
    default: false
 
    -restoration-enabled <boolean> (property: restorationEnabled)
    If enabled, the state of the actor is being preserved and attempted to read
    in again next time this actor is executed.
    default: false
 
    -restoration-file <adams.core.io.PlaceholderFile> (property: restorationFile)
    The file to store the restoration information in.
    default: ${CWD}
 
    -width <int> (property: width)
    The width for the dialog, -1 for default.
    default: -1
    minimum: -1
    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_NonInteractive

        protected boolean m_NonInteractive
        whether to automate the actor.

      • m_RestorationEnabled

        protected boolean m_RestorationEnabled
        whether restoration is enabled.

      • m_RestorationFile

        protected PlaceholderFile m_RestorationFile
        the file to store the restoration state in.

      • m_Width

        protected int m_Width
        the width of the dialog.

      • m_Queue

        protected List m_Queue
        the list of tokens to output.

    • Constructor Detail

      • EnterManyValues

        public EnterManyValues()

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

      • addValue

        public void addValue​(AbstractValueDefinition value)
        Adds a single value definition at the end.
        Parameters:
        value - the definition to add

      • setValues

        public void setValues​(AbstractValueDefinition[] value)
        Sets the value definitions.
        Parameters:
        value - the definitions

      • valuesTipText

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

      • setOutputType

        public void setOutputType​(EnterManyValues.OutputType value)
        Sets how to output the entered data.
        Parameters:
        value - the type

      • outputTypeTipText

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

      • setRestorationEnabled

        public void setRestorationEnabled​(boolean value)
        Sets whether to enable restoration.
        Specified by:
        setRestorationEnabled in interface RestorableActor
        Parameters:
        value - true if to enable restoration

      • isRestorationEnabled

        public boolean isRestorationEnabled()
        Returns whether restoration is enabled.
        Specified by:
        isRestorationEnabled in interface RestorableActor
        Returns:
        true if restoration enabled

      • restorationEnabledTipText

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

      • restorationFileTipText

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

      • setWidth

        public void setWidth​(int value)
        Sets the width for the dialog.
        Parameters:
        value - the width

      • getWidth

        public int getWidth()
        Returns the width for the dialog.
        Returns:
        the width

      • widthTipText

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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the classes

      • getDefaultProperties

        protected Properties getDefaultProperties()
        Returns the default properties.
        Returns:
        the default properties

      • propertiesToSpreadSheet

        protected SpreadSheet propertiesToSpreadSheet​(Properties props)
        Converts the properties into a spreadsheet (single row, with property names for column names).
        Parameters:
        props - the properties to convert
        Returns:
        the generated spreadsheet in a token

      • propertiesToOutputType

        protected Token[] propertiesToOutputType​(Properties props)
        Converts the properties into the requested output type.
        Parameters:
        props - the properties to convert
        Returns:
        the generated output type

      • doInteractInDialog

        protected String doInteractInDialog​(PropertiesParameterPanel panel,
                                    JPanel panelMsg)
        Performs the interaction using a dialog.
        Parameters:
        panel - the panel with the parameters
        panelMsg - the panel with the message for the user
        Returns:
        null if successfully interacted, otherwise error message

      • doInteractInNotificationArea

        protected String doInteractInNotificationArea​(PropertiesParameterPanel panel,
                                              JPanel panelMsg)
        Performs the interaction using the notification area.
        Parameters:
        panel - the panel with the parameters
        panelMsg - the panel with the message for the user
        Returns:
        null if successfully interacted, otherwise error message

      • output

        public Token output()
        Returns the generated token.
        Specified by:
        output in interface OutputProducer
        Returns:
        the generated token

      • hasPendingOutput

        public boolean hasPendingOutput()
        Checks whether there is pending output to be collected after executing the flow item.
        Specified by:
        hasPendingOutput in interface OutputProducer
        Returns:
        true if there is pending output

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished.
        Specified by:
        wrapUp in interface Actor
        Overrides:
        wrapUp in class AbstractActor