Package ome.xml.model

Interface OMEModelObject

All Known Implementing Classes:
AbstractOMEModelObject, AffineTransform, Annotation, AnnotationRef, Arc, BasicAnnotation, BinaryFile, BinaryOnly, BinData, BooleanAnnotation, Channel, ChannelRef, CommentAnnotation, Dataset, DatasetRef, Detector, DetectorSettings, Dichroic, DichroicRef, DoubleAnnotation, Ellipse, EmissionFilterRef, ExcitationFilterRef, Experiment, Experimenter, ExperimenterGroup, ExperimenterGroupRef, ExperimenterRef, ExperimentRef, External, Filament, FileAnnotation, Filter, FilterRef, FilterSet, FilterSetRef, Folder, FolderRef, GenericExcitationSource, Image, ImageRef, ImagingEnvironment, Instrument, InstrumentRef, Label, Laser, Leader, LightEmittingDiode, LightPath, LightSource, LightSourceSettings, Line, ListAnnotation, LongAnnotation, ManufacturerSpec, MapAnnotation, Mask, MetadataOnly, MicrobeamManipulation, MicrobeamManipulationRef, Microscope, NumericAnnotation, Objective, ObjectiveSettings, OME, OMEXMLMetadataRoot, Pixels, Plane, Plate, PlateAcquisition, PlateRef, Point, Polygon, Polyline, Project, ProjectRef, Pump, Reagent, ReagentRef, Rectangle, Reference, Rights, ROI, ROIRef, Screen, Settings, Shape, StageLabel, StructuredAnnotations, TagAnnotation, TermAnnotation, TextAnnotation, TiffData, TimestampAnnotation, TransmittanceRange, TypeAnnotation, Union, UUID, Well, WellSample, WellSampleRef, XMLAnnotation
public interface OMEModelObject
Author:
callan

  • Method Summary

    Modifier and Type Method Description
    org.w3c.dom.Element asXMLElement​(org.w3c.dom.Document document)
    Takes the entire object hierarchy and produces an XML DOM tree.
    boolean link​(Reference reference, OMEModelObject o)
    Link a given OME model object to this model object.
    void update​(org.w3c.dom.Element element, OMEModel model)
    Updates the object hierarchy recursively from an XML DOM tree.

  • Method Details

    • asXMLElement

      org.w3c.dom.Element asXMLElement​(org.w3c.dom.Document document)
      Takes the entire object hierarchy and produces an XML DOM tree.
      Parameters:
      document - Destination document for element creation, etc.
      Returns:
      XML DOM tree root element for this model object.

    • update

      void update​(org.w3c.dom.Element element, OMEModel model) throws EnumerationException
      Updates the object hierarchy recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.
      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

      boolean link​(Reference reference, OMEModelObject o)
      Link a given OME model object to this model object.
      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.