Class ScreenWrapper

    • Field Detail

      • ANNOTATION_LINK

        public static final java.lang.String ANNOTATION_LINK
        Annotation link name for this type of object
        See Also:
        Constant Field Values
    • Constructor Detail

      • ScreenWrapper

        public ScreenWrapper​(Client client,
                             java.lang.String name,
                             java.lang.String description)
                      throws ServiceException,
                             AccessException,
                             java.util.concurrent.ExecutionException
        Constructor of the ProjectWrapper class. Creates a new project and saves it to OMERO.
        Parameters:
        client - The client handling the connection.
        name - Project name.
        description - Project description.
        Throws:
        ServiceException - Cannot connect to OMERO.
        AccessException - Cannot access data.
        java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.
      • ScreenWrapper

        public ScreenWrapper​(ScreenData screen)
        Constructor of the class ScreenWrapper.
        Parameters:
        screen - The ScreenData contained in the ScreenWrapper.
    • Method Detail

      • setName

        public void setName​(java.lang.String name)
        Sets the name of the screen.
        Parameters:
        name - The name of the screen. Mustn't be null.
        Throws:
        java.lang.IllegalArgumentException - If the name is null.
      • asScreenData

        public ScreenData asScreenData()
        Returns the ScreenData contained.
        Returns:
        See above.
      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the description of the screen.
        Parameters:
        description - The description of the screen.
      • getPlates

        public java.util.List<PlateWrapper> getPlates()
        Returns the plates contained in this screen.
        Returns:
        See above.
      • getPlates

        public java.util.List<PlateWrapper> getPlates​(java.lang.String name)
        Returns the plates contained in this screen, with the specified name.
        Parameters:
        name - The expected plates name.
        Returns:
        See above.
      • getProtocolDescription

        public java.lang.String getProtocolDescription()
        Returns the description of the protocol.
        Returns:
        See above.
      • setProtocolDescription

        public void setProtocolDescription​(java.lang.String value)
        Sets the description of the protocol.
        Parameters:
        value - The value to set.
      • getProtocolIdentifier

        public java.lang.String getProtocolIdentifier()
        Returns the identifier of the protocol.
        Returns:
        See above.
      • setProtocolIdentifier

        public void setProtocolIdentifier​(java.lang.String value)
        Sets the identifier of the protocol.
        Parameters:
        value - The value to set.
      • getReagentSetDescription

        public java.lang.String getReagentSetDescription()
        Returns the description of the reagent set.
        Returns:
        See above.
      • setReagentSetDescription

        public void setReagentSetDescription​(java.lang.String value)
        Sets the identifier of the reagent.
        Parameters:
        value - The value to set.
      • getReagentSetIdentifier

        public java.lang.String getReagentSetIdentifier()
        Returns the identifier of the Reagent set.
        Returns:
        See above.
      • setReagentSetIdentifier

        public void setReagentSetIdentifier​(java.lang.String value)
        Sets the identifier of the reagent.
        Parameters:
        value - The value to set.
      • refresh

        public void refresh​(GatewayWrapper client)
                     throws ServiceException,
                            AccessException,
                            java.util.concurrent.ExecutionException
        Refreshes the wrapped screen.
        Parameters:
        client - The client handling the connection.
        Throws:
        ServiceException - Cannot connect to OMERO.
        AccessException - Cannot access data.
        java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.
      • importImages

        public boolean importImages​(GatewayWrapper client,
                                    java.lang.String... paths)
                             throws ServiceException,
                                    OMEROServerError,
                                    AccessException,
                                    java.io.IOException,
                                    java.util.concurrent.ExecutionException
        Imports all images candidates in the paths to the screen in OMERO.
        Parameters:
        client - The client handling the connection.
        paths - Paths to the image files on the computer.
        Returns:
        If the import did not exit because of an error.
        Throws:
        ServiceException - Cannot connect to OMERO.
        AccessException - Cannot access data.
        OMEROServerError - Server error.
        java.io.IOException - Cannot read file.
        java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.
      • importImage

        public java.util.List<java.lang.Long> importImage​(GatewayWrapper client,
                                                          java.lang.String path)
                                                   throws ServiceException,
                                                          AccessException,
                                                          OMEROServerError,
                                                          java.util.concurrent.ExecutionException
        Imports one image file to the screen in OMERO.
        Parameters:
        client - The client handling the connection.
        path - Path to the image file on the computer.
        Returns:
        The list of IDs of the newly imported images.
        Throws:
        ServiceException - Cannot connect to OMERO.
        AccessException - Cannot access data.
        OMEROServerError - Server error.
        java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.