AbstractFlowScriptlet (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

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Stoppable, StoppableWithFeedback, UndoHandler, Serializable, Comparable

Direct Known Subclasses:

RunFlow, RunFlowOverlay
```
public abstract class AbstractFlowScriptlet
extends AbstractDataContainerUpdatingScriptlet
```
Ancestor for scriptlets that run flows.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- 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

AbstractFlowScriptlet()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`getOptionsDescription()`	Returns a one-line listing of the options of the action.
`String`	`process(String options, boolean overlay)`	Processes the options.

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, doProcess, equals, forName, getAction, getBasePanel, getDataProvider, getDescription, 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

- Constructor Detail
  - AbstractFlowScriptlet
```
public AbstractFlowScriptlet()
```
- Method Detail
  - getOptionsDescription
```
protected String getOptionsDescription()
```
    Returns a one-line listing of the options of the action.
    
    Overrides:
    
    getOptionsDescription in class AbstractScriptlet
    
    Returns:
    
    the options or null if none
  - process
```
public String process(String options,
                      boolean overlay)
               throws Exception
```
    Processes the options.
    
    Parameters:
    
    options - additional/optional options for the action
    
    overlay - whether to overlay the data
    
    Returns:
    
    null if no error, otherwise error message
    
    Throws:
    
    Exception - if something goes wrong