ome.xml.model

Class AbstractOMEModelObject

java.lang.Object

ome.xml.model.AbstractOMEModelObject

All Implemented Interfaces:

OMEModelObject

Direct Known Subclasses:

AffineTransform, Annotation, BinaryFile, BinaryOnly, BinData, Channel, Dataset, Experiment, Experimenter, ExperimenterGroup, External, Folder, Image, ImagingEnvironment, Instrument, LightPath, ManufacturerSpec, MetadataOnly, MicrobeamManipulation, OME, Pixels, Plane, Plate, PlateAcquisition, Project, Reagent, Reference, Rights, ROI, Screen, Shape, StageLabel, StructuredAnnotations, TiffData, TransmittanceRange, Union, UUID, Well, WellSample

public abstract class AbstractOMEModelObject
extends Object
implements OMEModelObject

Author:

callan

Constructor Summary

Constructors

Constructor and Description
AbstractOMEModelObject()

Method Summary

Modifier and Type	Method and Description
abstract Element	asXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.
protected Element	asXMLElement(Document document, Element element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
static List<Element>	getChildrenByTagName(Element parent, String name) Retrieves all the children of an element that have a given tag name.
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
static String	stripNamespacePrefix(String v) Strips the namespace prefix off of a given tag name.
void	update(Element element, OMEModel model) Updates the object hierarchy recursively from an XML DOM tree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractOMEModelObject

public AbstractOMEModelObject()

Method Detail

update

public void update(Element element,
                   OMEModel model)
            throws EnumerationException

Description copied from interface: OMEModelObject

Updates the object hierarchy recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.

Specified by:

update in interface OMEModelObject

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.

asXMLElement

public abstract Element asXMLElement(Document document)

Description copied from interface: OMEModelObject

Takes the entire object hierarchy and produces an XML DOM tree.

Specified by:

asXMLElement in interface OMEModelObject

Parameters:

document - Destination document for element creation, etc.

Returns:

XML DOM tree root element for this model object.

asXMLElement

protected Element asXMLElement(Document document,
                               Element element)

Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.

Parameters:

document - Destination document for element creation, etc.

element - Element from the subclass. If null a new element will be created of this class.

Returns:

element populated with properties from this class.

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

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.

getChildrenByTagName

public static List<Element> getChildrenByTagName(Element parent,
                                                 String name)

Retrieves all the children of an element that have a given tag name. If a tag has a namespace prefix it will be stripped prior to attempting a name match.

Parameters:

parent - DOM element to retrieve tags based upon.

name - Name of the tags to retrieve.

Returns:

List of elements which have the tag name.

stripNamespacePrefix

public static String stripNamespacePrefix(String v)

Strips the namespace prefix off of a given tag name.

Parameters:

v - Tag name to strip the prefix from if it has one.

Returns:

v with the namespace prefix stripped or v if it has none.