Package ome.xml.model
Class ExcitationFilterRef
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.Reference
ome.xml.model.FilterRef
ome.xml.model.ExcitationFilterRef
- All Implemented Interfaces:
OMEModelObject
public class ExcitationFilterRef extends FilterRef
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAMESPACE
-
Constructor Summary
Constructors Constructor Description ExcitationFilterRef()
Default constructor.ExcitationFilterRef(ExcitationFilterRef orig)
Copy constructor.ExcitationFilterRef(org.w3c.dom.Element element, OMEModel model)
Constructs ExcitationFilterRef recursively from an XML DOM tree. -
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 ExcitationFilterRef_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.boolean
link(Reference reference, OMEModelObject o)
Link a given OME model object to this model object.void
update(org.w3c.dom.Element element, OMEModel model)
Updates ExcitationFilterRef 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
-
ExcitationFilterRef
public ExcitationFilterRef()Default constructor. -
ExcitationFilterRef
public ExcitationFilterRef(org.w3c.dom.Element element, OMEModel model) throws EnumerationExceptionConstructs ExcitationFilterRef 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.
-
ExcitationFilterRef
Copy constructor.
-
-
Method Details
-
update
Updates ExcitationFilterRef recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
update
in interfaceOMEModelObject
- Overrides:
update
in classFilterRef
- 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 classFilterRef
- 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.
-
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
- Overrides:
asXMLElement
in classFilterRef
- 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 ExcitationFilterRef_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 classFilterRef
- Parameters:
document
- Destination document for element creation, etc.ExcitationFilterRef_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-