org.hkijena.jipipe.plugins.omero.util

Class OMEROGateway

java.lang.Object

org.hkijena.jipipe.plugins.omero.util.OMEROGateway

All Implemented Interfaces:

AutoCloseable

public class OMEROGateway
extends Object
implements AutoCloseable

Constructor Summary

Constructors

Constructor and Description
OMEROGateway(omero.gateway.LoginCredentials credentials, JIPipeProgressInfo progressInfo)

Method Summary

Modifier and Type	Method and Description
void	attachKeyValuePairs(Map<String,String> keyValuePairs, omero.gateway.model.DataObject data, omero.gateway.SecurityContext context)
void	attachTags(Set<String> tags, omero.gateway.model.DataObject data, omero.gateway.SecurityContext context)
void	close()
omero.gateway.facility.BrowseFacility	getBrowseFacility()
omero.gateway.LoginCredentials	getCredentials()
omero.gateway.facility.DataManagerFacility	getDataManagerFacility()
omero.gateway.model.DatasetData	getDataset(long datasetId, long groupId) Gets a dataset
omero.gateway.Gateway	getGateway()
omero.gateway.model.ImageData	getImage(long imageId, long groupId) Gets a dataset
Map<String,omero.gateway.model.TagAnnotationData>	getKnownTags(omero.gateway.SecurityContext context)
omero.gateway.facility.MetadataFacility	getMetadataFacility()
omero.gateway.model.PlateData	getPlate(long plateId, int groupId)
JIPipeProgressInfo	getProgressInfo()
omero.gateway.model.ProjectData	getProject(long projectId, long groupId) Gets a project
omero.gateway.model.ScreenData	getScreen(long screenId, int groupId)
omero.gateway.model.ExperimenterData	getUser()
omero.gateway.model.WellData	getWell(long wellId, int groupId)

Methods inherited from class java.lang.Object

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

Constructor Detail

OMEROGateway

public OMEROGateway(omero.gateway.LoginCredentials credentials,
                    JIPipeProgressInfo progressInfo)

Method Detail

getCredentials

public omero.gateway.LoginCredentials getCredentials()

getGateway

public omero.gateway.Gateway getGateway()

getBrowseFacility

public omero.gateway.facility.BrowseFacility getBrowseFacility()

getDataManagerFacility

public omero.gateway.facility.DataManagerFacility getDataManagerFacility()

getProgressInfo

public JIPipeProgressInfo getProgressInfo()

getUser

public omero.gateway.model.ExperimenterData getUser()

close

public void close()

Specified by:

close in interface AutoCloseable

getMetadataFacility

public omero.gateway.facility.MetadataFacility getMetadataFacility()

getProject

public omero.gateway.model.ProjectData getProject(long projectId,
                                                  long groupId)

Gets a project

Parameters:

projectId - the project ID

groupId - the group ID. Can be negative; then all available group Ids will be tested

Returns:

the project or null if it was not found

getDataset

public omero.gateway.model.DatasetData getDataset(long datasetId,
                                                  long groupId)

Gets a dataset

Parameters:

datasetId - the project ID

groupId - the group ID. Can be negative; then all available group Ids will be tested

Returns:

the project or null if it was not found

getImage

public omero.gateway.model.ImageData getImage(long imageId,
                                              long groupId)

Gets a dataset

Parameters:

imageId - the image ID

groupId - the group ID. Can be negative; then all available group Ids will be tested

Returns:

the project or null if it was not found

getPlate

public omero.gateway.model.PlateData getPlate(long plateId,
                                              int groupId)

getScreen

public omero.gateway.model.ScreenData getScreen(long screenId,
                                                int groupId)

getWell

public omero.gateway.model.WellData getWell(long wellId,
                                            int groupId)

getKnownTags

public Map<String,omero.gateway.model.TagAnnotationData> getKnownTags(omero.gateway.SecurityContext context)
                                                               throws omero.gateway.exception.DSOutOfServiceException,
                                                                      omero.ServerError

Throws:

omero.gateway.exception.DSOutOfServiceException

omero.ServerError

attachKeyValuePairs

public void attachKeyValuePairs(Map<String,String> keyValuePairs,
                                omero.gateway.model.DataObject data,
                                omero.gateway.SecurityContext context)
                         throws omero.gateway.exception.DSOutOfServiceException,
                                omero.gateway.exception.DSAccessException

Throws:

omero.gateway.exception.DSOutOfServiceException

omero.gateway.exception.DSAccessException

attachTags

public void attachTags(Set<String> tags,
                       omero.gateway.model.DataObject data,
                       omero.gateway.SecurityContext context)
                throws omero.gateway.exception.DSOutOfServiceException,
                       omero.gateway.exception.DSAccessException,
                       omero.ServerError

Throws:

omero.gateway.exception.DSOutOfServiceException

omero.gateway.exception.DSAccessException

omero.ServerError