org.youscope.plugin.statistics

Class StatisticsJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.statistics.StatisticsJobConfiguration

All Implemented Interfaces:

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

public class StatisticsJobConfiguration
extends JobConfiguration
implements JobContainerConfiguration, TableProducerConfiguration

This job/task displays a message to the user and waits for his or her acknowledgment.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatisticsJobConfiguration()

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	checkConfiguration() Checks the current state of the configuration.
void	clearJobs() Removes all jobs from the job list.
java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() Returns a short description of this job.
java.lang.String	getFileName() Returns the file name where statistical data is saved.
JobConfiguration[]	getJobs() Returns the job list which might be edited by the caller.
TableDefinition	getProducedTableDefinition() Returns the definition of the table layout of the tables produced by this producer, e.g.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
int	hashCode()
void	removeJobAt(int index) Removes the job at the given index.
void	setFileName(java.lang.String fileName) Sets the file name where statistical data should be saved.
void	setJobs(JobConfiguration[] jobs) Sets the job list to the given list.

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

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StatisticsJobConfiguration

public StatisticsJobConfiguration()

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

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.

getFileName

public java.lang.String getFileName()

Returns the file name where statistical data is saved.

Returns:

File name for statistical data.

setFileName

public void setFileName(java.lang.String fileName)

Sets the file name where statistical data should be saved.

Parameters:

fileName - File name for statistical data.

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.

clone

public java.lang.Object 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.

getProducedTableDefinition

public TableDefinition getProducedTableDefinition()

Description copied from interface: TableProducerConfiguration

Returns the definition of the table layout of the tables produced by this producer, e.g. the number and types of its columns. This function should return the same TableDefinition as is returned by a measurement component created by this configuration, see TableProducer.getProducedTableDefinition().

Specified by:

getProducedTableDefinition in interface TableProducerConfiguration

Returns:

Information about of the produced tables.

checkConfiguration

public void checkConfiguration()
                        throws ConfigurationException

Description copied from interface: Configuration

Checks the current state of the configuration. If the configuration state is valid, the method returns normally. If not, a ConfigurationException is thrown describing the error, and what has to be changed in the configuration, by the user, such that it becomes valid. This error can then e.g. be displayed to the user (see ConfigurationAddonTools.displayConfigurationInvalid(ConfigurationException, YouScopeClient).

Specified by:

checkConfiguration in interface Configuration

Overrides:

checkConfiguration in class JobConfiguration

Throws:

ConfigurationException