org.youscope.plugin.microplatejob

Class MicroplateJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.microplatejob.MicroplateJobConfiguration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Configuration, JobContainerConfiguration

public class MicroplateJobConfiguration
extends JobConfiguration
implements JobContainerConfiguration

This class represents the configuration of a user configurable microplate job.

Author:

Moritz Lang

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_IDENTIFIER The identifier for this measurement type.

Constructor Summary

Constructors

Constructor and Description
MicroplateJobConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addJob(JobConfiguration job) Adds a job to the job list.
void	addJob(JobConfiguration job, int index) Adds a job to the job list.
void	clearJobs() Removes all jobs from the job list.
java.lang.String	getDescription() Returns a short description of this job.
FocusConfiguration	getFocusConfiguration()
JobConfiguration[]	getJobs() Returns the job list which might be edited by the caller.
MicroplatePositionConfiguration	getMicroplatePositions() Returns the used microplate and the measured positions therein.
java.lang.String	getPathOptimizerID() Returns the ID of the optimizer which should be used to minimize the distances between two wells/positions measured.
java.lang.String	getStageDevice() Returns the ID of the stage device which should be used to change between wells and positions.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	removeJobAt(int index) Removes the job at the given index.
void	setFocusConfiguration(FocusConfiguration focusConfiguration)
void	setJobs(JobConfiguration[] jobs) Sets the job list to the given list.
void	setMicroplatePositions(MicroplatePositionConfiguration microplatePositions) Sets the used microplate and the measured positions therein.
void	setPathOptimizerID(java.lang.String pathOptimizerID) Sets the ID of the optimizer which should be used to minimize the distances between two wells/positions measured.
void	setStageDevice(java.lang.String stageDevice) Sets the ID of the stage device which should be used to change between wells and positions.

Methods inherited from class org.youscope.common.job.JobConfiguration

checkConfiguration, clone, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_IDENTIFIER

public static final java.lang.String TYPE_IDENTIFIER

The identifier for this measurement type.

See Also:

Constant Field Values

Constructor Detail

MicroplateJobConfiguration

public MicroplateJobConfiguration()

Method Detail

getJobs

public JobConfiguration[] getJobs()

Description copied from interface: JobContainerConfiguration

Returns the job list which might be edited by the caller.

Specified by:

getJobs in interface JobContainerConfiguration

Returns:

Job list.

setJobs

public void setJobs(JobConfiguration[] jobs)

Description copied from interface: JobContainerConfiguration

Sets the job list to the given list.

Specified by:

setJobs in interface JobContainerConfiguration

Parameters:

jobs - New job list.

addJob

public void addJob(JobConfiguration job)

Description copied from interface: JobContainerConfiguration

Adds a job to the job list.

Specified by:

addJob in interface JobContainerConfiguration

Parameters:

job - Job to be added.

clearJobs

public void clearJobs()

Description copied from interface: JobContainerConfiguration

Removes all jobs from the job list.

Specified by:

clearJobs in interface JobContainerConfiguration

getTypeIdentifier

public java.lang.String getTypeIdentifier()

Description copied from interface: Configuration

Returns a unique identifier for this configuration type. The identifier is used to determine factories and addons to construct and configure jobs, measurements, etc., given a corresponding configuration. Make sure that the ID returned is unique. The returned identifier should conform to "XXX.YYY", where XXX stands for an identifier of the organizational unit or the person who created the configuration (e.g. ETH, Smith, Cindarella), and YYY stands for an identifier of the specific kind of configuration (e.g. AutofocusJob, PlatePosition, MicroplateMeasurement). Optionally, additional hierarchy levels can be defined by additional separators ., e.g. "YouScope.AutofocusJob.Version1.1" The identifier should not contain spaces, non-ASCII characters, or colons (except for hierarchy level separation). Identifiers should start with a capital character, i.e. A-Z. Make sure to not use the same identifier for different configurations, since this might result in unexpected behavior or errors. Make

Specified by:

getTypeIdentifier in interface Configuration

Returns:

Unique identifier of the configuration type.

removeJobAt

public void removeJobAt(int index)

Description copied from interface: JobContainerConfiguration

Removes the job at the given index.

Specified by:

removeJobAt in interface JobContainerConfiguration

Parameters:

index - Index of the job to be removed.

addJob

public void addJob(JobConfiguration job,
                   int index)

Description copied from interface: JobContainerConfiguration

Adds a job to the job list. The job is added such that it has the given index. Jobs having a higher or equal index before the operation are moved downwards.

Specified by:

addJob in interface JobContainerConfiguration

Parameters:

job - Job to be added.

index - Index where the job should be added.

setFocusConfiguration

public void setFocusConfiguration(FocusConfiguration focusConfiguration)

Parameters:

focusConfiguration - The configuration of the focus used when entering a well. Set to NULL to not set focus.

getFocusConfiguration

public FocusConfiguration getFocusConfiguration()

Returns:

The configuration of the focus used when entering a well. NULL if focus is not set.

setMicroplatePositions

public void setMicroplatePositions(MicroplatePositionConfiguration microplatePositions)

Sets the used microplate and the measured positions therein.

Parameters:

microplatePositions - the configuration of the used microplate and the measured positions therein.

getMicroplatePositions

public MicroplatePositionConfiguration getMicroplatePositions()

Returns the used microplate and the measured positions therein.

Returns:

the configuration of the used microplate and the measured positions therein.

setPathOptimizerID

public void setPathOptimizerID(java.lang.String pathOptimizerID)

Sets the ID of the optimizer which should be used to minimize the distances between two wells/positions measured. Set to null to not use any optimized path.

Parameters:

pathOptimizerID - The ID of the path optimizer used, or null

getPathOptimizerID

public java.lang.String getPathOptimizerID()

Returns the ID of the optimizer which should be used to minimize the distances between two wells/positions measured. Returns null if not uses any optimized path.

Returns:

The ID of the path optimizer used, or null

setStageDevice

public void setStageDevice(java.lang.String stageDevice)

Sets the ID of the stage device which should be used to change between wells and positions. Set to NULL to use default stage device.

Parameters:

stageDevice - The ID of the stage device, or NULL.

getStageDevice

public java.lang.String getStageDevice()

Returns the ID of the stage device which should be used to change between wells and positions. Returns NULL to use default stage device.

Returns:

The ID of the stage device, or NULL.

getDescription

public java.lang.String getDescription()

Description copied from class: JobConfiguration

Returns a short description of this job.

Specified by:

getDescription in class JobConfiguration

Returns:

Short description of the job.