Package ome.xml.model
Class Reference
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.Reference
- All Implemented Interfaces:
OMEModelObject
- Direct Known Subclasses:
AnnotationRef,ChannelRef,DatasetRef,DichroicRef,ExperimenterGroupRef,ExperimenterRef,ExperimentRef,FilterRef,FilterSetRef,FolderRef,ImageRef,InstrumentRef,Leader,MicrobeamManipulationRef,PlateRef,ProjectRef,Pump,ReagentRef,ROIRef,Settings,WellSampleRef
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionasXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.asXMLElement(Document document, Element Reference_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.abstract StringgetID()Retrieves the reference's target object ID.booleanlink(Reference reference, OMEModelObject o) Link a given OME model object to this model object.abstract voidSets the reference's target object ID.voidUpdates Reference recursively from an XML DOM tree.Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
- See Also:
-
-
Constructor Details
-
Reference
public Reference()Default constructor. -
Reference
Constructs Reference 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.
-
Reference
Copy constructor.
-
-
Method Details
-
getID
Retrieves the reference's target object ID.- Returns:
- See above.
-
setID
Sets the reference's target object ID.- Parameters:
id- The object ID to set.
-
update
Updates Reference recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
updatein interfaceOMEModelObject- Overrides:
updatein classAbstractOMEModelObject- 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
Description copied from interface:OMEModelObjectLink a given OME model object to this model object.- Specified by:
linkin interfaceOMEModelObject- Overrides:
linkin classAbstractOMEModelObject- 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.
-
asXMLElement
Description copied from interface:OMEModelObjectTakes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElementin interfaceOMEModelObject- Specified by:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
Description copied from class:AbstractOMEModelObjectTakes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.- Overrides:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.Reference_element- Element from the subclass. Ifnulla new element will be created of this class.- Returns:
elementpopulated with properties from this class.
-