org.youscope.common.job

Class JobAdapter

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.youscope.common.job.JobAdapter

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, Component, Job

Direct Known Subclasses:

EditableJobContainerAdapter

public abstract class JobAdapter
extends java.rmi.server.UnicastRemoteObject
implements Job

Convenient adapter class to implement a job. Basic required functionality (evaluation counting, job listener notifications, ...) of a job is already implemented.

Author:

Moritz Lang

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor and Description
JobAdapter(PositionInformation positionInformation) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addJobListener(JobListener listener) Adds a listener which should e.g.
void	addMessageListener(MessageListener writer) Adds a message listener to which (non-error) status information is send.
protected void	assertRunning() Convenient method to throw an exception if a parameter of a job should be changed, but the job is currently executed.
void	executeJob(ExecutionInformation executionInformation, Microscope microscope, MeasurementContext measurementContext) The standard implementation of this function automatically takes care for evaluation counting and the notification of listeners.
abstract java.lang.String	getDefaultName() Should return a default name for the job type which gets returned by getJobName() if no job name was set explicitly by setJobName.
java.lang.String	getName() Returns a name of the component meant for human interpretation.
PositionInformation	getPositionInformation() Returns the component's position information, e.g.
java.util.UUID	getUUID() Returns a unique ID of the component.
void	initializeJob(Microscope microscope, MeasurementContext measurementContext) When overwriting this function, the base implementation should be called at the beginning, i.e.
boolean	isRunning() Returns true if the measurement the job belongs to is currently executed.
void	removeJobListener(JobListener listener) Removes a previously added listener.
void	removeMessageListener(MessageListener writer) Removes a previously added listener.
abstract void	runJob(ExecutionInformation executionInformation, Microscope microscope, MeasurementContext measurementContext) Convenient function which gets called by executeJob().
protected void	sendErrorMessage(java.lang.String message, java.lang.Throwable error)
protected void	sendMessage(java.lang.String message) Sends the given message to all output writers.
void	setName(java.lang.String jobName) Sets the name of the component meant for human interpretation.
void	uninitializeJob(Microscope microscope, MeasurementContext measurementContext) When overwriting this function, the base implementation should be called at the beginning, i.e.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobAdapter

public JobAdapter(PositionInformation positionInformation)
           throws java.rmi.RemoteException

Constructor.

Parameters:

positionInformation - The logical position where this job is executed. Must not be null.

Throws:

java.rmi.RemoteException

Method Detail

assertRunning

protected void assertRunning()
                      throws MeasurementRunningException

Convenient method to throw an exception if a parameter of a job should be changed, but the job is currently executed. Should be called at the beginning of every function which is manipulating the parameters of the job (i.e. all "set" methods).

Throws:

JobRunningException

MeasurementRunningException

isRunning

public boolean isRunning()

Returns true if the measurement the job belongs to is currently executed.

Returns:

True if the job is currently executed.

executeJob

public void executeJob(ExecutionInformation executionInformation,
                       Microscope microscope,
                       MeasurementContext measurementContext)
                throws JobException,
                       java.lang.InterruptedException,
                       java.rmi.RemoteException

The standard implementation of this function automatically takes care for evaluation counting and the notification of listeners. Do not overwrite this function, but runJob() instead (which is called by this implementation)

Specified by:

executeJob in interface Job

Parameters:

executionInformation - Information about how many times the job has been executed, and if it is executed in a loop.

microscope - Interface to control and get information of the microscope.

measurementContext - the context of the measurement, allowing to transfer data between measurement components and similar.

Throws:

JobException

java.lang.InterruptedException

java.rmi.RemoteException

runJob

public abstract void runJob(ExecutionInformation executionInformation,
                            Microscope microscope,
                            MeasurementContext measurementContext)
                     throws JobException,
                            java.lang.InterruptedException,
                            java.rmi.RemoteException

Convenient function which gets called by executeJob(). Does not have to take care for execution counting and notification of job listeners. Overwrite this method instead of executeJob.

Parameters:

executionInformation - Information about the number of times, and the loops, in which this job is executed.

microscope - The microscope on which this job should be executed.

measurementContext - the context of the measurement, allowing to transfer data between measurement components and similar.

Throws:

JobException

java.lang.InterruptedException

java.rmi.RemoteException

getPositionInformation

public PositionInformation getPositionInformation()

Description copied from interface: Component

Returns the component's position information, e.g. in which well, tile, or z-stack location it is.

Specified by:

getPositionInformation in interface Component

Returns:

Position information vector.

addJobListener

public void addJobListener(JobListener listener)
                    throws java.rmi.RemoteException

Description copied from interface: Job

Adds a listener which should e.g. be invoked after each evaluation of the job (at the end of the implementation of runJob().

Specified by:

addJobListener in interface Job

Parameters:

listener - The listener to add.

Throws:

java.rmi.RemoteException

removeJobListener

public void removeJobListener(JobListener listener)
                       throws java.rmi.RemoteException

Description copied from interface: Job

Removes a previously added listener.

Specified by:

removeJobListener in interface Job

Parameters:

listener - The listener to be removed.

Throws:

java.rmi.RemoteException

addMessageListener

public void addMessageListener(MessageListener writer)

Description copied from interface: Component

Adds a message listener to which (non-error) status information is send.

Specified by:

addMessageListener in interface Component

Parameters:

writer - Listener to which output should be written.

removeMessageListener

public void removeMessageListener(MessageListener writer)

Description copied from interface: Component

Removes a previously added listener.

Specified by:

removeMessageListener in interface Component

Parameters:

writer - Listener which should be removed.

sendMessage

protected void sendMessage(java.lang.String message)

Sends the given message to all output writers.

Parameters:

message - Message to send

Throws:

java.rmi.RemoteException

sendErrorMessage

protected void sendErrorMessage(java.lang.String message,
                                java.lang.Throwable error)

initializeJob

public void initializeJob(Microscope microscope,
                          MeasurementContext measurementContext)
                   throws JobException,
                          java.lang.InterruptedException,
                          java.rmi.RemoteException

When overwriting this function, the base implementation should be called at the beginning, i.e. super.initializeJob(...).

Specified by:

initializeJob in interface Job

Parameters:

microscope - Interface to control and get information of the microscope.

measurementContext - the context of the measurement, allowing to transfer data between measurement components and similar.

Throws:

JobException

java.lang.InterruptedException

java.rmi.RemoteException

uninitializeJob

public void uninitializeJob(Microscope microscope,
                            MeasurementContext measurementContext)
                     throws JobException,
                            java.lang.InterruptedException,
                            java.rmi.RemoteException

When overwriting this function, the base implementation should be called at the beginning, i.e. super.initializeJob(...).

Specified by:

uninitializeJob in interface Job

Parameters:

microscope - Interface to control and get information of the microscope.

measurementContext - the context of the measurement, allowing to transfer data between measurement components and similar.

Throws:

JobException

java.lang.InterruptedException

java.rmi.RemoteException

getName

public java.lang.String getName()
                         throws java.rmi.RemoteException

Description copied from interface: Component

Returns a name of the component meant for human interpretation.

Specified by:

getName in interface Component

Returns:

Name/short description of component.

Throws:

java.rmi.RemoteException

setName

public void setName(java.lang.String jobName)
             throws java.rmi.RemoteException

Description copied from interface: Component

Sets the name of the component meant for human interpretation. Usually, the default name of a component contains already sufficient information. However, for some measurement types it can be of advantage to rename certain components which have a specific meaning for the respective measurement.

Specified by:

setName in interface Component

Parameters:

jobName - Name/short description of the component.

Throws:

java.rmi.RemoteException

getDefaultName

public abstract java.lang.String getDefaultName()
                                         throws java.rmi.RemoteException

Should return a default name for the job type which gets returned by getJobName() if no job name was set explicitly by setJobName.

Returns:

Default job name. Should be short, but however informative.

Throws:

java.rmi.RemoteException

getUUID

public java.util.UUID getUUID()
                       throws java.rmi.RemoteException

Description copied from interface: Component

Returns a unique ID of the component. No two components have the same unique ID, even if they are created using the same configuration. See UUID.equals(Object) and UUID.randomUUID().

Specified by:

getUUID in interface Component

Returns:

Unique ID of the component.

Throws:

java.rmi.RemoteException