Package gda.jython.scriptcontroller.logging

Class LoggingScriptController

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.jython.scriptcontroller.ScriptControllerBase

gda.jython.scriptcontroller.logging.LoggingScriptController

All Implemented Interfaces:

Configurable, Findable, ILoggingScriptController, Scriptcontroller, gda.observable.IObservable

@ServiceInterface(ILoggingScriptController.class)
public class LoggingScriptController
extends ScriptControllerBase
implements ILoggingScriptController

A script controller which logs in a Derby database all the ScriptControllerLoggingMessage objects which are passed through it.

It provides the tools to enable other classes to extract information about the contents of the database.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	url

Fields inherited from interface gda.jython.scriptcontroller.Scriptcontroller

SCRIPT_RUNNER_END_MARKER, SCRIPT_RUNNER_ERROR_MARKER, SCRIPT_RUNNER_RUNNING_MARKER, SCRIPT_RUNNER_START_MARKER

Constructor Summary

Constructors

Constructor	Description
LoggingScriptController()

Method Summary

Modifier and Type	Method	Description
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
static String	createUniqueID(String key)
ScriptControllerLogResultDetails	getDetails(String uniqueID)
String	getDirectory()
Class<? extends ScriptControllerLoggingMessage>	getMessageClassToLog()
ScriptControllerLogResultDetails	getMostRecentRun()
ScriptControllerLogResults[]	getTable()
void	reconfigure()	Re-initialisation of values and states.
void	setDirectory(String directory)
void	setMessageClassToLog(Class<? extends ScriptControllerLoggingMessage> messageClassToLog)
void	update(Object o, Object arg)	Expects arg is of the class messageClassToLog.

Methods inherited from class gda.jython.scriptcontroller.ScriptControllerBase

addIObserver, addParameter, deleteIObserver, deleteIObservers, getCommand, getCommandFormat, getImportCommand, getParametersName, notifyIObservers, readParameters, run, setCommand, setCommandFormat, setImportCommand, setParametersName

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

isConfigureAtStartup, isConfigured, setConfigured

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.jython.scriptcontroller.Scriptcontroller

addParameter, getCommand, getImportCommand, getParametersName, notifyIObservers, setCommand, setImportCommand, setParametersName

Field Details

url

protected String url

Constructor Details

LoggingScriptController

public LoggingScriptController()

Method Details

createUniqueID

public static String createUniqueID(String key)

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ScriptControllerBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

reconfigure

public void reconfigure()
                 throws FactoryException

Description copied from interface: Configurable

Re-initialisation of values and states.

Moved from Reconfigurable which has been deleted

Specified by:

reconfigure in interface Configurable

Overrides:

reconfigure in class ScriptControllerBase

Throws:

FactoryException

update

public void update(Object o,
 Object arg)

Expects arg is of the class messageClassToLog.

Specified by:

update in interface Scriptcontroller

Overrides:

update in class ScriptControllerBase

Parameters:

o - the observed component

arg - the data to be sent to the observer.

getTable

public ScriptControllerLogResults[] getTable()

Specified by:

getTable in interface ILoggingScriptController

getDetails

public ScriptControllerLogResultDetails getDetails(String uniqueID)

Specified by:

getDetails in interface ILoggingScriptController

getMostRecentRun

public ScriptControllerLogResultDetails getMostRecentRun()

Specified by:

getMostRecentRun in interface ILoggingScriptController

getMessageClassToLog

public Class<? extends ScriptControllerLoggingMessage> getMessageClassToLog()

setMessageClassToLog

public void setMessageClassToLog(Class<? extends ScriptControllerLoggingMessage> messageClassToLog)

getDirectory

public String getDirectory()

setDirectory

public void setDirectory(String directory)