org.youscope.plugin.standardsavesettings

Class StandardSaveSettingsConfiguration

java.lang.Object

org.youscope.common.resource.ResourceConfiguration

org.youscope.common.saving.SaveSettingsConfiguration

org.youscope.plugin.standardsavesettings.StandardSaveSettingsConfiguration

All Implemented Interfaces:

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

public class StandardSaveSettingsConfiguration
extends SaveSettingsConfiguration

Configuration of a standard folder structure to save measurements.

Author:

mlang

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_IDENTIFIER Type identifier of the save settings.

Constructor Summary

Constructors

Constructor and Description
StandardSaveSettingsConfiguration()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
java.lang.String	getBaseFolder() Returns the folder where all measurements should be saved.
FolderStructureType	getFolderStructureType() Returns the type of the standard folder structure.
java.lang.String	getImageFileName()
java.lang.String	getImageFileType()
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	setBaseFolder(java.lang.String folder) Sets the folder where all measurements should be saved.
void	setFolderStructureType(FolderStructureType folderStructureType) Sets the type of the standard folder structure.
void	setImageFileName(java.lang.String fileName)
void	setImageFileType(java.lang.String imageFileType)

Methods inherited from class org.youscope.common.resource.ResourceConfiguration

checkConfiguration

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

Type identifier of the save settings.

See Also:

Constant Field Values

Constructor Detail

StandardSaveSettingsConfiguration

public StandardSaveSettingsConfiguration()

Method Detail

getFolderStructureType

public FolderStructureType getFolderStructureType()

Returns the type of the standard folder structure.

Returns:

Type of standard folder structure.

setFolderStructureType

public void setFolderStructureType(FolderStructureType folderStructureType)

Sets the type of the standard folder structure.

Parameters:

folderStructureType - Type of the standard folder structure.

getBaseFolder

public java.lang.String getBaseFolder()

Returns the folder where all measurements should be saved.

Returns:

the folder of the measurement.

setBaseFolder

public void setBaseFolder(java.lang.String folder)

Sets the folder where all measurements should be saved. Be aware that an additional folder is created inside this folder when the measurement starts, which indicates the specific time when the measurement was started. This is done since one measurement can be started multiple times. To obtain the full path to this subfolder, use the respective function in MeasurementSaver.

Parameters:

folder - the folder of the measurement.

getImageFileType

public java.lang.String getImageFileType()

Returns:

the imageFileType

setImageFileType

public void setImageFileType(java.lang.String imageFileType)

Parameters:

imageFileType - the imageFileType to set

getImageFileName

public java.lang.String getImageFileName()

Returns:

The file name under which the images are saved.

setImageFileName

public void setImageFileName(java.lang.String fileName)

Parameters:

fileName - The file name the image should be saved under.

clone

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

Overrides:

clone in class ResourceConfiguration

Throws:

java.lang.CloneNotSupportedException

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

Returns:

Unique identifier of the configuration type.