org.youscope.common.saving

Interface MeasurementSaver

All Superinterfaces:

java.rmi.Remote

public interface MeasurementSaver
extends java.rmi.Remote

Interface providing functionality to set and determine the way images and meta information of a measurement are saved to the file system.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
MeasurementConfiguration	getConfiguration() Returns the configuration of the measurement, or null if the configuration is unknown.
java.lang.String	getLastMeasurementFolder() Returns the path to the last run of this measurement.
ImageListener	getSaveImageListener(java.lang.String imageSaveName) Returns an image listener which can be added to an image producing job to save all produced images to the disk.
SaveSettings	getSaveSettings() Returns the current settings how the measurement should be saved to the disk (e.g.
TableListener	getSaveTableListener(java.lang.String tableSaveName) Returns a table listener which can be added to an table data producing job to save all produced data to the disk.
void	setConfiguration(MeasurementConfiguration configuration) Sets the configuration of the measurement.
void	setSaveSettings(SaveSettings saveSettings) Sets the settings how the measurement should be saved to the disk (e.g.

Method Detail

getSaveImageListener

ImageListener getSaveImageListener(java.lang.String imageSaveName)
                            throws java.rmi.RemoteException

Returns an image listener which can be added to an image producing job to save all produced images to the disk.

Parameters:

imageSaveName - The name of the imaging job which is producing the images. Should not contain a file type.

Returns:

An image listener which can be added to the job created by the respective configuration to save the images, or null, if the listener could not be constructed.

Throws:

java.rmi.RemoteException

getSaveTableListener

TableListener getSaveTableListener(java.lang.String tableSaveName)
                            throws java.rmi.RemoteException

Returns a table listener which can be added to an table data producing job to save all produced data to the disk.

Parameters:

tableSaveName - The name of the table generating job. Should not contain a file type.

Returns:

A table data listener which can be added to the job created by the respective configuration to save table data, or null, if the listener could not be constructed.

Throws:

java.rmi.RemoteException

setSaveSettings

void setSaveSettings(SaveSettings saveSettings)
              throws MeasurementRunningException,
                     java.rmi.RemoteException

Sets the settings how the measurement should be saved to the disk (e.g. in which folder, ...). Set to null if measurement should not be saved.

Parameters:

saveSettings - Settings how the measurement should be saved.

Throws:

MeasurementRunningException

java.rmi.RemoteException

getSaveSettings

SaveSettings getSaveSettings()
                      throws java.rmi.RemoteException

Returns the current settings how the measurement should be saved to the disk (e.g. in which folder, ...), or null if measurement should not be saved.

Returns:

Current measurement save settings.

Throws:

java.rmi.RemoteException

getLastMeasurementFolder

java.lang.String getLastMeasurementFolder()
                                   throws java.rmi.RemoteException

Returns the path to the last run of this measurement. This path is composed of the path in the MeasurementSaveSettings, with an additional subfolder added which indicates the time of the last execution of this measurement. Be aware that when running the server and the client on different computers, this path is relative to the server's file system.

Returns:

The path of the measurement on the server side.

Throws:

java.rmi.RemoteException

getConfiguration

MeasurementConfiguration getConfiguration()
                                   throws java.rmi.RemoteException

Returns the configuration of the measurement, or null if the configuration is unknown.

Returns:

Configuration of the measurement.

Throws:

java.rmi.RemoteException

setConfiguration

void setConfiguration(MeasurementConfiguration configuration)
               throws MeasurementRunningException,
                      java.rmi.RemoteException

Sets the configuration of the measurement. The configuration should be such, that a new measurement should be possible to be created with it which has the same properties as the current measurement.

Parameters:

configuration - The configuration of the measurement, or null if the configuration should be set to unknown.

Throws:

MeasurementRunningException

java.rmi.RemoteException