org.youscope.plugin.taskmeasurement

Class TaskMeasurementConfiguration

java.lang.Object

org.youscope.common.measurement.MeasurementConfiguration

org.youscope.plugin.taskmeasurement.TaskMeasurementConfiguration

All Implemented Interfaces:

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

public class TaskMeasurementConfiguration
extends MeasurementConfiguration
implements TaskContainerConfiguration

This class represents the configuration of a user configurable measurement.

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
TaskMeasurementConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addTask(TaskConfiguration taskConfiguration) Adds a new task at the end of the tasks.
void	checkConfiguration() Checks the current state of the configuration.
java.lang.Object	clone()
int	getNumTasks() Returns the number of tasks in the container.
TaskConfiguration	getTask(int taskID) Returns the task at the given position.
TaskConfiguration[]	getTasks() Returns the tasks in the container.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	insertTask(TaskConfiguration taskConfiguration, int taskID) Inserts a task at the given position in the task list.
void	removeTask(int taskID) Removes the task at the given index.
void	setTasks(TaskConfiguration[] tasks)

Methods inherited from class org.youscope.common.measurement.MeasurementConfiguration

getDeviseSettingsOff, getDeviseSettingsOn, getMeasurementRuntime, getName, getSaveSettings, setDeviseSettingsOff, setDeviseSettingsOn, setMeasurementRuntime, setName, setSaveSettings

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

TaskMeasurementConfiguration

public TaskMeasurementConfiguration()

Method Detail

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.

getTasks

public TaskConfiguration[] getTasks()

Description copied from interface: TaskContainerConfiguration

Returns the tasks in the container.

Specified by:

getTasks in interface TaskContainerConfiguration

Returns:

the tasks

setTasks

public void setTasks(TaskConfiguration[] tasks)

Parameters:

tasks - the tasks to set

clone

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

Overrides:

clone in class MeasurementConfiguration

Throws:

java.lang.CloneNotSupportedException

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 MeasurementConfiguration

Throws:

ConfigurationException

getNumTasks

public int getNumTasks()

Description copied from interface: TaskContainerConfiguration

Returns the number of tasks in the container.

Specified by:

getNumTasks in interface TaskContainerConfiguration

Returns:

number of tasks.

getTask

public TaskConfiguration getTask(int taskID)
                          throws java.lang.IndexOutOfBoundsException

Description copied from interface: TaskContainerConfiguration

Returns the task at the given position.

Specified by:

getTask in interface TaskContainerConfiguration

Parameters:

taskID - task position.

Returns:

task at given position.

Throws:

java.lang.IndexOutOfBoundsException - thrown if task index is invalid.

removeTask

public void removeTask(int taskID)
                throws java.lang.IndexOutOfBoundsException

Description copied from interface: TaskContainerConfiguration

Removes the task at the given index.

Specified by:

removeTask in interface TaskContainerConfiguration

Parameters:

taskID - Task id to remove.

Throws:

java.lang.IndexOutOfBoundsException

addTask

public void addTask(TaskConfiguration taskConfiguration)

Description copied from interface: TaskContainerConfiguration

Adds a new task at the end of the tasks.

Specified by:

addTask in interface TaskContainerConfiguration

Parameters:

taskConfiguration - Task to add.

insertTask

public void insertTask(TaskConfiguration taskConfiguration,
                       int taskID)
                throws java.lang.IndexOutOfBoundsException

Description copied from interface: TaskContainerConfiguration

Inserts a task at the given position in the task list. The indices of the task having previously the given index and of all tasks with a higher index is increased by one.

Specified by:

insertTask in interface TaskContainerConfiguration

Parameters:

taskConfiguration - Task to add.

taskID - Index where to insert the task.

Throws:

java.lang.IndexOutOfBoundsException