Package adams.gui.scripting

Class ScriptingEngine

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.scripting.AbstractScriptingEngine

adams.gui.scripting.ScriptingEngine

All Implemented Interfaces:

ErrorProvider, LoggingSupporter, SizeOfHandler, DatabaseConnectionHandler, DatabaseConnectionProvider, DatabaseConnectionUser, DatabaseConnectionChangeListener, Serializable

public class ScriptingEngine
extends AbstractScriptingEngine

Processes scripting commands.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.gui.scripting.AbstractScriptingEngine

ALTERNATIVE_COMMAND_PROCESSOR, COMMAND_PROCESSOR, COMMENT, FILENAME, LOG_FILE, m_DbConn, m_History, m_LastError, m_LoggingEnabled, m_ProcessingThread, m_Processor, m_Recorded, m_Recording, m_ScriptingInfoListeners, SCRIPT_DIRECTORY

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ScriptingEngine()

Method Summary

Modifier and Type	Method	Description
protected AbstractDatabaseConnection	getDefaultDatabaseConnection()	Returns the default database connection.
protected String	getDefinitionKey()	Returns the properties key to use for retrieving the properties.
protected Properties	getProperties()	Provides access to the properties object.
static AbstractScriptingEngine	getSingleton(AbstractDatabaseConnection dbcon)	Returns the singleton instance of the scripting engine.
static void	stopAllEngines()	Stops all scripting engines.

Methods inherited from class adams.gui.scripting.AbstractScriptingEngine

add, add, add, add, add, add, addScriptingInfoListener, addToHistory, check, clear, databaseConnectionStateChanged, filter, filter, getAvailableScripts, getAvailableScripts, getCommandHistory, getDatabaseConnection, getLastError, getProcessingThread, getProcessor, getRecordedCommands, getScriptsHome, hasLastError, hasRecording, isEmpty, isProcessing, isRecording, load, notifyScriptingInfoListeners, readProperties, removeScriptingInfoListener, save, save, setDatabaseConnection, setLastError, startRecording, stop, stopEngine, stopRecording, updatePrefix

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

ScriptingEngine

public ScriptingEngine()

Method Detail

getDefaultDatabaseConnection

protected AbstractDatabaseConnection getDefaultDatabaseConnection()

Returns the default database connection.

Specified by:

getDefaultDatabaseConnection in class AbstractScriptingEngine

Returns:

the default database connection

getDefinitionKey

protected String getDefinitionKey()

Returns the properties key to use for retrieving the properties.

Specified by:

getDefinitionKey in class AbstractScriptingEngine

Returns:

the key

getProperties

protected Properties getProperties()

Provides access to the properties object.

Specified by:

getProperties in class AbstractScriptingEngine

Returns:

the properties

getSingleton

public static AbstractScriptingEngine getSingleton(AbstractDatabaseConnection dbcon)

Returns the singleton instance of the scripting engine.

Parameters:

dbcon - the database context

Returns:

the singleton

stopAllEngines

public static void stopAllEngines()

Stops all scripting engines.