org.youscope.plugin.standardsavesettings

Class StandardSaveSettings

java.lang.Object

org.youscope.common.resource.ResourceAdapter<StandardSaveSettingsConfiguration>

org.youscope.plugin.standardsavesettings.StandardSaveSettings

All Implemented Interfaces:

java.rmi.Remote, Component, Resource, SaveSettings

public class StandardSaveSettings
extends ResourceAdapter<StandardSaveSettingsConfiguration>
implements SaveSettings

Standard save settings, e.g. the definition where images should be stored under which name.

Author:

mlang

Constructor Summary

Constructors

Constructor and Description
StandardSaveSettings(PositionInformation positionInformation, StandardSaveSettingsConfiguration configuration) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getImageExtension(ImageEvent<?> event, java.lang.String imageName) Returns a extension/file type (without a dot, e.g.
java.lang.String	getImageFilePath(ImageEvent<?> event, java.lang.String imageName) Returns a file path (with extension) where an image with a given name should be saved.
java.lang.String	getImageMetadataTableFilePath() Returns a file path (with extension) where the table storing metadata about the images should be stored.
java.lang.String	getLogErrFilePath() Returns the file path for the error log file (with extension).
java.lang.String	getLogOutFilePath() Returns the file path for the standard output log file (with extension).
java.lang.String	getMeasurementBasePath(java.lang.String measurementName, long timeMs) Returns the name of the base folder/path where the measurement is saved, and relative to which all other paths are given.
java.lang.String	getMeasurementConfigurationFilePath() Path of the file (with extension) where the measurement configuration should be saved into.
java.lang.String	getMicroscopeConfigurationFilePath() Path of the file (with extension) where the microscope configuration should be saved into.
java.lang.String	getScopeSettingsFilePath() Path of the XML file (with extension) where the scope and channel settings are saved into.
java.lang.String	getTableFilePath(java.lang.String tableName) Returns a file path (with extension) where a table with a given name should be saved.

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

addMessageListener, assertInitialized, getConfiguration, getName, getPositionInformation, getTypeIdentifier, getUUID, initialize, isInitialized, removeMessageListener, sendErrorMessage, sendMessage, setName, uninitialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.youscope.common.resource.Resource

getTypeIdentifier, initialize, isInitialized, uninitialize

Methods inherited from interface org.youscope.common.Component

addMessageListener, getName, getPositionInformation, getUUID, removeMessageListener, setName

Constructor Detail

StandardSaveSettings

public StandardSaveSettings(PositionInformation positionInformation,
                            StandardSaveSettingsConfiguration configuration)
                     throws ConfigurationException

Constructor.

Parameters:

positionInformation - Position information.

configuration - configuration of the save settings.

Throws:

ConfigurationException

Method Detail

getScopeSettingsFilePath

public java.lang.String getScopeSettingsFilePath()

Description copied from interface: SaveSettings

Path of the XML file (with extension) where the scope and channel settings are saved into. Typically "scope_settings.xml". The path is relative to SaveSettings.getMeasurementBasePath(String, long).

Specified by:

getScopeSettingsFilePath in interface SaveSettings

Returns:

Scope settings file path

getMeasurementConfigurationFilePath

public java.lang.String getMeasurementConfigurationFilePath()

Description copied from interface: SaveSettings

Path of the file (with extension) where the measurement configuration should be saved into. Typically "configuration.csb". Note: by convention, all measurement configurations should have the file extension "csb". The path is relative to SaveSettings.getMeasurementBasePath(String, long).

Specified by:

getMeasurementConfigurationFilePath in interface SaveSettings

Returns:

Measurement configuration file path.

getMicroscopeConfigurationFilePath

public java.lang.String getMicroscopeConfigurationFilePath()

Description copied from interface: SaveSettings

Path of the file (with extension) where the microscope configuration should be saved into. Typically "YSConfig_Microscope.cfg". The path is relative to SaveSettings.getMeasurementBasePath(String, long).

Specified by:

getMicroscopeConfigurationFilePath in interface SaveSettings

Returns:

Microscope configuration file path.

getLogErrFilePath

public java.lang.String getLogErrFilePath()

Description copied from interface: SaveSettings

Returns the file path for the error log file (with extension). Typically "measurement_err.txt". The path is relative to SaveSettings.getMeasurementBasePath(String, long).

Specified by:

getLogErrFilePath in interface SaveSettings

Returns:

Error file path.

getLogOutFilePath

public java.lang.String getLogOutFilePath()

Description copied from interface: SaveSettings

Returns the file path for the standard output log file (with extension). Typically "measurement_log.txt". The path is relative to SaveSettings.getMeasurementBasePath(String, long).

Specified by:

getLogOutFilePath in interface SaveSettings

Returns:

Log file path.

getMeasurementBasePath

public java.lang.String getMeasurementBasePath(java.lang.String measurementName,
                                               long timeMs)

Description copied from interface: SaveSettings

Returns the name of the base folder/path where the measurement is saved, and relative to which all other paths are given. Typically in the format "C:/measurementFolder/measurementName/year-month-day_hour-minute-second" or similar, whereby "C:/measurementFolder/" (or an equivalence for POSIX systems) can be chosen by the user, while measurementName is the name of the measurement supplied to this method. Note, that this path should be different every time the measurement is started, i.e. necessarily has to contain some time related part with a high enough granularity such that no two runs of the same measurement will have the same time identifier (typically implies at least granularity down down to the minute, if not to the second).

Specified by:

getMeasurementBasePath in interface SaveSettings

Parameters:

measurementName - Name of the measurement.

timeMs - Time in ms when measurement was started. See System.currentTimeMillis().

Returns:

Base path of the measurement.

getTableFilePath

public java.lang.String getTableFilePath(java.lang.String tableName)

Description copied from interface: SaveSettings

Returns a file path (with extension) where a table with a given name should be saved. By convention, the file type should be "csv". Note that, different to images which are stored in one file per image, tables are usually stored one file for every named table. Identifiers when and where a given row of the table is produced is automatically added by YouScope. The path is relative to SaveSettings.getMeasurementBasePath(String, long).

Specified by:

getTableFilePath in interface SaveSettings

Parameters:

tableName - User chosen table name.

Returns:

table file path.

getImageMetadataTableFilePath

public java.lang.String getImageMetadataTableFilePath()

Description copied from interface: SaveSettings

Returns a file path (with extension) where the table storing metadata about the images should be stored. Typically "images.csv". By convention, the file type should be "csv". The path is relative to SaveSettings.getMeasurementBasePath(String, long).

Specified by:

getImageMetadataTableFilePath in interface SaveSettings

Returns:

image table path.

getImageFilePath

public java.lang.String getImageFilePath(ImageEvent<?> event,
                                         java.lang.String imageName)

Description copied from interface: SaveSettings

Returns a file path (with extension) where an image with a given name should be saved. It is important that this path should not define the extension of the image. Note that, images are stored in one file per image. Therefore, the image path should be different for images produced by the same image producer at a different iteration. Therefore, the image creation information stored in the image event should be used to determine the path. The path is relative to SaveSettings.getMeasurementBasePath(String, long).

Specified by:

getImageFilePath in interface SaveSettings

Parameters:

event - image event.

imageName - user chosen name of the image.

Returns:

image path, with extension.

getImageExtension

public java.lang.String getImageExtension(ImageEvent<?> event,
                                          java.lang.String imageName)

Description copied from interface: SaveSettings

Returns a extension/file type (without a dot, e.g. "tif" and not ".tif") of an image. Typically, this is the same as the extension of the file returned by SaveSettings.getImageExtension(ImageEvent, String). This extension is internally used to determine how the image should be saved, and should match be a supported image type (for more, see YouScope server details).

Specified by:

getImageExtension in interface SaveSettings

Parameters:

event - image event.

imageName - user chosen name of the image.

Returns:

image extension, without a dot.