org.youscope.plugin.onix

Class OnixJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.onix.OnixJobConfiguration

All Implemented Interfaces:

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

public class OnixJobConfiguration
extends JobConfiguration
implements TableConsumerConfiguration

A job to control the CellAsic Onix microfluidic system.

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 job type.

Constructor Summary

Constructors

Constructor and Description
OnixJobConfiguration()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
TableDefinition	getConsumedTableDefinition() Returns a information about the layout of the tables which are consumed by the TableConsumer, e.g.
java.lang.String	getDescription() Returns a short description of this job.
java.lang.String	getOnixProtocol() Returns the onix protocol.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
boolean	isWaitUntilFinished() If true, the job waits when evaluating the onix protocol until the protocol is finished.
void	setOnixProtocol(java.lang.String onixProtocol) Sets the protocol which gets evaluated on the onix device every time the job gets evaluated.
void	setWaitUntilFinished(boolean waitUntilFinished) If true, the job waits when evaluating the onix protocol until the protocol is finished.

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

checkConfiguration, 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 job type.

See Also:

Constant Field Values

Constructor Detail

OnixJobConfiguration

public OnixJobConfiguration()

Method Detail

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.

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.

setOnixProtocol

public void setOnixProtocol(java.lang.String onixProtocol)

Sets the protocol which gets evaluated on the onix device every time the job gets evaluated.

Parameters:

onixProtocol - The onix protocol.

getOnixProtocol

public java.lang.String getOnixProtocol()

Returns the onix protocol.

Returns:

Onix protocol.

setWaitUntilFinished

public void setWaitUntilFinished(boolean waitUntilFinished)

If true, the job waits when evaluating the onix protocol until the protocol is finished. If false, the onix protocol gets evaluated in parallel.

Parameters:

waitUntilFinished - True if job should wait until end of onix protocol evaluation.

isWaitUntilFinished

public boolean isWaitUntilFinished()

If true, the job waits when evaluating the onix protocol until the protocol is finished. If false, the onix protocol gets evaluated in parallel.

Returns:

True if job should wait until end of onix protocol evaluation.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class JobConfiguration

Throws:

java.lang.CloneNotSupportedException

getConsumedTableDefinition

public TableDefinition getConsumedTableDefinition()

Description copied from interface: TableConsumerConfiguration

Returns a information about the layout of the tables which are consumed by the TableConsumer, e.g. the number and types of columns.

Specified by:

getConsumedTableDefinition in interface TableConsumerConfiguration

Returns:

Information about of the layout of the consumed tables.