CommandProcessor (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.gui.scripting.AbstractCommandProcessor
  - - adams.gui.scripting.CommandProcessor

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Stoppable, UndoHandler, Serializable

Direct Known Subclasses:

TimeseriesCommandProcessor
```
public class CommandProcessor
extends AbstractCommandProcessor
```
General actions:

connect <driver> <URL> <user> [password]
   Connects to the database.

disconnect
   Disconnects from the database.

run-tool <tool + options>
   Runs the specified tool.

Actions for adams.gui.core.UndoHandler:

disable-undo
   Disables the undo support, if available.

enable-undo
   Enables the undo support, if available.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.gui.scripting.AbstractCommandProcessor
  m_Actions, m_BasePanel, m_CurrentScriptlet, m_Owner
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

CommandProcessor()
Initializes the processor.

CommandProcessor(AbstractScriptingEngine owner)
Initializes the processor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AbstractDatabaseConnection`	`getDatabaseConnection()`	Returns the currently used database connection object, can be null.
`protected Object`	`getUndoObject()`	Returns the object that is to be used for the undo point.

Methods inherited from class adams.gui.scripting.AbstractCommandProcessor
addUndoPoint, checkRequirement, checkRequirements, createRequirementError, findScriptlet, getBasePanel, getDataContainerPanel, getDataContainerUpdatingPostProcessor, getOwner, getRequiredFlowClass, getStatusMessageHandler, getUndo, globalInfo, initScriptlets, isUndoSupported, process, setBasePanel, setOwner, setUndo, setupScriptlet, showStatus, stopExecution

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

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

- Constructor Detail
  - CommandProcessor
```
public CommandProcessor()
```
    Initializes the processor. Still needs to set the owner.
    
    See Also:
    
    AbstractCommandProcessor.setOwner(AbstractScriptingEngine)
  - CommandProcessor
```
public CommandProcessor(AbstractScriptingEngine owner)
```
    Initializes the processor.
    
    Parameters:
    
    owner - the owning scripting engine
- Method Detail
  - getDatabaseConnection
```
public AbstractDatabaseConnection getDatabaseConnection()
```
    Returns the currently used database connection object, can be null.
    
    Specified by:
    
    getDatabaseConnection in class AbstractCommandProcessor
    
    Returns:
    
    the current object
  - getUndoObject
```
protected Object getUndoObject()
```
    Returns the object that is to be used for the undo point.
    
    Specified by:
    
    getUndoObject in class AbstractCommandProcessor
    
    Returns:
    
    always null
    
    See Also:
    
    AbstractCommandProcessor.addUndoPoint(String, String)