omero.gateway.facility

Class LoadFacility

java.lang.Object

omero.gateway.facility.Facility

omero.gateway.facility.LoadFacility

public class LoadFacility
extends Facility

A Facility for loading basic objects. Note: These are shallow objects with just one level of hierarchy loaded e.g. a project will have a list of datasets, but the datasets only have basic properties like name and id loaded.

Method Summary

Modifier and Type	Method and Description
DatasetData	getDataset(SecurityContext ctx, long id) Get a dataset
ImageData	getImage(SecurityContext ctx, long id) Get an image
PlateData	getPlate(SecurityContext ctx, long id) Get a plate
ProjectData	getProject(SecurityContext ctx, long id) Get a project
ScreenData	getScreen(SecurityContext ctx, long id) Get a screen
WellData	getWell(SecurityContext ctx, long id) Get a well (Note: This is a slightly deeper object, with wellsamples and images loaded)

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

getDataset

public DatasetData getDataset(SecurityContext ctx,
                              long id)
                       throws DSOutOfServiceException,
                              DSAccessException

Get a dataset

Parameters:

ctx - The SecurityContext

id - The id of the dataset

Returns:

The dataset or null if it can't be found

Throws:

DSOutOfServiceException

DSAccessException

getProject

public ProjectData getProject(SecurityContext ctx,
                              long id)
                       throws DSOutOfServiceException,
                              DSAccessException

Get a project

Parameters:

ctx - The SecurityContext

id - The id of the project

Returns:

The project or null if it can't be found

Throws:

DSOutOfServiceException

DSAccessException

getImage

public ImageData getImage(SecurityContext ctx,
                          long id)
                   throws DSOutOfServiceException,
                          DSAccessException

Get an image

Parameters:

ctx - The SecurityContext

id - The id of the image

Returns:

The image or null if it can't be found

Throws:

DSOutOfServiceException

DSAccessException

getScreen

public ScreenData getScreen(SecurityContext ctx,
                            long id)
                     throws DSOutOfServiceException,
                            DSAccessException

Get a screen

Parameters:

ctx - The SecurityContext

id - The id of the screen

Returns:

The screen or null if it can't be found

Throws:

DSOutOfServiceException

DSAccessException

getPlate

public PlateData getPlate(SecurityContext ctx,
                          long id)
                   throws DSOutOfServiceException,
                          DSAccessException

Get a plate

Parameters:

ctx - The SecurityContext

id - The id of the plate

Returns:

The plate or null if it can't be found

Throws:

DSOutOfServiceException

DSAccessException

getWell

public WellData getWell(SecurityContext ctx,
                        long id)
                 throws DSOutOfServiceException,
                        DSAccessException

Get a well (Note: This is a slightly deeper object, with wellsamples and images loaded)

Parameters:

ctx - The SecurityContext

id - The id of the well

Returns:

The well or null if it can't be found

Throws:

DSOutOfServiceException

DSAccessException