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,
java.lang.String klassName,
long id)
Retrieves an updated version of the specified object.
|
omero.model.IObject |
findIObject(SecurityContext ctx,
java.lang.String klassName,
long id,
boolean allGroups)
Retrieves an updated version of the specified object.
|
<T extends DataObject> |
findObject(SecurityContext ctx,
java.lang.Class<T> klass,
long id)
Retrieves an updated version of the specified object.
|
<T extends DataObject> |
findObject(SecurityContext ctx,
java.lang.Class<T> klass,
long id,
boolean allGroups)
Retrieves an updated version of the specified object.
|
DataObject |
findObject(SecurityContext ctx,
java.lang.String pojoName,
long id)
Retrieves an updated version of the specified object.
|
DataObject |
findObject(SecurityContext ctx,
java.lang.String pojoName,
long id,
boolean allGroups)
Retrieves an updated version of the specified object.
|
java.util.Set<GroupData> |
getAvailableGroups(SecurityContext ctx,
ExperimenterData user)
Retrieves the groups visible by the current experimenter.
|
java.util.Collection<DatasetData> |
getDatasets(SecurityContext ctx)
Loads all datasets
|
java.util.Collection<DatasetData> |
getDatasets(SecurityContext ctx,
java.util.Collection<java.lang.Long> ids)
Loads the datasets with the given ids
|
java.util.Collection<DatasetData> |
getDatasets(SecurityContext ctx,
long ownerId)
Loads the datasets for a particular user
|
java.util.Collection<DatasetData> |
getDatasets(SecurityContext ctx,
long ownerId,
java.util.Collection<java.lang.Long> ids)
Loads the datasets with the given ids which belong to a particular user
|
java.util.Collection<FolderData> |
getFolders(SecurityContext ctx)
Get all folders the logged in user has access to.
|
java.util.Collection<FolderData> |
getFolders(SecurityContext ctx,
java.util.Collection<java.lang.Long> ids)
Get the folders for the given folder ids.
|
java.util.Collection<FolderData> |
getFolders(SecurityContext ctx,
long userId)
Get the folders which belong to the given user.
|
java.util.Collection<DataObject> |
getHierarchy(SecurityContext ctx,
java.lang.Class rootType,
java.util.List<java.lang.Long> rootIDs,
omero.sys.Parameters options)
Retrieves hierarchy trees rooted by a given node i.e. the requested node
as root and all of its descendants.
|
java.util.Collection<DataObject> |
getHierarchy(SecurityContext ctx,
java.lang.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
|
java.util.Collection<ImageData> |
getImages(SecurityContext ctx,
java.util.Collection<java.lang.Long> ids)
Loads the images with the given ids
|
java.util.Collection<ImageData> |
getImages(SecurityContext ctx,
java.util.Collection<java.lang.Long> ids,
ParametersI params)
Loads the images with the given ids
|
java.util.Collection<ImageData> |
getImages(SecurityContext ctx,
long ownerId,
java.util.Collection<java.lang.Long> ids)
Loads the images for a particular user
|
java.util.Collection<ImageData> |
getImagesForDatasets(SecurityContext ctx,
java.util.Collection<java.lang.Long> datasetIds)
Load all images belonging to particular datasets
|
java.util.Collection<ImageData> |
getImagesForProjects(SecurityContext ctx,
java.util.Collection<java.lang.Long> projectIds)
Load all images belonging to particular projects
|
java.util.Collection<java.lang.String> |
getLookupTables(SecurityContext ctx)
Get the available lookup tables
|
java.util.Collection<ImageData> |
getOrphanedImages(SecurityContext ctx,
long userID)
Get orphaned images for a certain user
|
java.util.Collection<PlateData> |
getPlates(SecurityContext ctx)
Loads all plates
|
java.util.Collection<PlateData> |
getPlates(SecurityContext ctx,
java.util.Collection<java.lang.Long> ids)
Loads the plates with the given ids
|
java.util.Collection<PlateData> |
getPlates(SecurityContext ctx,
long ownerId)
Loads the plates for a particular user
|
java.util.Collection<PlateData> |
getPlates(SecurityContext ctx,
long ownerId,
java.util.Collection<java.lang.Long> ids)
Loads the plates with the given ids which belong to a particular user
|
java.util.Collection<ProjectData> |
getProjects(SecurityContext ctx)
Get all projects
|
java.util.Collection<ProjectData> |
getProjects(SecurityContext ctx,
java.util.Collection<java.lang.Long> ids)
Get the projects for the given project ids
|
java.util.Collection<ProjectData> |
getProjects(SecurityContext ctx,
long ownerId)
Get the projects of a certain user
|
java.util.Collection<ProjectData> |
getProjects(SecurityContext ctx,
long ownerId,
java.util.Collection<java.lang.Long> ids)
Get the projects for the given project ids which belong to a certain user
|
java.util.Collection<ScreenData> |
getScreens(SecurityContext ctx)
Loads all screens
|
java.util.Collection<ScreenData> |
getScreens(SecurityContext ctx,
java.util.Collection<java.lang.Long> ids)
Loads the screens with the given ids
|
java.util.Collection<ScreenData> |
getScreens(SecurityContext ctx,
long ownerId)
Loads the screens for a particular user
|
java.util.Collection<ScreenData> |
getScreens(SecurityContext ctx,
long ownerId,
java.util.Collection<java.lang.Long> ids)
Loads the screens with the given ids which belong to a particular user
|
java.util.Collection<ImageData> |
getUserImages(SecurityContext ctx)
Loads all images of the logged in user
|
java.util.Collection<WellData> |
getWells(SecurityContext ctx,
java.util.Collection<java.lang.Long> wellIds)
Loads the wells
|
java.util.Collection<WellData> |
getWells(SecurityContext ctx,
long plateId)
Loads the wells for a given plate
|
java.util.Collection<FolderData> |
loadFolders(SecurityContext ctx,
java.util.Collection<java.lang.Long> ids)
Loads the folders for the given Ids.
|
addPropertyChangeListener, clear, firePropertyChanged, firePropertyChanged, getFacility, logDebug, logError, logInfo, logWarn, removePropertyChangeListener
public java.util.Collection<DataObject> getHierarchy(SecurityContext ctx, java.lang.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 java.util.Collection<DataObject> getHierarchy(SecurityContext ctx, java.lang.Class rootType, java.util.List<java.lang.Long> rootIDs, omero.sys.Parameters options) throws DSOutOfServiceException, DSAccessException
ctx
- The security context.rootType
- The type of node to handle.rootIDs
- The ids of the root nodes. Can be null
or empty,
in which case all root nodes the user has access to are
loaded.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 <T extends DataObject> T findObject(SecurityContext ctx, java.lang.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, java.lang.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 groupnull
it doesn't exist).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, java.lang.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, java.lang.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, java.lang.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, java.lang.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 groupsnull
it doesn't exist).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, 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 java.util.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 java.util.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 java.util.Collection<ProjectData> getProjects(SecurityContext ctx, java.util.Collection<java.lang.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 java.util.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 java.util.Collection<ProjectData> getProjects(SecurityContext ctx, long ownerId, java.util.Collection<java.lang.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 java.util.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 java.util.Collection<DatasetData> getDatasets(SecurityContext ctx, java.util.Collection<java.lang.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 java.util.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 java.util.Collection<DatasetData> getDatasets(SecurityContext ctx, long ownerId, java.util.Collection<java.lang.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 java.util.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 java.util.Collection<ScreenData> getScreens(SecurityContext ctx, java.util.Collection<java.lang.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 java.util.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 java.util.Collection<ScreenData> getScreens(SecurityContext ctx, long ownerId, java.util.Collection<java.lang.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 java.util.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 java.util.Collection<PlateData> getPlates(SecurityContext ctx, java.util.Collection<java.lang.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 java.util.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 java.util.Collection<PlateData> getPlates(SecurityContext ctx, long ownerId, java.util.Collection<java.lang.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 java.util.Collection<WellData> getWells(SecurityContext ctx, java.util.Collection<java.lang.Long> wellIds) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
wellIds
- The ids of the wells to loadWellData
sDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public java.util.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 java.util.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 java.util.Collection<ImageData> getImages(SecurityContext ctx, java.util.Collection<java.lang.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 java.util.Collection<ImageData> getImages(SecurityContext ctx, java.util.Collection<java.lang.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 java.util.Collection<ImageData> getOrphanedImages(SecurityContext ctx, long userID)
ctx
- The SecurityContext
userID
- The id of the userpublic java.util.Collection<ImageData> getImages(SecurityContext ctx, long ownerId, java.util.Collection<java.lang.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 java.util.Collection<ImageData> getImagesForDatasets(SecurityContext ctx, java.util.Collection<java.lang.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 java.util.Collection<ImageData> getImagesForProjects(SecurityContext ctx, java.util.Collection<java.lang.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.public java.util.Collection<FolderData> loadFolders(SecurityContext ctx, java.util.Collection<java.lang.Long> ids) throws DSOutOfServiceException, DSAccessException
FolderData
objects will be
fully initialized. (See getFolders(SecurityContext, Collection)
for
a faster but not fully initialized method)ctx
- The SecurityContext
ids
- The folder IdsDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public java.util.Collection<FolderData> getFolders(SecurityContext ctx) throws DSOutOfServiceException, DSAccessException
FolderData
objects won't be fully initialized (i. e. sub folder,
roi, etc. collections will be unloaded!). If you need fully initialized objects
see loadFolders(SecurityContext, Collection)
.ctx
- The SecurityContext
DSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public java.util.Collection<FolderData> getFolders(SecurityContext ctx, java.util.Collection<java.lang.Long> ids) throws DSOutOfServiceException, DSAccessException
FolderData
objects won't be fully initialized (i. e. sub folder,
roi, etc. collections will be unloaded!). If you need fully initialized objects
see loadFolders(SecurityContext, Collection)
.ctx
- The SecurityContext
ids
- The folder idsDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public java.util.Collection<FolderData> getFolders(SecurityContext ctx, long userId) throws DSOutOfServiceException, DSAccessException
FolderData
objects won't be fully initialized (i. e. sub folder,
roi, etc. collections will be unloaded!). If you need fully initialized objects
see loadFolders(SecurityContext, Collection)
.ctx
- The SecurityContext
userId
- The user idDSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.public java.util.Collection<java.lang.String> getLookupTables(SecurityContext ctx) throws DSOutOfServiceException, DSAccessException
ctx
- The SecurityContext
DSOutOfServiceException
- If the connection is broken, or not logged inDSAccessException
- If an error occurred while trying to retrieve data from OMERO
service.
Version: 5.4.10-ice35-b105
Copyright © 2019 The University of Dundee & Open Microscopy Environment. All Rights Reserved.