public class BrowseFacility extends Facility
Modifier and Type | Method and Description |
---|---|
omero.model.IObject |
findIObject(SecurityContext ctx,
omero.model.IObject o)
Retrieves an updated version of the specified object.
|
omero.model.IObject |
findIObject(SecurityContext ctx,
String klassName,
long id)
Retrieves an updated version of the specified object.
|
omero.model.IObject |
findIObject(SecurityContext ctx,
String klassName,
long id,
boolean allGroups)
Retrieves an updated version of the specified object.
|
<T extends DataObject> |
findObject(SecurityContext ctx,
Class<T> klass,
long id)
Retrieves an updated version of the specified object.
|
<T extends DataObject> |
findObject(SecurityContext ctx,
Class<T> klass,
long id,
boolean allGroups)
Retrieves an updated version of the specified object.
|
DataObject |
findObject(SecurityContext ctx,
String pojoName,
long id)
Retrieves an updated version of the specified object.
|
DataObject |
findObject(SecurityContext ctx,
String pojoName,
long id,
boolean allGroups)
Retrieves an updated version of the specified object.
|
Set<GroupData> |
getAvailableGroups(SecurityContext ctx,
ExperimenterData user)
Retrieves the groups visible by the current experimenter.
|
Collection<DatasetData> |
getDatasets(SecurityContext ctx)
Loads all datasets
|
Collection<DatasetData> |
getDatasets(SecurityContext ctx,
Collection<Long> ids)
Loads the datasets with the given ids
|
Collection<DatasetData> |
getDatasets(SecurityContext ctx,
long ownerId)
Loads the datasets for a particular user
|
Collection<DatasetData> |
getDatasets(SecurityContext ctx,
long ownerId,
Collection<Long> ids)
Loads the datasets with the given ids which belong to a particular user
|
Collection<DataObject> |
getHierarchy(SecurityContext ctx,
Class rootType,
List<Long> rootIDs,
omero.sys.Parameters options)
Retrieves hierarchy trees rooted by a given node.
|
Collection<DataObject> |
getHierarchy(SecurityContext ctx,
Class rootType,
long userId)
Retrieves hierarchy trees rooted by a given node.
|
ImageData |
getImage(SecurityContext ctx,
long id)
Loads a image
|
ImageData |
getImage(SecurityContext ctx,
long id,
ParametersI params)
Loads a image
|
Collection<ImageData> |
getImages(SecurityContext ctx,
Collection<Long> ids)
Loads the images with the given ids
|
Collection<ImageData> |
getImages(SecurityContext ctx,
Collection<Long> ids,
ParametersI params)
Loads the images with the given ids
|
Collection<ImageData> |
getImages(SecurityContext ctx,
long ownerId,
Collection<Long> ids)
Loads the images for a particular user
|
Collection<ImageData> |
getImagesForDatasets(SecurityContext ctx,
Collection<Long> datasetIds)
Load all images belonging to particular datasets
|
Collection<ImageData> |
getImagesForProjects(SecurityContext ctx,
Collection<Long> projectIds)
Load all images belonging to particular projects
|
Collection<ImageData> |
getOrphanedImages(SecurityContext ctx,
long userID)
Get orphaned images for a certain user
|
Collection<PlateData> |
getPlates(SecurityContext ctx)
Loads all plates
|
Collection<PlateData> |
getPlates(SecurityContext ctx,
Collection<Long> ids)
Loads the plates with the given ids
|
Collection<PlateData> |
getPlates(SecurityContext ctx,
long ownerId)
Loads the plates for a particular user
|
Collection<PlateData> |
getPlates(SecurityContext ctx,
long ownerId,
Collection<Long> ids)
Loads the plates with the given ids which belong to a particular user
|
Collection<ProjectData> |
getProjects(SecurityContext ctx)
Get all projects
|
Collection<ProjectData> |
getProjects(SecurityContext ctx,
Collection<Long> ids)
Get the projects for the given project ids
|
Collection<ProjectData> |
getProjects(SecurityContext ctx,
long ownerId)
Get the projects of a certain user
|
Collection<ProjectData> |
getProjects(SecurityContext ctx,
long ownerId,
Collection<Long> ids)
Get the projects for the given project ids which belong to a certain user
|
Collection<ScreenData> |
getScreens(SecurityContext ctx)
Loads all screens
|
Collection<ScreenData> |
getScreens(SecurityContext ctx,
Collection<Long> ids)
Loads the screens with the given ids
|
Collection<ScreenData> |
getScreens(SecurityContext ctx,
long ownerId)
Loads the screens for a particular user
|
Collection<ScreenData> |
getScreens(SecurityContext ctx,
long ownerId,
Collection<Long> ids)
Loads the screens with the given ids which belong to a particular user
|
Collection<ImageData> |
getUserImages(SecurityContext ctx)
Loads all images of the logged in user
|
Collection<WellData> |
getWells(SecurityContext ctx,
long plateId)
Loads the wells for a given plate
|
Set<DataObject> |
loadHierarchy(SecurityContext ctx,
Class rootType,
List<Long> rootIDs,
omero.sys.Parameters options)
Deprecated.
Please use the more generic method
getHierarchy(SecurityContext, Class, long) |
Set<DataObject> |
loadHierarchy(SecurityContext ctx,
Class rootType,
long userId)
Deprecated.
Please use the more generic method
getHierarchy(SecurityContext, Class, List, Parameters) |
addPropertyChangeListener, clear, getFacility, logDebug, logError, logInfo, logWarn, removePropertyChangeListener
public Collection<DataObject> getHierarchy(SecurityContext ctx, Class rootType, long userId) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.rootType
- The type of node to handle.userId
- The user's to retrieve the data to handle.DSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<DataObject> getHierarchy(SecurityContext ctx, Class rootType, List<Long> rootIDs, omero.sys.Parameters options) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.rootType
- The type of node to handle.rootIDs
- The node's id.options
- The retrieval options.DSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Set<DataObject> loadHierarchy(SecurityContext ctx, Class rootType, long userId) throws DSOutOfServiceException
getHierarchy(SecurityContext, Class, List, Parameters)
ctx
- The security context.rootType
- The type of node to handle.userId
- The user's to retrieve the data to handle.DSOutOfServiceException
- If the connection is broken, or not logged inpublic Set<DataObject> loadHierarchy(SecurityContext ctx, Class rootType, List<Long> rootIDs, omero.sys.Parameters options) throws DSOutOfServiceException
getHierarchy(SecurityContext, Class, long)
ctx
- The security context.rootType
- The type of node to handle.rootIDs
- The node's id.options
- The retrieval options.DSOutOfServiceException
- If the connection is broken, or not logged inpublic <T extends DataObject> T findObject(SecurityContext ctx, Class<T> klass, long id) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.klass
- The type of object to retrieve.id
- The object's id.DSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public <T extends DataObject> T findObject(SecurityContext ctx, Class<T> klass, long id, boolean allGroups) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.klass
- The type of object to retrieve.id
- The object's id.allGroups
- Pass true
to take all groups into account,
false
to only use ctx's groupDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public omero.model.IObject findIObject(SecurityContext ctx, String klassName, long id) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.klassName
- The type of object to retrieve.id
- The object's id.DSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public DataObject findObject(SecurityContext ctx, String pojoName, long id) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.pojoName
- The type of object to retrieve. (Either the simple or the full
class name, e. g. omero.gateway.model.DatasetData or
DatasetData)id
- The object's id.DSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public omero.model.IObject findIObject(SecurityContext ctx, String klassName, long id, boolean allGroups) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.klassName
- The type of object to retrieve.id
- The object's id.allGroups
- Pass true
to look for all groupsDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public DataObject findObject(SecurityContext ctx, String pojoName, long id, boolean allGroups) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.pojoName
- The type of object to retrieve. (Either the simple or the full
class name, e. g. omero.gateway.model.DatasetData or
DatasetData)id
- The object's id.allGroups
- Pass true
to look for all groupsDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public omero.model.IObject findIObject(SecurityContext ctx, omero.model.IObject o) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.o
- The object to retrieve.null
if the object
hasn't been persisted previouslyDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Set<GroupData> getAvailableGroups(SecurityContext ctx, ExperimenterData user) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.user
- The user currently logged in.DSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ProjectData> getProjects(SecurityContext ctx) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ProjectData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ProjectData> getProjects(SecurityContext ctx, Collection<Long> ids) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ids
- The ids of the projects to fetchProjectData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ProjectData> getProjects(SecurityContext ctx, long ownerId) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ownerId
- The id of the user (if <0
see
getProjects(SecurityContext)
)ProjectData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ProjectData> getProjects(SecurityContext ctx, long ownerId, Collection<Long> ids) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ownerId
- The id of the user (if <0
see
getProjects(SecurityContext, Collection)
)ids
- The ids of the projects to fetchProjectData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<DatasetData> getDatasets(SecurityContext ctx) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
DatasetData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<DatasetData> getDatasets(SecurityContext ctx, Collection<Long> ids) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ids
- The ids of the datasets to loadDatasetData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<DatasetData> getDatasets(SecurityContext ctx, long ownerId) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ownerId
- The id of the user (if <0
see
getDatasets(SecurityContext)
)DatasetData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<DatasetData> getDatasets(SecurityContext ctx, long ownerId, Collection<Long> ids) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ownerId
- The id of the user (if <0
see
getDatasets(SecurityContext, Collection)
)ids
- The ids of the datasets to loadDatasetData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ScreenData> getScreens(SecurityContext ctx) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ScreenData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ScreenData> getScreens(SecurityContext ctx, Collection<Long> ids) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ids
- The ids of the screens to loadScreenData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ScreenData> getScreens(SecurityContext ctx, long ownerId) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ownerId
- The id of the user (if <0
see
getScreens(SecurityContext)
)ScreenData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ScreenData> getScreens(SecurityContext ctx, long ownerId, Collection<Long> ids) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ownerId
- The id of the user (if <0
see
getScreens(SecurityContext, Collection)
)ids
- The ids of the screens to loadScreenData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<PlateData> getPlates(SecurityContext ctx) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
PlateData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<PlateData> getPlates(SecurityContext ctx, Collection<Long> ids) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ids
- The ids of the screens to loadPlateData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<PlateData> getPlates(SecurityContext ctx, long ownerId) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ownerId
- The id of the user (if <0
see
getPlates(SecurityContext)
)PlateData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<PlateData> getPlates(SecurityContext ctx, long ownerId, Collection<Long> ids) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ownerId
- The id of the user (if <0
see
getPlates(SecurityContext, Collection)
)ids
- The ids of the plates to loadPlateData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<WellData> getWells(SecurityContext ctx, long plateId) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
plateId
- The ID of the plateWellData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ImageData> getUserImages(SecurityContext ctx) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ImageData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public ImageData getImage(SecurityContext ctx, long id) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
id
- The ids of the image to loadImageData
DSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public ImageData getImage(SecurityContext ctx, long id, ParametersI params) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
id
- The ids of the image to loadparams
- Custom parameters, can be null
ImageData
DSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ImageData> getImages(SecurityContext ctx, Collection<Long> ids) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ids
- The ids of the images to loadImageData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ImageData> getImages(SecurityContext ctx, Collection<Long> ids, ParametersI params) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ids
- The ids of the images to loadparams
- Custom parameters, can be null
ImageData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ImageData> getOrphanedImages(SecurityContext ctx, long userID)
ctx
- The SecurityContext
userID
- The id of the userpublic Collection<ImageData> getImages(SecurityContext ctx, long ownerId, Collection<Long> ids) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
ownerId
- The id of the userids
- The image idsImageData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ImageData> getImagesForDatasets(SecurityContext ctx, Collection<Long> datasetIds) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
datasetIds
- The ids of the datasetsImageData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public Collection<ImageData> getImagesForProjects(SecurityContext ctx, Collection<Long> projectIds) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
projectIds
- The ids of the projectsImageData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.
Version: 5.2.6-ice35-b35
Copyright © 2016 The University of Dundee & Open Microscopy Environment. All Rights Reserved.