org.youscope.plugin.customjob

Class CustomJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.customjob.CustomJobConfiguration

All Implemented Interfaces:

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

public class CustomJobConfiguration
extends JobConfiguration
implements JobContainerConfiguration

A job consisting of other jobs, which can be defined by the user.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CustomJobConfiguration()

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.
CustomJobConfiguration	clone()
java.lang.String	getCustomJobName() Returns the name or ID of the custom job, with which it is identified.
java.lang.String	getDescription() Returns a short description of this job.
JobConfiguration[]	getJobs() Returns the job list which might be edited by the caller.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	removeJobAt(int index) Removes the job at the given index.
void	setJobs(JobConfiguration[] jobs) Sets the job list to the given list.

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

Constructor Detail

CustomJobConfiguration

public CustomJobConfiguration()

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.

clone

public CustomJobConfiguration clone()
                             throws java.lang.CloneNotSupportedException

Overrides:

clone in class JobConfiguration

Throws:

java.lang.CloneNotSupportedException

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

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.

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.

getCustomJobName

public java.lang.String getCustomJobName()

Returns the name or ID of the custom job, with which it is identified. The ID is also used as the basename for saving the job.

Returns:

Name of the job template.