Package ome.xml.model

Class Image

    • Constructor Detail

      • Image

        public Image()
        Default constructor.

      • Image

        public Image​(org.w3c.dom.Element element,
             OMEModel model)
      throws EnumerationException
        Constructs Image recursively from an XML DOM tree.
        Parameters:
        element - Root of the XML DOM tree to construct a model object graph from.
        model - Handler for the OME model which keeps track of instances and references seen during object population.
        Throws:
        EnumerationException - If there is an error instantiating an enumeration during model object creation.

      • Image

        public Image​(Image orig)
        Copy constructor.

    • Method Detail

      • update

        public void update​(org.w3c.dom.Element element,
                   OMEModel model)
            throws EnumerationException
        Updates Image recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.
        Specified by:
        update in interface OMEModelObject
        Overrides:
        update in class AbstractOMEModelObject
        Parameters:
        element - Root of the XML DOM tree to construct a model object graph from.
        model - Handler for the OME model which keeps track of instances and references seen during object population.
        Throws:
        EnumerationException - If there is an error instantiating an enumeration during model object creation.

      • link

        public boolean link​(Reference reference,
                    OMEModelObject o)
        Description copied from interface: OMEModelObject
        Link a given OME model object to this model object.
        Specified by:
        link in interface OMEModelObject
        Overrides:
        link in class AbstractOMEModelObject
        Parameters:
        reference - The type qualifier for the reference. This should be the corresponding reference type for o. If, for example, o is of type Image, reference MUST be of type ImageRef.
        o - Model object to link to.
        Returns:
        true if this model object was able to handle the reference, false otherwise.

      • getID

        public java.lang.String getID()

      • setID

        public void setID​(java.lang.String id)

      • getName

        public java.lang.String getName()

      • setName

        public void setName​(java.lang.String name)

      • getAcquisitionDate

        public Timestamp getAcquisitionDate()

      • setAcquisitionDate

        public void setAcquisitionDate​(Timestamp acquisitionDate)

      • getLinkedExperimenter

        public Experimenter getLinkedExperimenter()

      • linkExperimenter

        public void linkExperimenter​(Experimenter o)

      • unlinkExperimenter

        public void unlinkExperimenter​(Experimenter o)

      • getDescription

        public java.lang.String getDescription()

      • setDescription

        public void setDescription​(java.lang.String description)

      • getLinkedExperiment

        public Experiment getLinkedExperiment()

      • linkExperiment

        public void linkExperiment​(Experiment o)

      • unlinkExperiment

        public void unlinkExperiment​(Experiment o)

      • unlinkExperimenterGroup

        public void unlinkExperimenterGroup​(ExperimenterGroup o)

      • getLinkedInstrument

        public Instrument getLinkedInstrument()

      • linkInstrument

        public void linkInstrument​(Instrument o)

      • unlinkInstrument

        public void unlinkInstrument​(Instrument o)

      • setObjectiveSettings

        public void setObjectiveSettings​(ObjectiveSettings objectiveSettings)

      • setImagingEnvironment

        public void setImagingEnvironment​(ImagingEnvironment imagingEnvironment)

      • getStageLabel

        public StageLabel getStageLabel()

      • setStageLabel

        public void setStageLabel​(StageLabel stageLabel)

      • getPixels

        public Pixels getPixels()

      • setPixels

        public void setPixels​(Pixels pixels)

      • sizeOfLinkedROIList

        public int sizeOfLinkedROIList()

      • copyLinkedROIList

        public java.util.List<ROI> copyLinkedROIList()

      • getLinkedROI

        public ROI getLinkedROI​(int index)

      • setLinkedROI

        public ROI setLinkedROI​(int index,
                        ROI o)

      • linkROI

        public boolean linkROI​(ROI o)

      • unlinkROI

        public boolean unlinkROI​(ROI o)

      • sizeOfLinkedMicrobeamManipulationList

        public int sizeOfLinkedMicrobeamManipulationList()

      • copyLinkedMicrobeamManipulationList

        public java.util.List<MicrobeamManipulation> copyLinkedMicrobeamManipulationList()

      • getLinkedMicrobeamManipulation

        public MicrobeamManipulation getLinkedMicrobeamManipulation​(int index)

      • sizeOfLinkedAnnotationList

        public int sizeOfLinkedAnnotationList()

      • copyLinkedAnnotationList

        public java.util.List<Annotation> copyLinkedAnnotationList()

      • getLinkedAnnotation

        public Annotation getLinkedAnnotation​(int index)

      • linkAnnotation

        public boolean linkAnnotation​(Annotation o)

      • unlinkAnnotation

        public boolean unlinkAnnotation​(Annotation o)

      • sizeOfLinkedDatasetList

        public int sizeOfLinkedDatasetList()

      • copyLinkedDatasetList

        public java.util.List<Dataset> copyLinkedDatasetList()

      • getLinkedDataset

        public Dataset getLinkedDataset​(int index)

      • setLinkedDataset

        public Dataset setLinkedDataset​(int index,
                                Dataset o)

      • linkDataset

        public boolean linkDataset​(Dataset o)

      • unlinkDataset

        public boolean unlinkDataset​(Dataset o)

      • sizeOfLinkedFolderList

        public int sizeOfLinkedFolderList()

      • copyLinkedFolderList

        public java.util.List<Folder> copyLinkedFolderList()

      • getLinkedFolder

        public Folder getLinkedFolder​(int index)

      • setLinkedFolder

        public Folder setLinkedFolder​(int index,
                              Folder o)

      • linkFolder

        public boolean linkFolder​(Folder o)

      • unlinkFolder

        public boolean unlinkFolder​(Folder o)

      • sizeOfLinkedWellSampleList

        public int sizeOfLinkedWellSampleList()

      • copyLinkedWellSampleList

        public java.util.List<WellSample> copyLinkedWellSampleList()

      • getLinkedWellSample

        public WellSample getLinkedWellSample​(int index)

      • linkWellSample

        public boolean linkWellSample​(WellSample o)

      • unlinkWellSample

        public boolean unlinkWellSample​(WellSample o)

      • asXMLElement

        public org.w3c.dom.Element asXMLElement​(org.w3c.dom.Document document)
        Description copied from interface: OMEModelObject
        Takes the entire object hierarchy and produces an XML DOM tree.
        Specified by:
        asXMLElement in interface OMEModelObject
        Specified by:
        asXMLElement in class AbstractOMEModelObject
        Parameters:
        document - Destination document for element creation, etc.
        Returns:
        XML DOM tree root element for this model object.

      • asXMLElement

        public org.w3c.dom.Element asXMLElement​(org.w3c.dom.Document document,
                                        org.w3c.dom.Element Image_element)
        Description copied from class: AbstractOMEModelObject
        Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
        Overrides:
        asXMLElement in class AbstractOMEModelObject
        Parameters:
        document - Destination document for element creation, etc.
        Image_element - Element from the subclass. If null a new element will be created of this class.
        Returns:
        element populated with properties from this class.