pojos
Class ImageData

java.lang.Object
  extended by pojos.DataObject
      extended by pojos.ImageData

public class ImageData
extends DataObject

The data that makes up an OME Image along with links to its Pixels, enclosing Datasets, and the Experimenter that owns this Image.

Since:
OME2.2
Version:
2.2 (Internal version: $Revision$ $Date: 2005/05/09 19:50:41 $)
Author:
Jean-Marie Burel      j.burel@dundee.ac.uk,
Andrea Falconi      a.falconi@dundee.ac.uk

Field Summary
static String ANNOTATIONS
          Identifies the Image#ANNOTATIONLINKS field.
static String DATASET_LINKS
          Identifies the Image#DATASETLINKS field.
static String DESCRIPTION
          Identifies the Image#DESCRIPTION field.
static String NAME
          Identifies the Image#NAME field.
static String PIXELS
          Identifies the Image#PIXELS field.
 
Constructor Summary
ImageData()
          Creates a new instance.
ImageData(omero.model.Image image)
          Creates a new instance.
 
Method Summary
 Timestamp getAcquisitionDate()
          Returns the acquisition date.
 List<PixelsData> getAllPixels()
          Returns all the sets of pixels related to this image.
 Set getAnnotations()
          Returns the annotations
 Map<Long,Long> getAnnotationsCounts()
          Returns the number of annotations linked to the object, key: id of the user, value: number of annotation.
 Set getDatasets()
          Returns the datasets containing this image.
 PixelsData getDefaultPixels()
          Returns the default set of pixels.
 String getDescription()
          Returns the description of the image.
 int getIndex()
          Returns the index of the image within the multi-images file.
 Timestamp getInserted()
          Returns the insertion time of the image.
 long getInstrumentId()
          Returns the id of the instrument if any.
 String getName()
          Returns the name of the image.
 String getParentFilePath()
          Returns the path to the file hosting the image.
 String getPathToFile()
          Returns the path to the file.
 omero.model.OriginalFile getReference()
          Returns the reference to the file to register.
 boolean isArchived()
          Returns true if the image has been archived, false otherwise.
 boolean isLifetime()
          Returns true if the image is a lifetime image, false otherwise.
 void setAllPixels(List<PixelsData> newValue)
          Sets the set of pixels related to this image.
 void setAnnotations(Set newValue)
          Sets the image's annotations.
 void setDatasets(Set newValue)
          Sets the datasets containing the image.
 void setDefaultPixels(PixelsData defaultPixels)
          Sets the default set of pixels.
 void setDescription(String description)
          Sets the description of the image.
 void setName(String name)
          Sets the name of the image.
 void setParentFilePath(String path, int index)
          Sets the path to the file hosting the image.
 void setPathToFile(String path)
          Sets the path to the file.
 void setReference(omero.model.OriginalFile reference)
          Sets the reference to the file to register.
 void setRegisteredFile(omero.model.Image object)
          Sets the registered file.
 
Methods inherited from class pojos.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, getCreated, getDetails, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NAME

public static final String NAME
Identifies the Image#NAME field.

See Also:
Constant Field Values

DESCRIPTION

public static final String DESCRIPTION
Identifies the Image#DESCRIPTION field.

See Also:
Constant Field Values

PIXELS

public static final String PIXELS
Identifies the Image#PIXELS field.

See Also:
Constant Field Values

ANNOTATIONS

public static final String ANNOTATIONS
Identifies the Image#ANNOTATIONLINKS field.

See Also:
Constant Field Values

DATASET_LINKS

public static final String DATASET_LINKS
Identifies the Image#DATASETLINKS field.

See Also:
Constant Field Values
Constructor Detail

ImageData

public ImageData()
Creates a new instance.


ImageData

public ImageData(omero.model.Image image)
Creates a new instance.

Parameters:
image - Back pointer to the Image model object. Mustn't be null.
Throws:
IllegalArgumentException - If the object is null.
Method Detail

setPathToFile

public void setPathToFile(String path)
Sets the path to the file.

Parameters:
path - The value to set.

setReference

public void setReference(omero.model.OriginalFile reference)
Sets the reference to the file to register.

Parameters:
reference - The value to set.

getReference

public omero.model.OriginalFile getReference()
Returns the reference to the file to register.

Returns:
See above.

getPathToFile

public String getPathToFile()
Returns the path to the file.

Returns:
See above.

setParentFilePath

public void setParentFilePath(String path,
                              int index)
Sets the path to the file hosting the image. This should only be used to handle multi-images file e.g. some Leica files. Sets the index of the image within that file.

Parameters:
path - The path to set.
index - The index to set.

getParentFilePath

public String getParentFilePath()
Returns the path to the file hosting the image. This should only be used to handle multi-images file e.g. some Leica files.

Returns:
See above.

getIndex

public int getIndex()
Returns the index of the image within the multi-images file.

Returns:
See above.

setRegisteredFile

public void setRegisteredFile(omero.model.Image object)
Sets the registered file.

Parameters:
object - The object to store.

setName

public void setName(String name)
Sets the name of the image.

Parameters:
name - The name of the image. Mustn't be null.
Throws:
IllegalArgumentException - If the name is null.

getName

public String getName()
Returns the name of the image.

Returns:
See above.

setDescription

public void setDescription(String description)
Sets the description of the image.

Parameters:
description - The description of the image.

getDescription

public String getDescription()
Returns the description of the image.

Returns:
See above.

isArchived

public boolean isArchived()
Returns true if the image has been archived, false otherwise.

Returns:
See above.

getAnnotationsCounts

public Map<Long,Long> getAnnotationsCounts()
Returns the number of annotations linked to the object, key: id of the user, value: number of annotation. The map may be null if no annotation.

Returns:
See above.

getInserted

public Timestamp getInserted()
Returns the insertion time of the image.

Returns:
See above.

getAcquisitionDate

public Timestamp getAcquisitionDate()
Returns the acquisition date.

Returns:
See above.

getDefaultPixels

public PixelsData getDefaultPixels()
Returns the default set of pixels.

Returns:
See above.

setDefaultPixels

public void setDefaultPixels(PixelsData defaultPixels)
Sets the default set of pixels.

Parameters:
defaultPixels - The default set of pixels.

getAllPixels

public List<PixelsData> getAllPixels()
Returns all the sets of pixels related to this image.

Returns:
See above.

setAllPixels

public void setAllPixels(List<PixelsData> newValue)
Sets the set of pixels related to this image.

Parameters:
newValue - The set of pixels' set.

getDatasets

public Set getDatasets()
Returns the datasets containing this image.

Returns:
See above.

setDatasets

public void setDatasets(Set newValue)
Sets the datasets containing the image.

Parameters:
newValue - The set of datasets.

getAnnotations

public Set getAnnotations()
Returns the annotations

Returns:
See above.

setAnnotations

public void setAnnotations(Set newValue)
Sets the image's annotations.

Parameters:
newValue - The set of annotations.

isLifetime

public boolean isLifetime()
Returns true if the image is a lifetime image, false otherwise.

Returns:
See above.

getInstrumentId

public long getInstrumentId()
Returns the id of the instrument if any.

Returns:
See above.


OmeroJava Api

Version: Beta4.2.1-r8614-Beta4.2-b41

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