omero.gateway.facility

Class DataManagerFacility

java.lang.Object

omero.gateway.facility.Facility

omero.gateway.facility.DataManagerFacility

public class DataManagerFacility
extends Facility

A Facility for saving, deleting and updating data objects

Since:

5.1

Author:

Dominik Lindner d.lindner@dundee.ac.uk

Method Summary

Modifier and Type	Method and Description
void	addImagesToDataset(SecurityContext ctx, Collection<ImageData> images, DatasetData ds) Adds the ImageDatas to the given DatasetData
void	addImageToDataset(SecurityContext ctx, ImageData image, DatasetData ds) Adds the ImageData to the given DatasetData
<T extends AnnotationData> T	attachAnnotation(SecurityContext ctx, T annotation, DataObject target) Create/attach an AnnotationData to a given DataObject
Future<FileAnnotationData>	attachFile(SecurityContext ctx, File file, String mimetype, String description, String namespace, DataObject target) Attaches a File to a DataObject
DatasetData	createDataset(SecurityContext ctx, DatasetData dataset, ProjectData project) Creates the DatasetData on the server and attaches it to the ProjectData (if not null) (if the project doesn't exist on the server yet, it will be created, too)
CmdCallbackI	delete(SecurityContext ctx, omero.model.IObject object) Deletes the specified object asynchronously
CmdCallbackI	delete(SecurityContext ctx, List<omero.model.IObject> objects) Deletes the specified objects asynchronously
CmdCallbackI	deleteFolders(SecurityContext ctx, Collection<FolderData> folders, boolean includeSubFolders, boolean includeContent) Delete Folders (asynchronous)
omero.cmd.Response	deleteObject(SecurityContext ctx, omero.model.IObject object) Deprecated. Use the asynchronous method delete(SecurityContext, IObject) instead
omero.cmd.Response	deleteObjects(SecurityContext ctx, List<omero.model.IObject> objects) Deprecated. Use the asynchronous method delete(SecurityContext, List) instead
DataObject	saveAndReturnObject(SecurityContext ctx, DataObject object) Updates the specified object.
DataObject	saveAndReturnObject(SecurityContext ctx, DataObject object, String userName) Updates the specified object.
omero.model.IObject	saveAndReturnObject(SecurityContext ctx, omero.model.IObject object) Updates the specified object.
omero.model.IObject	saveAndReturnObject(SecurityContext ctx, omero.model.IObject object, Map options) Updates the specified object.
omero.model.IObject	saveAndReturnObject(SecurityContext ctx, omero.model.IObject object, Map options, String userName) Updates the specified object.
omero.model.IObject	saveAndReturnObject(SecurityContext ctx, omero.model.IObject object, String userName) Updates the specified object.
List<omero.model.IObject>	saveAndReturnObject(SecurityContext ctx, List<omero.model.IObject> objects, Map options, String userName) Updates the specified object.
omero.model.IObject	updateObject(SecurityContext ctx, omero.model.IObject object, omero.sys.Parameters options) Updates the specified object.
List<omero.model.IObject>	updateObjects(SecurityContext ctx, List<omero.model.IObject> objects, omero.sys.Parameters options) Updates the specified IObjects and returned the updated IObjects.

Methods inherited from class omero.gateway.facility.Facility

addPropertyChangeListener, clear, firePropertyChanged, firePropertyChanged, getFacility, logDebug, logError, logInfo, logWarn, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Method Detail

deleteObject

public omero.cmd.Response deleteObject(SecurityContext ctx,
                                       omero.model.IObject object)
                                throws DSOutOfServiceException,
                                       DSAccessException

Deprecated. Use the asynchronous method delete(SecurityContext, IObject) instead

Deletes the specified object.

Parameters:

ctx - The security context.

object - The object to delete.

Returns:

The Response handle

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

delete

public CmdCallbackI delete(SecurityContext ctx,
                           omero.model.IObject object)
                    throws DSOutOfServiceException,
                           DSAccessException

Deletes the specified object asynchronously

Parameters:

ctx - The security context.

object - The object to delete.

Returns:

The CmdCallbackI

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

deleteFolders

public CmdCallbackI deleteFolders(SecurityContext ctx,
                                  Collection<FolderData> folders,
                                  boolean includeSubFolders,
                                  boolean includeContent)
                           throws DSOutOfServiceException,
                                  DSAccessException

Delete Folders (asynchronous)

Parameters:

ctx - The SecurityContext

folders - The Folder to delete

includeSubFolders - Pass true to recursively delete sub folders

includeContent - Pass true to also delete content of the folders, otherwise content (ROIs, Images) will be orphaned

Returns:

The Callback reference

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

delete

public CmdCallbackI delete(SecurityContext ctx,
                           List<omero.model.IObject> objects)
                    throws DSOutOfServiceException,
                           DSAccessException

Deletes the specified objects asynchronously

Parameters:

ctx - The security context.

objects - The objects to delete.

Returns:

The CmdCallbackI

Throws:

DSOutOfServiceException - If the connection is broken, or logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

deleteObjects

public omero.cmd.Response deleteObjects(SecurityContext ctx,
                                        List<omero.model.IObject> objects)
                                 throws DSOutOfServiceException,
                                        DSAccessException

Deprecated. Use the asynchronous method delete(SecurityContext, List) instead

Deletes the specified objects.

Parameters:

ctx - The security context.

objects - The objects to delete.

Returns:

The Response handle

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

saveAndReturnObject

public omero.model.IObject saveAndReturnObject(SecurityContext ctx,
                                               omero.model.IObject object,
                                               Map options)
                                        throws DSOutOfServiceException,
                                               DSAccessException

Updates the specified object.

Parameters:

ctx - The security context.

object - The object to update.

options - Options to update the data.

Returns:

The updated object.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

See Also:

IContainerPrx.updateDataObject(IObject, Parameters)

saveAndReturnObject

public DataObject saveAndReturnObject(SecurityContext ctx,
                                      DataObject object)
                               throws DSOutOfServiceException,
                                      DSAccessException

Updates the specified object.

Parameters:

ctx - The security context.

object - The object to update.

Returns:

The updated object.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

See Also:

IContainerPrx.updateDataObject(IObject, Parameters)

saveAndReturnObject

public omero.model.IObject saveAndReturnObject(SecurityContext ctx,
                                               omero.model.IObject object)
                                        throws DSOutOfServiceException,
                                               DSAccessException

Updates the specified object.

Parameters:

ctx - The security context.

object - The object to update.

Returns:

The updated object.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

See Also:

IContainerPrx.updateDataObject(IObject, Parameters)

saveAndReturnObject

public omero.model.IObject saveAndReturnObject(SecurityContext ctx,
                                               omero.model.IObject object,
                                               Map options,
                                               String userName)
                                        throws DSOutOfServiceException,
                                               DSAccessException

Updates the specified object.

Parameters:

ctx - The security context.

object - The object to update.

options - Options to update the data.

userName - The name of the user to create the data for.

Returns:

The updated object.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

See Also:

IContainerPrx.updateDataObject(IObject, Parameters)

saveAndReturnObject

public DataObject saveAndReturnObject(SecurityContext ctx,
                                      DataObject object,
                                      String userName)
                               throws DSOutOfServiceException,
                                      DSAccessException

Updates the specified object.

Parameters:

ctx - The security context.

object - The object to update.

userName - The name of the user to create the data for.

Returns:

The updated object.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

See Also:

IContainerPrx.updateDataObject(IObject, Parameters)

saveAndReturnObject

public omero.model.IObject saveAndReturnObject(SecurityContext ctx,
                                               omero.model.IObject object,
                                               String userName)
                                        throws DSOutOfServiceException,
                                               DSAccessException

Updates the specified object.

Parameters:

ctx - The security context.

object - The object to update.

userName - The name of the user to create the data for.

Returns:

The updated object.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

See Also:

IContainerPrx.updateDataObject(IObject, Parameters)

saveAndReturnObject

public List<omero.model.IObject> saveAndReturnObject(SecurityContext ctx,
                                                     List<omero.model.IObject> objects,
                                                     Map options,
                                                     String userName)
                                              throws DSOutOfServiceException,
                                                     DSAccessException

Updates the specified object.

Parameters:

ctx - The security context.

objects - The objects to update.

options - Options to update the data.

userName - The username

Returns:

The updated object.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

See Also:

IContainerPrx.updateDataObject(IObject, Parameters)

updateObject

public omero.model.IObject updateObject(SecurityContext ctx,
                                        omero.model.IObject object,
                                        omero.sys.Parameters options)
                                 throws DSOutOfServiceException,
                                        DSAccessException

Updates the specified object.

Parameters:

ctx - The security context.

object - The object to update.

options - Options to update the data.

Returns:

The updated object.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

See Also:

IContainerPrx.updateDataObject(IObject, Parameters)

updateObjects

public List<omero.model.IObject> updateObjects(SecurityContext ctx,
                                               List<omero.model.IObject> objects,
                                               omero.sys.Parameters options)
                                        throws DSOutOfServiceException,
                                               DSAccessException

Updates the specified IObjects and returned the updated IObjects.

Parameters:

ctx - The security context.

objects - The array of objects to update.

options - Options to update the data.

Returns:

See above.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

See Also:

IContainerPrx.updateDataObjects(List, Parameters)

addImageToDataset

public void addImageToDataset(SecurityContext ctx,
                              ImageData image,
                              DatasetData ds)
                       throws DSOutOfServiceException,
                              DSAccessException

Adds the ImageData to the given DatasetData

Parameters:

ctx - The security context.

image - The image to add to the dataset

ds - The dataset to add the image to

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

addImagesToDataset

public void addImagesToDataset(SecurityContext ctx,
                               Collection<ImageData> images,
                               DatasetData ds)
                        throws DSOutOfServiceException,
                               DSAccessException

Adds the ImageDatas to the given DatasetData

Parameters:

ctx - The security context.

images - The images to add to the dataset

ds - The dataset to add the images to

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

createDataset

public DatasetData createDataset(SecurityContext ctx,
                                 DatasetData dataset,
                                 ProjectData project)
                          throws DSOutOfServiceException,
                                 DSAccessException

Creates the DatasetData on the server and attaches it to the ProjectData (if not null) (if the project doesn't exist on the server yet, it will be created, too)

Parameters:

ctx - The SecurityContext

dataset - The DatasetData

project - The ProjectData

Returns:

The DatasetData

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

attachFile

public Future<FileAnnotationData> attachFile(SecurityContext ctx,
                                             File file,
                                             String mimetype,
                                             String description,
                                             String namespace,
                                             DataObject target)

Attaches a File to a DataObject

Parameters:

ctx - The SecurityContext

file - The File to attach

mimetype - The mimetype of the file (can be null)

description - A description (can be null)

namespace - The namespace (can be null)

target - The DataObject to attach the file to

Returns:

The Future FileAnnotationData

attachAnnotation

public <T extends AnnotationData> T attachAnnotation(SecurityContext ctx,
                                                     T annotation,
                                                     DataObject target)
                                              throws DSOutOfServiceException,
                                                     DSAccessException

Create/attach an AnnotationData to a given DataObject

Parameters:

ctx - The SecurityContext

annotation - The AnnotationData

target - The DataObject to attach to

Returns:

The AnnotationData

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.