Package 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
- Author:
- callan
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final org.slf4j.LoggerLogger for this class. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract ElementasXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.protected ElementasXMLElement(Document document, Element element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.getChildrenByTagName(Element parent, String name) Retrieves all the children of an element that have a given tag name.booleanlink(Reference reference, OMEModelObject o) Link a given OME model object to this model object.static StringStrips the namespace prefix off of a given tag name.voidUpdates the object hierarchy recursively from an XML DOM tree.
-
Field Details
-
LOGGER
protected static final org.slf4j.Logger LOGGERLogger for this class.
-
-
Constructor Details
-
AbstractOMEModelObject
public AbstractOMEModelObject()
-
-
Method Details
-
update
Description copied from interface:OMEModelObjectUpdates the object hierarchy recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
updatein interfaceOMEModelObject- 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
Description copied from interface:OMEModelObjectTakes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElementin interfaceOMEModelObject- Parameters:
document- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
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. Ifnulla new element will be created of this class.- Returns:
elementpopulated with properties from this class.
-
link
Description copied from interface:OMEModelObjectLink a given OME model object to this model object.- Specified by:
linkin interfaceOMEModelObject- Parameters:
reference- The type qualifier for the reference. This should be the corresponding reference type foro. If, for example,ois of typeImage,referenceMUST be of typeImageRef.o- Model object to link to.- Returns:
trueif this model object was able to handle the reference,falseotherwise.
-
getChildrenByTagName
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
Strips the namespace prefix off of a given tag name.- Parameters:
v- Tag name to strip the prefix from if it has one.- Returns:
vwith the namespace prefix stripped orvif it has none.
-