org.youscope.common.job

Class EditableJobContainerAdapter

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.youscope.common.job.JobAdapter

org.youscope.common.job.EditableJobContainerAdapter

All Implemented Interfaces:

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

public abstract class EditableJobContainerAdapter
extends JobAdapter
implements EditableJobContainer

/** Convenient adapter class to implement a job which contains other jobs. Similar to JobAdapter, except that additional functionality to add and remove sub-jobs is already implemented, as well as the initialization and uninitialization of these sub-jobs. The sub-jobs can be accessed (e.g. the function Job.executeJob(ExecutionInformation, Microscope, MeasurementContext)) via getJobs().

Author:

Moritz Lang

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor and Description
EditableJobContainerAdapter(PositionInformation positionInformation) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addJob(Job job) Adds a job to the end of the container.
void	clearJobs() Removes all jobs from this container.
Job	getJob(int jobIndex) Returns the job at the given index in this container.
Job[]	getJobs() Returns a list of all jobs contained in this container.
int	getNumJobs() Returns the number of jobs in this container.
void	initializeJob(Microscope microscope, MeasurementContext measurementContext) When overwriting this function, the base implementation should be called at the beginning, i.e.
void	insertJob(Job job, int jobIndex) Inserts a job at the given index.
void	removeJob(Job job) Removes a previously added job.
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 org.youscope.common.job.JobAdapter

addJobListener, addMessageListener, assertRunning, executeJob, getDefaultName, getName, getPositionInformation, getUUID, isRunning, removeJobListener, removeMessageListener, runJob, sendErrorMessage, sendMessage, setName

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

EditableJobContainerAdapter

public EditableJobContainerAdapter(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

initializeJob

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

Description copied from class: JobAdapter

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

Specified by:

initializeJob in interface Job

Overrides:

initializeJob in class JobAdapter

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

Description copied from class: JobAdapter

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

Specified by:

uninitializeJob in interface Job

Overrides:

uninitializeJob in class JobAdapter

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

addJob

public void addJob(Job job)
            throws MeasurementRunningException

Description copied from interface: EditableJobContainer

Adds a job to the end of the container.

Specified by:

addJob in interface EditableJobContainer

Parameters:

job - The job to be added.

Throws:

MeasurementRunningException - Thrown if job could not be added, e.g. because measurement is already running.

removeJob

public void removeJob(Job job)
               throws MeasurementRunningException

Description copied from interface: EditableJobContainer

Removes a previously added job.

Specified by:

removeJob in interface EditableJobContainer

Parameters:

job - The job to be removed.

Throws:

MeasurementRunningException - Thrown if job could not be removed, e.g. because measurement is already running.

clearJobs

public void clearJobs()
               throws MeasurementRunningException

Description copied from interface: EditableJobContainer

Removes all jobs from this container.

Specified by:

clearJobs in interface EditableJobContainer

Throws:

MeasurementRunningException - Thrown if jobs could not be removed, e.g. because measurement is already running.

getJobs

public Job[] getJobs()

Description copied from interface: JobContainer

Returns a list of all jobs contained in this container.

Specified by:

getJobs in interface JobContainer

Returns:

List of jobs.

getNumJobs

public int getNumJobs()

Description copied from interface: JobContainer

Returns the number of jobs in this container.

Specified by:

getNumJobs in interface JobContainer

Returns:

number of jobs in this container.

getJob

public Job getJob(int jobIndex)
           throws java.lang.IndexOutOfBoundsException

Description copied from interface: JobContainer

Returns the job at the given index in this container.

Specified by:

getJob in interface JobContainer

Parameters:

jobIndex - Index of job in the container.

Returns:

the job at the given index.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if jobIndex is smaller than zero, or greater or equal to JobContainer.getNumJobs().

insertJob

public void insertJob(Job job,
                      int jobIndex)
               throws MeasurementRunningException,
                      java.lang.IndexOutOfBoundsException

Description copied from interface: EditableJobContainer

Inserts a job at the given index. The index of the job previously having the index, and all jobs having higher indices, are increased.

Specified by:

insertJob in interface EditableJobContainer

Parameters:

job - The job to be inserted.

jobIndex - Index where the job should be inserted.

Throws:

MeasurementRunningException - Thrown if job could not be added, e.g. because measurement is already running.

java.lang.IndexOutOfBoundsException - Thrown if index is smaller than zero, or greater or equal JobContainer.getNumJobs().