org.youscope.common.job.basicjobs

Interface ScriptingJob

All Superinterfaces:

Component, EditableJobContainer, Job, JobContainer, java.rmi.Remote

public interface ScriptingJob
extends Job, EditableJobContainer

A scripting job executes a script every time it runs, and-depending on the script-its child jobs.

Author:

Moritz Lang

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_TYPE_IDENTIFIER The type identifier of the default implementation of this job.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getScriptEngine() Returns the name of the script engine, or null, if script engine is not set.
java.net.URL	getScriptFile() Returns the file of the script which should be evaluated by the corresponding script engine.
void	putVariable(java.lang.String key, java.lang.Object value) Adds a key value pair to the script engine, so that a variable with the name can be used in the script.
void	setRemoteScriptEngine(RemoteScriptEngine scriptEngine) Sets the remote script engine which should be null.
void	setScriptEngine(java.lang.String engine) Sets the script engine with which the scripts should be evaluated.
void	setScriptFile(java.net.URL scriptFile) Sets the file of the script which should be evaluated by the corresponding script engine.

Methods inherited from interface org.youscope.common.job.Job

addJobListener, executeJob, initializeJob, removeJobListener, uninitializeJob

Methods inherited from interface org.youscope.common.Component

addMessageListener, getName, getPositionInformation, getUUID, removeMessageListener, setName

Methods inherited from interface org.youscope.common.job.EditableJobContainer

addJob, clearJobs, insertJob, removeJob

Methods inherited from interface org.youscope.common.job.JobContainer

getJob, getJobs, getNumJobs

Field Detail

DEFAULT_TYPE_IDENTIFIER

static final java.lang.String DEFAULT_TYPE_IDENTIFIER

The type identifier of the default implementation of this job. Basic jobs are considered such essential to YouScope such that their interfaces are made part of the shared library. However, their implementation are not, and there might be several addons providing (different) implementations of this job. Most of these implementations, however, are specific for a given application and not general. The addon exposing this identifier should be general, that is, every other part of YouScope accessing this job over the default identifier is expecting the job to behave in the general way. Only one implementation (addon) should expose the default identifier. Typically, this implementation is already part of YouScope, such that implementing this addon is not necessary. However, there might be cases when the default implementation should be overwritten, which is why the interface, but not the implementation is part of YouScope's core elements. In this case, the default implementation already part of YouScope should be removed (i.e. the corresponding default plug-in deleted).

See Also:

Constant Field Values

Method Detail

putVariable

void putVariable(java.lang.String key,
                 java.lang.Object value)
          throws java.rmi.RemoteException,
                 MeasurementRunningException

Adds a key value pair to the script engine, so that a variable with the name can be used in the script.

Parameters:

key - Name of variable to be used in script.

value - Value of the variable.

Throws:

java.rmi.RemoteException

MeasurementRunningException

setRemoteScriptEngine

void setRemoteScriptEngine(RemoteScriptEngine scriptEngine)
                    throws java.rmi.RemoteException,
                           MeasurementRunningException

Sets the remote script engine which should be null.

Parameters:

scriptEngine - Sets the script engine to use.

Throws:

java.rmi.RemoteException

MeasurementRunningException

setScriptEngine

void setScriptEngine(java.lang.String engine)
              throws java.rmi.RemoteException,
                     MeasurementRunningException

Sets the script engine with which the scripts should be evaluated. If a remote script engine is set, this setting is ignored.

Parameters:

engine - The script engine to use.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getScriptEngine

java.lang.String getScriptEngine()
                          throws java.rmi.RemoteException

Returns the name of the script engine, or null, if script engine is not set.

Returns:

Script engine factory name.

Throws:

java.rmi.RemoteException

setScriptFile

void setScriptFile(java.net.URL scriptFile)
            throws java.rmi.RemoteException,
                   MeasurementRunningException

Sets the file of the script which should be evaluated by the corresponding script engine.

Parameters:

scriptFile - The file containing the script which should be evaluated.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getScriptFile

java.net.URL getScriptFile()
                    throws java.rmi.RemoteException

Returns the file of the script which should be evaluated by the corresponding script engine.

Returns:

The file containing the script which should be evaluated, or null, if not set.

Throws:

java.rmi.RemoteException