Package ome.xml.model
Class DatasetRef
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.Reference
ome.xml.model.DatasetRef
- All Implemented Interfaces:
OMEModelObject
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.DatasetRef(DatasetRef orig) Copy constructor.DatasetRef(Element element, OMEModel model) Constructs DatasetRef recursively from an XML DOM tree. -
Method Summary
Modifier and TypeMethodDescriptionasXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.asXMLElement(Document document, Element DatasetRef_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.getID()Retrieves the reference's target object ID.booleanlink(Reference reference, OMEModelObject o) Link a given OME model object to this model object.voidSets the reference's target object ID.voidUpdates DatasetRef recursively from an XML DOM tree.Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
- See Also:
-
-
Constructor Details
-
DatasetRef
public DatasetRef()Default constructor. -
DatasetRef
Constructs DatasetRef 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.
-
DatasetRef
Copy constructor.
-
-
Method Details
-
update
Updates DatasetRef recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
updatein interfaceOMEModelObject- Overrides:
updatein classReference- 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 classReference- 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.
-
getID
Description copied from class:ReferenceRetrieves the reference's target object ID. -
setID
Description copied from class:ReferenceSets the reference's target object ID. -
asXMLElement
Description copied from interface:OMEModelObjectTakes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElementin interfaceOMEModelObject- Overrides:
asXMLElementin classReference- 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 classReference- Parameters:
document- Destination document for element creation, etc.DatasetRef_element- Element from the subclass. Ifnulla new element will be created of this class.- Returns:
elementpopulated with properties from this class.
-