Package ome.formats.importer

Class ImportContainer

  • public class ImportContainer
extends java.lang.Object

    • Constructor Detail

      • ImportContainer

        public ImportContainer​(java.io.File file,
                       IObject target,
                       java.lang.Double[] userPixels,
                       java.lang.String reader,
                       java.lang.String[] usedFiles,
                       java.lang.Boolean isSPW)

      • ImportContainer

        public ImportContainer​(ImportConfig config,
                       java.io.File file,
                       IObject target,
                       java.lang.Double[] userPixels,
                       java.lang.String reader,
                       java.lang.String[] usedFiles,
                       java.lang.Boolean isSPW)

    • Method Detail

      • getDoThumbnails

        public boolean getDoThumbnails()
        Retrieves whether or not we are performing thumbnail creation upon import completion.
        Returns:
        true if we are to perform thumbnail creation and false otherwise.
        Since:
        OMERO Beta 4.3.0.

      • setDoThumbnails

        public void setDoThumbnails​(boolean v)
        Sets whether or not we are performing thumbnail creation upon import completion.
        Parameters:
        v - true if we are to perform thumbnail creation and false otherwise.
        Since:
        OMERO Beta 4.3.0.

      • getNoStatsInfo

        public boolean getNoStatsInfo()
        Retrieves whether or not we disabling StatsInfo population.
        Returns:
        true if we are to disable StatsInfo population. false otherwise.
        Since:
        OMERO 5.1.

      • setNoStatsInfo

        public void setNoStatsInfo​(boolean v)
        Sets whether or not we disabling StatsInfo population.
        Parameters:
        v - true if we are to disable StatsInfo population. false otherwise.
        Since:
        OMERO 5.1.

      • getUserSpecifiedName

        public java.lang.String getUserSpecifiedName()
        Retrieves the current custom image/plate name string.
        Returns:
        As above. null if it has not been set.

      • setUserSpecifiedName

        public void setUserSpecifiedName​(java.lang.String v)
        Sets the custom image/plate name for import. If this value is left null, the image/plate name supplied by Bio-Formats will be used.
        Parameters:
        v - A custom image/plate name to use for all entities represented by this container.

      • getUserSpecifiedDescription

        public java.lang.String getUserSpecifiedDescription()
        Retrieves the current custom image/plate description string.
        Returns:
        As above. null if it has not been set.
        Since:
        OMERO Beta 4.2.1.

      • setUserSpecifiedDescription

        public void setUserSpecifiedDescription​(java.lang.String v)
        Sets the custom image/plate description for import. If this value is left null, the image/plate description supplied by Bio-Formats will be used.
        Parameters:
        v - A custom image/plate description to use for all images represented by this container.
        Since:
        OMERO Beta 4.2.1.

      • getCustomAnnotationList

        public java.util.List<Annotation> getCustomAnnotationList()
        The list of custom, user specified, annotations to link to all images represented by this container.
        Returns:
        See above.
        Since:
        OMERO Beta 4.2.1.

      • setCustomAnnotationList

        public void setCustomAnnotationList​(java.util.List<Annotation> v)
        Sets the list of custom, user specified, annotations to link to all images represented by this container.
        Parameters:
        v - The list of annotations to use.
        Since:
        OMERO Beta 4.2.1.

      • getReader

        public java.lang.String getReader()
        Return the reader class name used for reading the contents of this import container.
        Returns:
        See above.

      • setReader

        public void setReader​(java.lang.String reader)
        Sets the reader class name used for reading the contents of this import container.
        Parameters:
        reader - Bio-Formats reader class name.

      • getUsedFiles

        public java.lang.String[] getUsedFiles()
        Return a list of file names that belong to this import container.
        Returns:
        See above.

      • setUsedFiles

        public void setUsedFiles​(java.lang.String[] usedFiles)
        Set the list of image file names that belong to this import container.
        Parameters:
        usedFiles -

      • getUsedFilesTotalSize

        public long getUsedFilesTotalSize()
        Returns the total size in bytes (based on File.length()) of all files in this import container.
        Returns:
        See above.

      • getIsSPW

        public java.lang.Boolean getIsSPW()
        Return true if this import container contains a Screen/Plate/Well image group. False otherwise.
        Returns:
        See above.

      • setIsSPW

        public void setIsSPW​(java.lang.Boolean isSPW)
        Set true if the import container is filled in with a Screen/Plate/Well image structure. False otherwise.
        Parameters:
        isSPW - True if container contains S/P/W, false otherwise.

      • getFile

        public java.io.File getFile()
        Returns:
        the File

      • getTarget

        public IObject getTarget()

      • setTarget

        public void setTarget​(IObject obj)

      • getUserPixels

        public java.lang.Double[] getUserPixels()

      • setUserPixels

        public void setUserPixels​(java.lang.Double[] userPixels)

      • getChecksumAlgorithm

        public java.lang.String getChecksumAlgorithm()

      • setChecksumAlgorithm

        public void setChecksumAlgorithm​(java.lang.String ca)

      • updateUsedFilesTotalSize

        public void updateUsedFilesTotalSize()