Package ome.xml.model
Class External
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.External
- All Implemented Interfaces:
OMEModelObject
public class External extends AbstractOMEModelObject
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAMESPACE
-
Constructor Summary
-
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.org.w3c.dom.Element
asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element External_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.Compression
getCompression()
java.lang.String
gethref()
java.lang.String
getSHA1()
boolean
link(Reference reference, OMEModelObject o)
Link a given OME model object to this model object.void
setCompression(Compression compression)
void
sethref(java.lang.String href)
void
setSHA1(java.lang.String sha1)
void
update(org.w3c.dom.Element element, OMEModel model)
Updates External recursively from an XML DOM tree.Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
public static final java.lang.String NAMESPACE- See Also:
- Constant Field Values
-
-
Constructor Details
-
External
public External()Default constructor. -
External
Constructs External 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.
-
External
Copy constructor.
-
-
Method Details
-
update
Updates External recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
update
in interfaceOMEModelObject
- Overrides:
update
in 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:OMEModelObject
Link a given OME model object to this model object.- Specified by:
link
in interfaceOMEModelObject
- Overrides:
link
in classAbstractOMEModelObject
- Parameters:
reference
- The type qualifier for the reference. This should be the corresponding reference type foro
. If, for example,o
is of typeImage
,reference
MUST be of typeImageRef
.o
- Model object to link to.- Returns:
true
if this model object was able to handle the reference,false
otherwise.
-
gethref
public java.lang.String gethref() -
sethref
public void sethref(java.lang.String href) -
getSHA1
public java.lang.String getSHA1() -
setSHA1
public void setSHA1(java.lang.String sha1) -
getCompression
-
setCompression
-
asXMLElement
public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document)Description copied from interface:OMEModelObject
Takes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElement
in interfaceOMEModelObject
- Specified by:
asXMLElement
in classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element External_element)Description copied from class:AbstractOMEModelObject
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.- Overrides:
asXMLElement
in classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.External_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-