Package adams.flow.source

Class WekaSelectObjects

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.ArrayProvider, 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.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ArrayProvider, adams.flow.core.AutomatableInteraction, adams.flow.core.AutomatableInteractiveActor, adams.flow.core.ErrorHandler, adams.flow.core.InteractiveActor, adams.flow.core.InteractiveActorWithCustomParentComponent, adams.flow.core.OutputProducer, adams.flow.core.StopModeSupporter, Serializable, Comparable
    public class WekaSelectObjects
extends adams.flow.source.AbstractSelectObjects
    Allows the user to select an arbitrary number of Weka objects from the specified class hierarchy using the GenericObjectArray.

    Input/output:
    - generates:
       java.lang.Object


    -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: WekaSelectObjects
 
    -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
 
    -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: 
 
    -output-array <boolean> (property: outputArray)
    If enabled, the objects get output as array rather than one-by-one.
    default: false
 
    -super-class <adams.core.base.BaseClassname> (property: superClass)
    The superclass for the class hierarchy.
    default: java.lang.Object
 
    -initial-objects <adams.core.base.BaseString> [-initial-objects ...] (property: initialObjects)
    The initial objects to populate the dialog with.
    default: 
 
    -non-interactive <boolean> (property: nonInteractive)
    If enabled, the initial objects are forwarded without user interaction.
    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
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected weka.gui.GenericArrayEditor m_ArrayEditor
      the dialog for selecting the objects.
      protected adams.gui.dialog.ApprovalDialog m_Dialog
      the dialog for selecting the objects.

      • Fields inherited from class adams.flow.source.AbstractSelectObjects

        m_InitialObjects, m_NonInteractive, m_ShortTitle, m_SuperClass

      • Fields inherited from class adams.flow.source.AbstractInteractiveArrayProvider

        m_Index, m_OutputArray, m_Queue

      • Fields inherited from class adams.flow.source.AbstractInteractiveSource

        m_CallableActor, m_CustomStopMessage, m_Helper, m_ParentComponentActor, m_ParentComponentActorConfigured, m_StopFlowIfCanceled, m_StopMode, m_UseOuterWindow

      • 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

      • Fields inherited from interface adams.flow.core.InteractiveActor

        INTERACTION_CANCELED

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected Object commandlineToObject​(String cmdline)
      Turns a commandline into an object.
      protected Class getItemClass()
      Returns the based class of the items.
      String globalInfo()
      Returns a string describing the object.
      protected void initializeDialog()
      Initializes the interactive dialog with the
      String outputArrayTipText()
      Returns the tip text for this property.
      protected Object[] showDialog()
      Displays the dialog, prompting the user to select classes.
      void stopExecution()
      Stops the execution.
      void wrapUp()
      Cleans up after the execution has finished.

      • Methods inherited from class adams.flow.source.AbstractSelectObjects

        defineOptions, doExecute, doInteract, getDefaultInitialObjects, getDefaultSuperClass, getInitialObjects, getQuickInfo, getShortTitle, getSuperClass, initialObjectsTipText, isNonInteractive, nonInteractiveTipText, setInitialObjects, setNonInteractive, setShortTitle, setSuperClass, shortTitleTipText, superClassTipText

      • Methods inherited from class adams.flow.source.AbstractInteractiveArrayProvider

        generates, getOutputArray, hasPendingOutput, output, preExecute, reset, setOutputArray

      • Methods inherited from class adams.flow.source.AbstractInteractiveSource

        customStopMessageTipText, deregisterWindow, doInteractHeadless, findCallableActor, getActualParentComponent, getCustomStopMessage, getParentComponentActor, getStopFlowIfCanceled, getStopMode, getUseOuterWindow, initialize, parentComponentActorTipText, registerWindow, setCustomStopMessage, setParentComponentActor, setStopFlowIfCanceled, setStopMode, setUseOuterWindow, stopFlowIfCanceledTipText, stopModeTipText, supportsHeadlessInteraction, useOuterWindowTipText

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, 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, pruneBackup, pruneBackup, restoreState, 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, 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, toCommandLine, variableChanged

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

      • Methods inherited from interface adams.flow.core.InteractiveActor

        customStopMessageTipText, doInteractHeadless, getCustomStopMessage, getStopFlowIfCanceled, setCustomStopMessage, setStopFlowIfCanceled, stopFlowIfCanceledTipText, supportsHeadlessInteraction

      • 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, getOptionManager

      • Methods inherited from interface adams.flow.core.StopModeSupporter

        getStopMode, setStopMode, stopModeTipText

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • m_Dialog

        protected adams.gui.dialog.ApprovalDialog m_Dialog
        the dialog for selecting the objects.

      • m_ArrayEditor

        protected weka.gui.GenericArrayEditor m_ArrayEditor
        the dialog for selecting the objects.

    • Constructor Detail

      • WekaSelectObjects

        public WekaSelectObjects()

    • 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

      • outputArrayTipText

        public String outputArrayTipText()
        Returns the tip text for this property.
        Specified by:
        outputArrayTipText in interface adams.core.ArrayProvider
        Specified by:
        outputArrayTipText in interface adams.flow.core.ArrayProvider
        Specified by:
        outputArrayTipText in class adams.flow.source.AbstractInteractiveArrayProvider
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getItemClass

        protected Class getItemClass()
        Returns the based class of the items.
        Specified by:
        getItemClass in class adams.flow.source.AbstractInteractiveArrayProvider
        Returns:
        the class

      • commandlineToObject

        protected Object commandlineToObject​(String cmdline)
        Turns a commandline into an object.
        Specified by:
        commandlineToObject in class adams.flow.source.AbstractSelectObjects
        Parameters:
        cmdline - the commandline to convert
        Returns:
        the generated object, null if failed to convert

      • initializeDialog

        protected void initializeDialog()
        Initializes the interactive dialog with the
        Specified by:
        initializeDialog in class adams.flow.source.AbstractSelectObjects

      • showDialog

        protected Object[] showDialog()
        Displays the dialog, prompting the user to select classes.
        Specified by:
        showDialog in class adams.flow.source.AbstractSelectObjects
        Returns:
        the selected objects, null in case of user cancelling the dialog

      • stopExecution

        public void stopExecution()
        Stops the execution. No message set.
        Specified by:
        stopExecution in interface adams.flow.core.Actor
        Specified by:
        stopExecution in interface adams.core.Stoppable
        Overrides:
        stopExecution in class adams.flow.core.AbstractActor

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished.
        Specified by:
        wrapUp in interface adams.flow.core.Actor
        Overrides:
        wrapUp in class adams.flow.source.AbstractInteractiveArrayProvider