ome.formats.importer
Class ImportContainer

java.lang.Object
  extended by ome.formats.importer.ImportContainer

public class ImportContainer
extends Object


Constructor Summary
ImportContainer(File file, Long projectID, omero.model.IObject target, Boolean archive, Double[] userPixels, String reader, String[] usedFiles, Boolean isSPW)
           
 
Method Summary
 boolean getArchive()
           
 Integer getBfImageCount()
           
 List<String> getBfImageNames()
           
 List<omero.model.Pixels> getBfPixels()
           
 List<omero.model.Annotation> getCustomAnnotationList()
          The list of custom, user specified, annotations to link to all images represented by this container.
 String getCustomImageDescription()
          Retrieves the current custom image description string.
 String getCustomImageName()
          Retrieves the current custom image name string.
 String getCustomPlateDescription()
          Retrieves the current custom plate description string.
 String getCustomPlateName()
          Retrieves the current custom plate name string.
 boolean getDoThumbnails()
          Retrieves whether or not we are performing thumbnail creation upon import completion.
 File getFile()
           
 Boolean getIsSPW()
           
 boolean getMetadataOnly()
          Retrieves the metadata only flag.
 Long getProjectID()
           
 String getReader()
           
 omero.model.IObject getTarget()
           
 String[] getUsedFiles()
           
 boolean getUseMetadataFile()
          Whether or not we're using an original metadata file.
 Double[] getUserPixels()
           
 void setArchive(boolean archive)
           
 void setBfImageCount(Integer bfImageCount)
           
 void setBfImageNames(List<String> bfImageNames)
           
 void setBfPixels(List<omero.model.Pixels> bfPixels)
           
 void setCustomAnnotationList(List<omero.model.Annotation> v)
          Sets the list of custom, user specified, annotations to link to all images represented by this container.
 void setCustomImageDescription(String v)
          Sets the custom image description for import.
 void setCustomImageName(String v)
          Sets the custom image name for import.
 void setCustomPlateDescription(String v)
          Sets the custom plate description for import.
 void setCustomPlateName(String v)
          Sets the custom plate name for import.
 void setDoThumbnails(boolean v)
          Sets whether or not we are performing thumbnail creation upon import completion.
 void setIsSPW(Boolean isSPW)
           
 void setMetadataOnly(boolean isMetadataOnly)
          Sets the metadata only flag.
 void setProjectID(Long projectID)
           
 void setReader(String reader)
           
 void setTarget(omero.model.IObject obj)
           
 void setUsedFiles(String[] usedFiles)
           
 void setUseMetadataFile(boolean v)
          Sets whether or not we're using an original metadata file.
 void setUserPixels(Double[] userPixels)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImportContainer

public ImportContainer(File file,
                       Long projectID,
                       omero.model.IObject target,
                       Boolean archive,
                       Double[] userPixels,
                       String reader,
                       String[] usedFiles,
                       Boolean isSPW)
Method Detail

getBfImageCount

public Integer getBfImageCount()

setBfImageCount

public void setBfImageCount(Integer bfImageCount)

getBfPixels

public List<omero.model.Pixels> getBfPixels()

setBfPixels

public void setBfPixels(List<omero.model.Pixels> bfPixels)

getBfImageNames

public List<String> getBfImageNames()

setBfImageNames

public void setBfImageNames(List<String> bfImageNames)

getMetadataOnly

public boolean getMetadataOnly()
Retrieves the metadata only flag.

Returns:
See above.

setMetadataOnly

public void setMetadataOnly(boolean isMetadataOnly)
Sets the metadata only flag.

Parameters:
isMetadataOnly - Whether or not to perform metadata only imports with this container.
Since:
OMERO Beta 4.3.0.

getDoThumbnails

public boolean getDoThumbnails()
Retrieves whether or not we are performing thumbnail creation upon import completion. return 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.

getCustomImageName

public String getCustomImageName()
Retrieves the current custom image name string.

Returns:
As above. null if it has not been set.

setCustomImageName

public void setCustomImageName(String v)
Sets the custom image name for import. If this value is left null, the image description supplied by Bio-Formats will be used.

Parameters:
v - A custom image name to use for all images represented by this container.

getCustomImageDescription

public String getCustomImageDescription()
Retrieves the current custom image description string.

Returns:
As above. null if it has not been set.
Since:
OMERO Beta 4.2.1.

setCustomImageDescription

public void setCustomImageDescription(String v)
Sets the custom image description for import. If this value is left null, the image description supplied by Bio-Formats will be used.

Parameters:
v - A custom image description to use for all images represented by this container.
Since:
OMERO Beta 4.2.1.

getCustomPlateName

public String getCustomPlateName()
Retrieves the current custom plate name string.

Returns:
As above. null if it has not been set.
Since:
OMERO Beta 4.2.1.

setCustomPlateName

public void setCustomPlateName(String v)
Sets the custom plate name for import. If this value is left null, the plate description supplied by Bio-Formats will be used.

Parameters:
v - A custom plate name to use for all plates represented by this container.
Since:
OMERO Beta 4.2.1.

getCustomPlateDescription

public String getCustomPlateDescription()
Retrieves the current custom plate description string.

Returns:
As above. null if it has not been set.
Since:
OMERO Beta 4.2.1.

setCustomPlateDescription

public void setCustomPlateDescription(String v)
Sets the custom plate description for import. If this value is left null, the plate description supplied by Bio-Formats will be used.

Parameters:
v - A custom plate description to use for all plates represented by this container.
Since:
OMERO Beta 4.2.1.

getUseMetadataFile

public boolean getUseMetadataFile()
Whether or not we're using an original metadata file.

Returns:
See above.
Since:
OMERO Beta 4.2.1.

setUseMetadataFile

public void setUseMetadataFile(boolean v)
Sets whether or not we're using an original metadata file.

Since:
OMERO Beta 4.2.1.

getCustomAnnotationList

public List<omero.model.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(List<omero.model.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 String getReader()

setReader

public void setReader(String reader)

getUsedFiles

public String[] getUsedFiles()

setUsedFiles

public void setUsedFiles(String[] usedFiles)

getIsSPW

public Boolean getIsSPW()

setIsSPW

public void setIsSPW(Boolean isSPW)

getFile

public File getFile()
Returns:
the File

getProjectID

public Long getProjectID()
Returns:
Returns the projectID.

setProjectID

public void setProjectID(Long projectID)

getTarget

public omero.model.IObject getTarget()

setTarget

public void setTarget(omero.model.IObject obj)

getUserPixels

public Double[] getUserPixels()

setUserPixels

public void setUserPixels(Double[] userPixels)

setArchive

public void setArchive(boolean archive)

getArchive

public boolean getArchive()


OmeroJava Api

Version: 4.3.4-dbcbce5a-b4

Copyright © 2009 The University of Dundee. All Rights Reserved.