Package gda.jython

Class JythonServerFacade

java.lang.Object

gda.jython.JythonServerFacade

All Implemented Interfaces:

AliasedCommandProvider, ICommandThreadInfoProvider, TextCompleter, IAuthorisationHolder, IBatonStateProvider, ICommandAborter, ICommandRunner, ICurrentScanController, IJythonContext, IJythonNamespace, IScanDataPointProvider, IScanStatusHolder, IScriptController, ITerminalOutputProvider, ITerminalPrinter, JSFObserver, gda.observable.IObservable, gda.observable.IObserver, org.springframework.beans.factory.InitializingBean

public class JythonServerFacade
extends Object
implements gda.observable.IObserver, JSFObserver, IScanStatusHolder, ICommandRunner, ICurrentScanController, ITerminalPrinter, IJythonNamespace, IAuthorisationHolder, IScanDataPointProvider, IScriptController, ICommandAborter, IBatonStateProvider, org.springframework.beans.factory.InitializingBean, AliasedCommandProvider, IJythonContext, ITerminalOutputProvider, ICommandThreadInfoProvider, TextCompleter

Provides a single point of access for the Jython package for all Java classes. This will work whether the Java is located client-side, server-side, on the same or different ObjectServers.

This object holds inside a reference to the CommandServer object which holds inside of it the interpreter.

Calls to this class must not occur during instantiation of objects. However, if they use the Configurable interface, then this class can be used during their configure phase.

Objects should register themselves as IObservers of this object to receive updates about scans, scripts, the script queue and data from scans.

This object does not directly implement the Jython interface. This is deliberate to safely restrict what functionality is given to other classes in the GDA. Only this class should communicate directly to the local JythonServer or JythonAdapter.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JythonServerFacade(Jython commandServer)	Creates a Jython server facade, using the specified Jython command server.
protected	JythonServerFacade(Jython commandServer, String username, String fullName)	Creates a Jython server facade, using the specified Jython command server, username and fullName.

Method Summary

Modifier and Type	Method	Description
void	abortCommands()
void	addAliasedCommand(String commandName)
void	addAliasedVarargCommand(String commandName)
void	addBatonChangedObserver(gda.observable.IObserver anObserver)
void	addCommandThreadObserver(ICommandThreadObserver anObserver)
void	addIObserver(gda.observable.IObserver anIObserver)
void	addIScanDataPointObserver(IScanDataPointObserver anIObserver)	Add an object to this objects's list of IObservers.
boolean	addOutputTerminal(Terminal term)
void	addScanEventObserver(gda.observable.IObserver anObserver)	Register an object to receive ScanEvent messages to be notified of progress, but not data during scans.
void	afterPropertiesSet()
boolean	amIBatonHolder()	Checks if the caller is the holder of the baton
void	assignBaton(int receiverIndex, int currentBatonHolderIndex)
void	beamlineHalt()
void	changeVisitID(String visitID)	Switches the visit this client will collect data as when it holds the baton.
void	deleteBatonChangedObserver(gda.observable.IObserver anObserver)
void	deleteCommandThreadObserver(ICommandThreadObserver anObserver)
void	deleteIObserver(gda.observable.IObserver anIObserver)
void	deleteIObservers()
void	deleteIScanDataPointObserver(IScanDataPointObserver anIObserver)	Delete an object from this objects's list of IObservers.
boolean	deleteOutputTerminal(Terminal term)
void	deleteScanEventObserver(gda.observable.IObserver anObserver)	Delete an object from this objects's list of IObservers which receive ScanEvent messages
static void	disconnect()	Deregisters the local singleton instance from the JythonServer and sets it to null.
org.python.core.PyObject	eval(String s)	Evaluates a string as a Python expression and returns the result.
String	evaluateCommand(String command)	Runs a single line Jython command through the interpreter and returns the result in the form of a string.
void	exec(String s)	Executes a string of Python source in the local namespace.
void	executeCommand(String command)	Executes the Jython command in a new thread.
void	executeCommand(String command, InputStream stdin)
Collection<String>	getAliasedCommands()	Returns the list of alias in the GDA command server
Collection<String>	getAliasedVarargCommands()	Returns the list of variable argument alias in the GDA command server
Set<String>	getAllNamesForObject(Object obj)	Returns all names for an Object in the Jython namespace
<F extends Findable> Set<String>	getAllNamesForType(Class<F> clazz)	As a Collection, this should be able to be passed over any serialisation method and is therefore available to client code.
List<String>	getAllScriptProjectFolders()	All of the folders in which the Jython server looks for scripts.
int	getAuthorisationLevel()	Returns the current authorisation level (this value could be dynamic if a baton is in use)
int	getAuthorisationLevelAtRegistration()
ClientDetails	getBatonHolder()	Returns the baton holder from the list of known clients connected, even if the baton holder is this client.
int	getClientID()
ICommandThreadInfo[]	getCommandThreadInfo()
AutoCompletion	getCompletionsFor(String line, int posn)
static JythonServerFacade	getCurrentInstance()	Returns the local singleton instance throwing an Exception if one is required rather than logging it directly.
String	getDefaultScriptProjectFolder()	The first folder in which the Jython server looks for scripts.
Object	getFromJythonNamespace(String objectName)	Get a copy of an object from the Jython interpreter.
static JythonServerFacade	getInstance()	Returns the local singleton instance, or null if there was an exception creating it.
IScanDataPoint	getLastScanDataPoint()
List<UserMessage>	getMessageHistory()	Returns previous messages sent during this visit.
ClientDetails	getMyDetails()	Returns the current ClientDetails for this client.
ClientDetails[]	getOtherClientInformation()
String	getProjectNameForPath(String path)	Given the path to a Jython project, return its name.
JythonStatus	getScanStatus()
Optional<String>	getScriptName()	Returns the name of the currently running script, if present
JythonStatus	getScriptStatus()
JythonServerStatus	getServerStatus()
String	getStartupOutput()
static JythonServerFacade	getUnattendedClientFacade()
boolean	hasAlias(String command)	Checks if the the given command is aliased (either vararg or not)
boolean	isBatonHeld()	This checks if the baton is held, at all, by any client.
boolean	isFinishEarlyRequested()
boolean	isScanRunning()
String	locateScript(String scriptToRun)	Find a script with given name in the GDA's script project folders.
void	pauseCurrentScan()
void	pauseCurrentScript()
void	placeInJythonNamespace(String objectName, Object obj)	Pass a copy of an object to the Jython interpreter.
void	print(String text)	Print to Jython console on all clients (and notify anything added via addOutputTerminal(Terminal)).
boolean	projectIsConfigType(String path)	Whether a project specified by path is a configuration project.
boolean	projectIsCoreType(String path)	Whether a project specified by path is a core project.
boolean	projectIsUserType(String path)	Whether a project specified by path is a user project.
void	removeAliasedCommand(String commandName)
boolean	requestBaton()
void	requestFinishEarly()	Call requestFinishEarly() on the current scan.
void	restartCurrentScan()
void	resumeCurrentScan()
void	resumeCurrentScript()
void	returnBaton()
void	revertToOriginalUser()	Reverts to the original user this client was initially logged in as.
Thread	runAsJython(Runnable task)	Run the given task in a Jython thread - allows it to be linked to a specific client and be restricted by its authorization level.
void	runCommand(String command)	Executes the Jython command in a new thread.
CommandThreadEvent	runScript(File script)	Runs the Jython script, and changes the ScriptStatus as is goes.
CommandThreadEvent	runScript(String scriptContents)	Runs the jython command string, and changes the ScriptStatus as is goes.
boolean	runsource(String command)	Similar to ICommandRunner.runCommand(java.lang.String), except that a boolean is returned if the command was complete or if additional lines of a multi-line command are required.
boolean	runsource(String command, InputStream stdin)	Similar to runsource(java.lang.String) but allows a specific InputStream to be used.
void	sendMessage(String message)	Broadcast a message to other users on this beamline.
void	setRawInput(String theRawInput)
void	setScriptStatus(JythonStatus status)
boolean	switchUser(String username, String password)
String	toString()
void	update(Object dataSource, Object data)

Methods inherited from class java.lang.Object

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

Constructor Details

JythonServerFacade

protected JythonServerFacade(Jython commandServer)
                      throws InstantiationException

Creates a Jython server facade, using the specified Jython command server.

Parameters:

commandServer - the Jython command server

Throws:

InstantiationException

JythonServerFacade

protected JythonServerFacade(Jython commandServer,
 String username,
 String fullName)
                      throws InstantiationException

Creates a Jython server facade, using the specified Jython command server, username and fullName.

Parameters:

commandServer - the Jython command server

username - the username of the person using this JSF

fullName - the full name of the person using this JSF

Throws:

InstantiationException

Method Details

getInstance

public static JythonServerFacade getInstance()

Returns the local singleton instance, or null if there was an exception creating it.

Returns:

JythonServerFacade

getCurrentInstance

public static JythonServerFacade getCurrentInstance()
                                             throws InstantiationException

Returns the local singleton instance throwing an Exception if one is required rather than logging it directly.

Returns:

JythonServerFacade

Throws:

InstantiationException

disconnect

public static void disconnect()

Deregisters the local singleton instance from the JythonServer and sets it to null. This should only be used when shutting down the process.

getUnattendedClientFacade

public static JythonServerFacade getUnattendedClientFacade()
                                                    throws InstantiationException

Returns:

The JSf singleton for unattended data collections

Throws:

InstantiationException

getAuthorisationLevel

public int getAuthorisationLevel()

Returns the current authorisation level (this value could be dynamic if a baton is in use)

Specified by:

getAuthorisationLevel in interface IAuthorisationHolder

Returns:

the authorisationLevel at this moment in time

getAuthorisationLevelAtRegistration

public int getAuthorisationLevelAtRegistration()

Specified by:

getAuthorisationLevelAtRegistration in interface IAuthorisationHolder

Returns:

the authorisation level ignoring any current baton status

getClientID

public int getClientID()

Returns:

the index (public id) of this Client.

runScript

public CommandThreadEvent runScript(String scriptContents)

Runs the jython command string, and changes the ScriptStatus as is goes.

Non-blocking, Interruptible, Script locked.
See ICommandRunner for the other options.

Specified by:

runScript in interface ICommandRunner

Parameters:

scriptContents - to run

Returns:

status

runScript

public CommandThreadEvent runScript(File script)

Description copied from interface: ICommandRunner

Runs the Jython script, and changes the ScriptStatus as is goes.

Non-blocking, Interruptible, Script locked.
See ICommandRunner for the other options.

Specified by:

runScript in interface ICommandRunner

Parameters:

script - to run

Returns:

status

runCommand

public void runCommand(String command)

Description copied from interface: ICommandRunner

Executes the Jython command in a new thread.

Non-blocking, Interruptible, Not script locked.
See ICommandRunner for the other options.

Specified by:

runCommand in interface ICommandRunner

Parameters:

command - to run

executeCommand

public void executeCommand(String command)
                    throws ScriptExecutionException

Description copied from interface: ICommandRunner

Executes the Jython command in a new thread.

Blocking, Interruptible, Not script locked and throws ScriptExecutionException

Specified by:

executeCommand in interface ICommandRunner

Parameters:

command -

Throws:

ScriptExecutionException

executeCommand

public void executeCommand(String command,
 InputStream stdin)
                    throws ScriptExecutionException

Throws:

ScriptExecutionException

evaluateCommand

public String evaluateCommand(String command)

Description copied from interface: ICommandRunner

Runs a single line Jython command through the interpreter and returns the result in the form of a string. Note: this method waits until the command has finished so it can return the result. If the command takes a long time it will hang the thread which calls this method. So this method must be called in a separate thread from the main GUI thread, else the GUI will seize up until the command given to this method has returned. For an example of the, see the gda.jython.JythonTerminal class.

Blocking, Not interruptible, Not script locked.
See ICommandRunner for the other options.

Specified by:

evaluateCommand in interface ICommandRunner

Parameters:

command - to run

Returns:

the string representation of the result

runAsJython

public Thread runAsJython(Runnable task)

Run the given task in a Jython thread - allows it to be linked to a specific client and be restricted by its authorization level. Requires this facade to be on the server

requestFinishEarly

public void requestFinishEarly()

Description copied from interface: ICurrentScanController

Call requestFinishEarly() on the current scan.

Specified by:

requestFinishEarly in interface ICurrentScanController

isFinishEarlyRequested

public boolean isFinishEarlyRequested()

Specified by:

isFinishEarlyRequested in interface ICurrentScanController

Returns:

true if a request for the current scan to finish early has been made (probably via a gui).

pauseCurrentScan

public void pauseCurrentScan()

Specified by:

pauseCurrentScan in interface ICurrentScanController

resumeCurrentScan

public void resumeCurrentScan()

Specified by:

resumeCurrentScan in interface ICurrentScanController

restartCurrentScan

public void restartCurrentScan()

Specified by:

restartCurrentScan in interface ICurrentScanController

beamlineHalt

public void beamlineHalt()

Specified by:

beamlineHalt in interface ICommandAborter

See Also:

• Jython.beamlineHalt(String)

abortCommands

public void abortCommands()

Specified by:

abortCommands in interface ICommandAborter

See Also:

• Jython.abortCommands(String)

pauseCurrentScript

public void pauseCurrentScript()

Specified by:

pauseCurrentScript in interface IScriptController

See Also:

• Jython.pauseCurrentScript(java.lang.String)

resumeCurrentScript

public void resumeCurrentScript()

Specified by:

resumeCurrentScript in interface IScriptController

See Also:

• Jython.resumeCurrentScript(java.lang.String)

update

public void update(Object dataSource,
 Object data)

Specified by:

update in interface IBatonStateProvider

Specified by:

update in interface gda.observable.IObserver

Parameters:

dataSource -

data -

runsource

public boolean runsource(String command)

Description copied from interface: ICommandRunner

Similar to ICommandRunner.runCommand(java.lang.String), except that a boolean is returned if the command was complete or if additional lines of a multi-line command are required. Used only by the JythonTerminal to determine which prompt to display. Note: this method waits until the command has finished so it can return the result. If the command takes a long time it will hang the thread which calls this method. So this method must be called in a separate thread from the main GUI thread, else the GUI will seize up until the command given to this method has returned.

Blocking, Interruptible, Not script locked.
See ICommandRunner for the other options.

Specified by:

runsource in interface ICommandRunner

Parameters:

command - to run

Returns:

true if command was incomplete and more is required (eg "if True:"), false otherwise (including on error)

See Also:

• Jython.runsource(java.lang.String, java.lang.String)

runsource

public boolean runsource(String command,
 InputStream stdin)

Similar to runsource(java.lang.String) but allows a specific InputStream to be used.

Parameters:

command - to run

stdin - input stream to use as stdin for this command

Returns:

true if more is needed, false if not

See Also:

• Jython.runsource(String, String, InputStream)
• ICommandRunner

getScriptStatus

public JythonStatus getScriptStatus()

Specified by:

getScriptStatus in interface IScriptController

Returns:

status see values in Jython e.g. JYTHON.IDLE

setRawInput

public void setRawInput(String theRawInput)

getScanStatus

public JythonStatus getScanStatus()

Specified by:

getScanStatus in interface IScanStatusHolder

Returns:

status of Jython scan e.g. JythonStatus.IDLE

getServerStatus

public JythonServerStatus getServerStatus()

getScriptName

public Optional<String> getScriptName()

Description copied from interface: IScriptController

Returns the name of the currently running script, if present

Specified by:

getScriptName in interface IScriptController

Returns:

name of current script

isScanRunning

public boolean isScanRunning()

Specified by:

isScanRunning in interface IScanStatusHolder

Returns:

true if a scan is running, false otherwise

setScriptStatus

public void setScriptStatus(JythonStatus status)

Specified by:

setScriptStatus in interface IScriptController

Parameters:

status - see values in Jython e.g. JYTHON.IDLE

addIObserver

public void addIObserver(gda.observable.IObserver anIObserver)

Specified by:

addIObserver in interface gda.observable.IObservable

deleteIObserver

public void deleteIObserver(gda.observable.IObserver anIObserver)

Specified by:

deleteIObserver in interface gda.observable.IObservable

deleteIObservers

public void deleteIObservers()

Specified by:

deleteIObservers in interface gda.observable.IObservable

placeInJythonNamespace

public void placeInJythonNamespace(String objectName,
 Object obj)

Description copied from interface: IJythonNamespace

Pass a copy of an object to the Jython interpreter. This object must be relatively simple otherwise it will not be passed over CORBA successfully. So the object must be a native type (or only contain native types) and must not have any object references inside.

Specified by:

placeInJythonNamespace in interface IJythonNamespace

Parameters:

objectName -

obj -

getFromJythonNamespace

public Object getFromJythonNamespace(String objectName)

Description copied from interface: IJythonNamespace

Get a copy of an object from the Jython interpreter. Note that the retrieved object will have to be cast by the local code. As the object will be passed over CORBA, this method should only be used on native types or classes containing only native types.

Specified by:

getFromJythonNamespace in interface IJythonNamespace

Parameters:

objectName -

Returns:

Object

print

public void print(String text)

Print to Jython console on all clients (and notify anything added via addOutputTerminal(Terminal)). Makes it easy for strings to be printed on the console and not anywhere else.

Specified by:

print in interface ITerminalPrinter

Parameters:

text - the string to be printed

getStartupOutput

public String getStartupOutput()

Returns:

string of the message from the last (re)start of the Command Server

See Also:

• Jython.getStartupOutput(String)

addAliasedCommand

public void addAliasedCommand(String commandName)

addAliasedVarargCommand

public void addAliasedVarargCommand(String commandName)

removeAliasedCommand

public void removeAliasedCommand(String commandName)

requestBaton

public boolean requestBaton()

Specified by:

requestBaton in interface IBatonStateProvider

Returns:

boolean

See Also:

• Jython.requestBaton(String)

returnBaton

public void returnBaton()

Specified by:

returnBaton in interface IBatonStateProvider

See Also:

• Jython.requestBaton(String)

assignBaton

public void assignBaton(int receiverIndex,
 int currentBatonHolderIndex)

Specified by:

assignBaton in interface IBatonStateProvider

Parameters:

receiverIndex -

currentBatonHolderIndex -

See Also:

• Jython.assignBaton(String,int,int)

switchUser

public boolean switchUser(String username,
 String password)

Specified by:

switchUser in interface IBatonStateProvider

Parameters:

username -

password -

Returns:

true if switch successful

See Also:

• Jython.switchUser(String,String,String)

revertToOriginalUser

public void revertToOriginalUser()

Reverts to the original user this client was initially logged in as.

Specified by:

revertToOriginalUser in interface IBatonStateProvider

See Also:

• Jython.switchUser(String,String,String)

changeVisitID

public void changeVisitID(String visitID)

Switches the visit this client will collect data as when it holds the baton.

Specified by:

changeVisitID in interface IBatonStateProvider

Parameters:

visitID -

getOtherClientInformation

public ClientDetails[] getOtherClientInformation()

Specified by:

getOtherClientInformation in interface IBatonStateProvider

Returns:

ClientDetails[]

See Also:

• Jython.getOtherClientInformation(String)

getBatonHolder

public ClientDetails getBatonHolder()

Description copied from interface: IBatonStateProvider

Returns the baton holder from the list of known clients connected, even if the baton holder is this client.

Specified by:

getBatonHolder in interface IBatonStateProvider

Returns:

ClientDetails

amIBatonHolder

public boolean amIBatonHolder()

Description copied from interface: IBatonStateProvider

Checks if the caller is the holder of the baton

Specified by:

amIBatonHolder in interface IBatonStateProvider

Returns:

true if the caller holds the baton false otherwise

See Also:

• Jython.amIBatonHolder(String)

isBatonHeld

public boolean isBatonHeld()

Description copied from interface: IBatonStateProvider

This checks if the baton is held, at all, by any client. It does not check it the caller is the baton holder.

Specified by:

isBatonHeld in interface IBatonStateProvider

Returns:

true if the baton is held by any client, false otherwise

See Also:

• to check if the caller is the baton holder
• Jython.isBatonHeld()

sendMessage

public void sendMessage(String message)

Description copied from interface: IBatonStateProvider

Broadcast a message to other users on this beamline. Such messages will be displayed in a special viewer.

Specified by:

sendMessage in interface IBatonStateProvider

Parameters:

message -

getMessageHistory

public List<UserMessage> getMessageHistory()

Description copied from interface: IBatonStateProvider

Returns previous messages sent during this visit.

Specified by:

getMessageHistory in interface IBatonStateProvider

addIScanDataPointObserver

public void addIScanDataPointObserver(IScanDataPointObserver anIObserver)

Description copied from interface: IScanDataPointProvider

Add an object to this objects's list of IObservers.

Specified by:

addIScanDataPointObserver in interface IScanDataPointProvider

Parameters:

anIObserver - object that implement IObserver and wishes to be notified by this object

deleteIScanDataPointObserver

public void deleteIScanDataPointObserver(IScanDataPointObserver anIObserver)

Description copied from interface: IScanDataPointProvider

Delete an object from this objects's list of IObservers.

Specified by:

deleteIScanDataPointObserver in interface IScanDataPointProvider

Parameters:

anIObserver - object that implement IObserver and wishes to be notified by this object

getLastScanDataPoint

public IScanDataPoint getLastScanDataPoint()

Specified by:

getLastScanDataPoint in interface IScanDataPointProvider

addBatonChangedObserver

public void addBatonChangedObserver(gda.observable.IObserver anObserver)

Specified by:

addBatonChangedObserver in interface IBatonStateProvider

Parameters:

anObserver -

deleteBatonChangedObserver

public void deleteBatonChangedObserver(gda.observable.IObserver anObserver)

Specified by:

deleteBatonChangedObserver in interface IBatonStateProvider

Parameters:

anObserver -

toString

public String toString()

Overrides:

toString in class Object

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

addScanEventObserver

public void addScanEventObserver(gda.observable.IObserver anObserver)

Description copied from interface: IScanDataPointProvider

Register an object to receive ScanEvent messages to be notified of progress, but not data during scans.

Specified by:

addScanEventObserver in interface IScanDataPointProvider

Parameters:

anObserver -

deleteScanEventObserver

public void deleteScanEventObserver(gda.observable.IObserver anObserver)

Description copied from interface: IScanDataPointProvider

Delete an object from this objects's list of IObservers which receive ScanEvent messages

Specified by:

deleteScanEventObserver in interface IScanDataPointProvider

Parameters:

anObserver -

addCommandThreadObserver

public void addCommandThreadObserver(ICommandThreadObserver anObserver)

Specified by:

addCommandThreadObserver in interface ICommandThreadInfoProvider

deleteCommandThreadObserver

public void deleteCommandThreadObserver(ICommandThreadObserver anObserver)

Specified by:

deleteCommandThreadObserver in interface ICommandThreadInfoProvider

getCommandThreadInfo

public ICommandThreadInfo[] getCommandThreadInfo()

Specified by:

getCommandThreadInfo in interface ICommandThreadInfoProvider

getMyDetails

public ClientDetails getMyDetails()

Description copied from interface: IBatonStateProvider

Returns the current ClientDetails for this client. What is returned will change depending on the baton status and if the user has been switched using the switchUser method.

The authorisationLevel returned takes into account any alternate user, but not whether the baton is held. For this, call getAuthorisationLevel().

Specified by:

getMyDetails in interface IBatonStateProvider

Returns:

ClientDetails

getAliasedCommands

public Collection<String> getAliasedCommands()

Description copied from interface: AliasedCommandProvider

Returns the list of alias in the GDA command server

Specified by:

getAliasedCommands in interface AliasedCommandProvider

Returns:

the aliased commands

getAliasedVarargCommands

public Collection<String> getAliasedVarargCommands()

Description copied from interface: AliasedCommandProvider

Returns the list of variable argument alias in the GDA command server

Specified by:

getAliasedVarargCommands in interface AliasedCommandProvider

Returns:

the list of variable argument alias

hasAlias

public boolean hasAlias(String command)

Description copied from interface: AliasedCommandProvider

Checks if the the given command is aliased (either vararg or not)

Specified by:

hasAlias in interface AliasedCommandProvider

Parameters:

command - the string to check

Returns:

whether the command is aliased or not

getAllNamesForObject

public Set<String> getAllNamesForObject(Object obj)
                                 throws DeviceException

Description copied from interface: IJythonNamespace

Returns all names for an Object in the Jython namespace

Specified by:

getAllNamesForObject in interface IJythonNamespace

Parameters:

obj -

Returns:

All names that refer to the Object in the Jython namespace

Throws:

DeviceException

getAllNamesForType

public <F extends Findable> Set<String> getAllNamesForType(Class<F> clazz)

Description copied from interface: IJythonNamespace

As a Collection, this should be able to be passed over any serialisation method and is therefore available to client code. We may have e.g. Scannables written entirely in Jython that we may not be able to pass across, meaning the similar method LocalJython#getAllObjectsOfType is limited to server side.

Specified by:

getAllNamesForType in interface IJythonNamespace

Parameters:

clazz - a Class extending Findable

Returns:

a set of all names of all objects of a type in the Jython namespace.

locateScript

public String locateScript(String scriptToRun)

Description copied from interface: ICommandRunner

Find a script with given name in the GDA's script project folders.

Specified by:

locateScript in interface ICommandRunner

Parameters:

scriptToRun - The name of a Jython script file.

Returns:

A path to the script in one of the project folders. The first file with matching name will be returned, or null if no file could be located.

getDefaultScriptProjectFolder

public String getDefaultScriptProjectFolder()

Description copied from interface: IJythonContext

The first folder in which the Jython server looks for scripts.

Specified by:

getDefaultScriptProjectFolder in interface IJythonContext

Returns:

A path to the default location for Jython scripts.

getAllScriptProjectFolders

public List<String> getAllScriptProjectFolders()

Description copied from interface: IJythonContext

All of the folders in which the Jython server looks for scripts.

Specified by:

getAllScriptProjectFolders in interface IJythonContext

Returns:

A list of paths to the Jython script project folders.

getProjectNameForPath

public String getProjectNameForPath(String path)

Description copied from interface: IJythonContext

Given the path to a Jython project, return its name.

Specified by:

getProjectNameForPath in interface IJythonContext

Parameters:

path - The path to a Jython script project.

Returns:

The name of the specified Jython project. If the path is not a known project, then null is returned.

projectIsUserType

public boolean projectIsUserType(String path)

Description copied from interface: IJythonContext

Whether a project specified by path is a user project.

Specified by:

projectIsUserType in interface IJythonContext

Parameters:

path - The project folder path.

Returns:

true if the project exists and is a user project.

projectIsConfigType

public boolean projectIsConfigType(String path)

Description copied from interface: IJythonContext

Whether a project specified by path is a configuration project.

Specified by:

projectIsConfigType in interface IJythonContext

Parameters:

path - The project folder path.

Returns:

true if the project exists and is a config project.

projectIsCoreType

public boolean projectIsCoreType(String path)

Description copied from interface: IJythonContext

Whether a project specified by path is a core project.

Specified by:

projectIsCoreType in interface IJythonContext

Parameters:

path - The project folder path.

Returns:

true if the project exists and is a core project.

addOutputTerminal

public boolean addOutputTerminal(Terminal term)

Specified by:

addOutputTerminal in interface ITerminalOutputProvider

deleteOutputTerminal

public boolean deleteOutputTerminal(Terminal term)

Specified by:

deleteOutputTerminal in interface ITerminalOutputProvider

eval

public org.python.core.PyObject eval(String s)
                              throws org.python.core.PyException

Evaluates a string as a Python expression and returns the result. Bypasses translator, batton control, and is not available across corba.

This is of particular utility compared to other offerings as calls are synchronous, throw exceptions and can return an actual object.

Throws:

org.python.core.PyException

exec

public void exec(String s)
          throws org.python.core.PyException

Executes a string of Python source in the local namespace. Bypasses translator, batton control, and is not available across corba.

This is of particular utility compared to other offerings as calls are synchronous and throw exceptions.

Throws:

org.python.core.PyException

getCompletionsFor

public AutoCompletion getCompletionsFor(String line,
 int posn)

Specified by:

getCompletionsFor in interface TextCompleter