RunFlowOverlay (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.gui.scripting.AbstractScriptlet
  - - adams.gui.scripting.AbstractUndoScriptlet
    - - adams.gui.scripting.AbstractDataContainerPanelScriptlet
      - adams.gui.scripting.AbstractDataContainerUpdatingScriptlet
        
        adams.gui.scripting.AbstractFlowScriptlet
        
        adams.gui.scripting.RunFlowOverlay

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Stoppable, StoppableWithFeedback, UndoHandler, Serializable, Comparable
```
public class RunFlowOverlay
extends AbstractFlowScriptlet
```
Abstract ancestor for scriptlets that run flows and overlay the data containers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static String ACTION
the action to execute.
- Fields inherited from class adams.gui.scripting.AbstractDataContainerUpdatingScriptlet
  m_PostProcessor
- Fields inherited from class adams.gui.scripting.AbstractScriptlet
  m_DataProvider, m_Owner, m_Parameters, m_Stopped
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

RunFlowOverlay()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`doProcess(String options)`	Processes the options.
`String`	`getAction()`	Returns the action string used in the command processor.
`String`	`getDescription()`	Returns the full description of the action.

Methods inherited from class adams.gui.scripting.AbstractFlowScriptlet
getOptionsDescription, process

Methods inherited from class adams.gui.scripting.AbstractDataContainerUpdatingScriptlet
initialize, updateDataContainers, updateDataContainers, updateDataContainers, updateDataContainers

Methods inherited from class adams.gui.scripting.AbstractDataContainerPanelScriptlet
getDataContainerPanel, getRequirements

Methods inherited from class adams.gui.scripting.AbstractUndoScriptlet
addUndoPoint, getUndo, isUndoSupported, setUndo

Methods inherited from class adams.gui.scripting.AbstractScriptlet
compareTo, equals, forName, getBasePanel, getDataProvider, getOwner, getParameter, getParameterDescription, getScriptlets, hashCode, hasOwner, hasParameter, isStopped, process, setDataProvider, setOwner, setParameter, showStatus, stopExecution, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ACTION
```
public static final String ACTION
```
    the action to execute.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RunFlowOverlay
```
public RunFlowOverlay()
```
- Method Detail
  - getAction
```
public String getAction()
```
    Returns the action string used in the command processor.
    
    Specified by:
    
    getAction in class AbstractScriptlet
    
    Returns:
    
    the action string
  - getDescription
```
public String getDescription()
```
    Returns the full description of the action.
    
    Specified by:
    
    getDescription in class AbstractScriptlet
    
    Returns:
    
    the full description
  - doProcess
```
protected String doProcess(String options)
                    throws Exception
```
    Processes the options.
    
    Specified by:
    
    doProcess in class AbstractScriptlet
    
    Parameters:
    
    options - additional/optional options for the action
    
    Returns:
    
    null if no error, otherwise error message
    
    Throws:
    
    Exception - if something goes wrong