Package ome.xml.model
Class CommentAnnotation
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.Annotation
ome.xml.model.TextAnnotation
ome.xml.model.CommentAnnotation
- All Implemented Interfaces:
OMEModelObject
public class CommentAnnotation extends TextAnnotation
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAMESPACE
-
Constructor Summary
Constructors Constructor Description CommentAnnotation()
Default constructor.CommentAnnotation(CommentAnnotation orig)
Copy constructor.CommentAnnotation(org.w3c.dom.Element element, OMEModel model)
Constructs CommentAnnotation 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 CommentAnnotation_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.StructuredAnnotations
getStructuredAnnotations()
java.lang.String
getValue()
boolean
link(Reference reference, OMEModelObject o)
Link a given OME model object to this model object.void
setStructuredAnnotations(StructuredAnnotations structuredAnnotations_BackReference)
void
setValue(java.lang.String value)
void
update(org.w3c.dom.Element element, OMEModel model)
Updates CommentAnnotation recursively from an XML DOM tree.Methods inherited from class ome.xml.model.Annotation
copyLinkedAnnotationList, copyLinkedChannelList, copyLinkedDatasetList, copyLinkedDetectorList, copyLinkedDichroicList, copyLinkedExperimenterGroupList, copyLinkedExperimenterList, copyLinkedFilterList, copyLinkedFolderList, copyLinkedImageList, copyLinkedInstrumentList, copyLinkedLightPathList, copyLinkedLightSourceList, copyLinkedObjectiveList, copyLinkedPlaneList, copyLinkedPlateAcquisitionList, copyLinkedPlateList, copyLinkedProjectList, copyLinkedReagentList, copyLinkedROIList, copyLinkedScreenList, copyLinkedShapeList, copyLinkedWellList, getAnnotator, getDescription, getID, getLinkedAnnotation, getLinkedChannel, getLinkedDataset, getLinkedDetector, getLinkedDichroic, getLinkedExperimenter, getLinkedExperimenterGroup, getLinkedFilter, getLinkedFolder, getLinkedImage, getLinkedInstrument, getLinkedLightPath, getLinkedLightSource, getLinkedObjective, getLinkedPlane, getLinkedPlate, getLinkedPlateAcquisition, getLinkedProject, getLinkedReagent, getLinkedROI, getLinkedScreen, getLinkedShape, getLinkedWell, getNamespace, linkAnnotation, linkChannel, linkDataset, linkDetector, linkDichroic, linkExperimenter, linkExperimenterGroup, linkFilter, linkFolder, linkImage, linkInstrument, linkLightPath, linkLightSource, linkObjective, linkPlane, linkPlate, linkPlateAcquisition, linkProject, linkReagent, linkROI, linkScreen, linkShape, linkWell, setAnnotator, setDescription, setID, setLinkedAnnotation, setLinkedChannel, setLinkedDataset, setLinkedDetector, setLinkedDichroic, setLinkedExperimenter, setLinkedExperimenterGroup, setLinkedFilter, setLinkedFolder, setLinkedImage, setLinkedInstrument, setLinkedLightPath, setLinkedLightSource, setLinkedObjective, setLinkedPlane, setLinkedPlate, setLinkedPlateAcquisition, setLinkedProject, setLinkedReagent, setLinkedROI, setLinkedScreen, setLinkedShape, setLinkedWell, setNamespace, sizeOfLinkedAnnotationList, sizeOfLinkedChannelList, sizeOfLinkedDatasetList, sizeOfLinkedDetectorList, sizeOfLinkedDichroicList, sizeOfLinkedExperimenterGroupList, sizeOfLinkedExperimenterList, sizeOfLinkedFilterList, sizeOfLinkedFolderList, sizeOfLinkedImageList, sizeOfLinkedInstrumentList, sizeOfLinkedLightPathList, sizeOfLinkedLightSourceList, sizeOfLinkedObjectiveList, sizeOfLinkedPlaneList, sizeOfLinkedPlateAcquisitionList, sizeOfLinkedPlateList, sizeOfLinkedProjectList, sizeOfLinkedReagentList, sizeOfLinkedROIList, sizeOfLinkedScreenList, sizeOfLinkedShapeList, sizeOfLinkedWellList, unlinkAnnotation, unlinkChannel, unlinkDataset, unlinkDetector, unlinkDichroic, unlinkExperimenter, unlinkExperimenterGroup, unlinkFilter, unlinkFolder, unlinkImage, unlinkInstrument, unlinkLightPath, unlinkLightSource, unlinkObjective, unlinkPlane, unlinkPlate, unlinkPlateAcquisition, unlinkProject, unlinkReagent, unlinkROI, unlinkScreen, unlinkShape, unlinkWell
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
-
CommentAnnotation
public CommentAnnotation()Default constructor. -
CommentAnnotation
Constructs CommentAnnotation 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.
-
CommentAnnotation
Copy constructor.
-
-
Method Details
-
update
Updates CommentAnnotation recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
update
in interfaceOMEModelObject
- Overrides:
update
in classTextAnnotation
- 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 classTextAnnotation
- 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.
-
getValue
public java.lang.String getValue() -
setValue
public void setValue(java.lang.String value) -
getStructuredAnnotations
-
setStructuredAnnotations
-
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 classTextAnnotation
- 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 CommentAnnotation_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 classTextAnnotation
- Parameters:
document
- Destination document for element creation, etc.CommentAnnotation_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-