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
java.util.Collection<DatasetData>	getDatasets(SecurityContext ctx, java.util.Collection<java.lang.Long> ids) Get datasets
java.util.Collection<DatasetData>	getDatasets(SecurityContext ctx, long projectId) Get datasets of a project
ImageData	getImage(SecurityContext ctx, long id) Get a image
java.util.Collection<ImageData>	getImages(SecurityContext ctx, java.util.Collection<java.lang.Long> ids) Get images
java.util.Collection<ImageData>	getImages(SecurityContext ctx, long datasetId) Get images of a dataset
PlateData	getPlate(SecurityContext ctx, long id) Get a plate
java.util.Collection<PlateData>	getPlates(SecurityContext ctx, java.util.Collection<java.lang.Long> ids) Get plates
java.util.Collection<PlateData>	getPlates(SecurityContext ctx, long screenId) Get plates for a screen
ProjectData	getProject(SecurityContext ctx, long id) Get a project
java.util.Collection<ProjectData>	getProjects(SecurityContext ctx, java.util.Collection<java.lang.Long> ids) Get projects
ScreenData	getScreen(SecurityContext ctx, long id) Get a screen
java.util.Collection<ScreenData>	getScreens(SecurityContext ctx, java.util.Collection<java.lang.Long> ids) Get screens
WellData	getWell(SecurityContext ctx, long id) Get a well (Note: This is a slightly deeper object, with wellsamples and images loaded)
java.util.Collection<WellData>	getWells(SecurityContext ctx, java.util.Collection<java.lang.Long> ids) Get wells (Note: These are slightly deeper objects, with wellsamples and images loaded)
java.util.Collection<WellData>	getWells(SecurityContext ctx, long plateId) Get wells of a plate (Note: These are slightly deeper objects, 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

getDatasets

public java.util.Collection<DatasetData> getDatasets(SecurityContext ctx,
                                                     java.util.Collection<java.lang.Long> ids)
                                              throws DSOutOfServiceException,
                                                     DSAccessException

Get datasets

Parameters:

ctx - The SecurityContext

ids - The ids of the datasets

Returns:

Collection of datasets (can be empty)

Throws:

DSOutOfServiceException

DSAccessException

getDatasets

public java.util.Collection<DatasetData> getDatasets(SecurityContext ctx,
                                                     long projectId)
                                              throws DSOutOfServiceException,
                                                     DSAccessException

Get datasets of a project

Parameters:

ctx - The SecurityContext

projectId - The project Id

Returns:

Collection of datasets (can be empty)

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

getProjects

public java.util.Collection<ProjectData> getProjects(SecurityContext ctx,
                                                     java.util.Collection<java.lang.Long> ids)
                                              throws DSOutOfServiceException,
                                                     DSAccessException

Get projects

Parameters:

ctx - The SecurityContext

ids - The ids of the projects

Returns:

Collection of projects (can be empty)

Throws:

DSOutOfServiceException

DSAccessException

getImage

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

Get a 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

getImages

public java.util.Collection<ImageData> getImages(SecurityContext ctx,
                                                 java.util.Collection<java.lang.Long> ids)
                                          throws DSOutOfServiceException,
                                                 DSAccessException

Get images

Parameters:

ctx - The SecurityContext

ids - The ids of the images

Returns:

Collection of images (can be empty)

Throws:

DSOutOfServiceException

DSAccessException

getImages

public java.util.Collection<ImageData> getImages(SecurityContext ctx,
                                                 long datasetId)
                                          throws DSOutOfServiceException,
                                                 DSAccessException

Get images of a dataset

Parameters:

ctx - The SecurityContext

datasetId - The dataset Id

Returns:

Collection of images (can be empty)

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

getScreens

public java.util.Collection<ScreenData> getScreens(SecurityContext ctx,
                                                   java.util.Collection<java.lang.Long> ids)
                                            throws DSOutOfServiceException,
                                                   DSAccessException

Get screens

Parameters:

ctx - The SecurityContext

ids - The ids of the screens

Returns:

Collection of screens (can be empty)

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

getPlates

public java.util.Collection<PlateData> getPlates(SecurityContext ctx,
                                                 java.util.Collection<java.lang.Long> ids)
                                          throws DSOutOfServiceException,
                                                 DSAccessException

Get plates

Parameters:

ctx - The SecurityContext

ids - The ids of the plates

Returns:

Collection of plates (can be empty)

Throws:

DSOutOfServiceException

DSAccessException

getPlates

public java.util.Collection<PlateData> getPlates(SecurityContext ctx,
                                                 long screenId)
                                          throws DSOutOfServiceException,
                                                 DSAccessException

Get plates for a screen

Parameters:

ctx - The SecurityContext

screenId - The screen Id

Returns:

Collection of plates (can be empty)

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

getWells

public java.util.Collection<WellData> getWells(SecurityContext ctx,
                                               java.util.Collection<java.lang.Long> ids)
                                        throws DSOutOfServiceException,
                                               DSAccessException

Get wells (Note: These are slightly deeper objects, with wellsamples and images loaded)

Parameters:

ctx - The SecurityContext

ids - The ids of the wells

Returns:

Collection of wells (can be empty)

Throws:

DSOutOfServiceException

DSAccessException

getWells

public java.util.Collection<WellData> getWells(SecurityContext ctx,
                                               long plateId)
                                        throws DSOutOfServiceException,
                                               DSAccessException

Get wells of a plate (Note: These are slightly deeper objects, with wellsamples and images loaded)

Parameters:

ctx - The SecurityContext

plateId - The plate Id

Returns:

Collection of wells (can be empty)

Throws:

DSOutOfServiceException

DSAccessException