Package ome.xml.model
Class Annotation
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.Annotation
- All Implemented Interfaces:
OMEModelObject
- Direct Known Subclasses:
BasicAnnotation
,ListAnnotation
,MapAnnotation
,TextAnnotation
,TypeAnnotation
public abstract class Annotation extends AbstractOMEModelObject
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAMESPACE
-
Constructor Summary
Constructors Constructor Description Annotation()
Default constructor.Annotation(Annotation orig)
Copy constructor.Annotation(org.w3c.dom.Element element, OMEModel model)
Constructs Annotation recursively from an XML DOM tree. -
Method Summary
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
-
Annotation
public Annotation()Default constructor. -
Annotation
Constructs Annotation 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.
-
Annotation
Copy constructor.
-
-
Method Details
-
update
Updates Annotation 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.
-
getID
public java.lang.String getID() -
setID
public void setID(java.lang.String id) -
getNamespace
public java.lang.String getNamespace() -
setNamespace
public void setNamespace(java.lang.String namespace) -
getAnnotator
public java.lang.String getAnnotator() -
setAnnotator
public void setAnnotator(java.lang.String annotator) -
getDescription
public java.lang.String getDescription() -
setDescription
public void setDescription(java.lang.String description) -
sizeOfLinkedAnnotationList
public int sizeOfLinkedAnnotationList() -
copyLinkedAnnotationList
-
getLinkedAnnotation
-
setLinkedAnnotation
-
linkAnnotation
-
unlinkAnnotation
-
sizeOfLinkedImageList
public int sizeOfLinkedImageList() -
copyLinkedImageList
-
getLinkedImage
-
setLinkedImage
-
linkImage
-
unlinkImage
-
sizeOfLinkedPlaneList
public int sizeOfLinkedPlaneList() -
copyLinkedPlaneList
-
getLinkedPlane
-
setLinkedPlane
-
linkPlane
-
unlinkPlane
-
sizeOfLinkedChannelList
public int sizeOfLinkedChannelList() -
copyLinkedChannelList
-
getLinkedChannel
-
setLinkedChannel
-
linkChannel
-
unlinkChannel
-
sizeOfLinkedInstrumentList
public int sizeOfLinkedInstrumentList() -
copyLinkedInstrumentList
-
getLinkedInstrument
-
setLinkedInstrument
-
linkInstrument
-
unlinkInstrument
-
sizeOfLinkedLightSourceList
public int sizeOfLinkedLightSourceList() -
copyLinkedLightSourceList
-
getLinkedLightSource
-
setLinkedLightSource
-
linkLightSource
-
unlinkLightSource
-
sizeOfLinkedProjectList
public int sizeOfLinkedProjectList() -
copyLinkedProjectList
-
getLinkedProject
-
setLinkedProject
-
linkProject
-
unlinkProject
-
sizeOfLinkedExperimenterGroupList
public int sizeOfLinkedExperimenterGroupList() -
copyLinkedExperimenterGroupList
-
getLinkedExperimenterGroup
-
setLinkedExperimenterGroup
-
linkExperimenterGroup
-
unlinkExperimenterGroup
-
sizeOfLinkedDatasetList
public int sizeOfLinkedDatasetList() -
copyLinkedDatasetList
-
getLinkedDataset
-
setLinkedDataset
-
linkDataset
-
unlinkDataset
-
sizeOfLinkedExperimenterList
public int sizeOfLinkedExperimenterList() -
copyLinkedExperimenterList
-
getLinkedExperimenter
-
setLinkedExperimenter
-
linkExperimenter
-
unlinkExperimenter
-
sizeOfLinkedFolderList
public int sizeOfLinkedFolderList() -
copyLinkedFolderList
-
getLinkedFolder
-
setLinkedFolder
-
linkFolder
-
unlinkFolder
-
sizeOfLinkedObjectiveList
public int sizeOfLinkedObjectiveList() -
copyLinkedObjectiveList
-
getLinkedObjective
-
setLinkedObjective
-
linkObjective
-
unlinkObjective
-
sizeOfLinkedDetectorList
public int sizeOfLinkedDetectorList() -
copyLinkedDetectorList
-
getLinkedDetector
-
setLinkedDetector
-
linkDetector
-
unlinkDetector
-
sizeOfLinkedFilterList
public int sizeOfLinkedFilterList() -
copyLinkedFilterList
-
getLinkedFilter
-
setLinkedFilter
-
linkFilter
-
unlinkFilter
-
sizeOfLinkedDichroicList
public int sizeOfLinkedDichroicList() -
copyLinkedDichroicList
-
getLinkedDichroic
-
setLinkedDichroic
-
linkDichroic
-
unlinkDichroic
-
sizeOfLinkedLightPathList
public int sizeOfLinkedLightPathList() -
copyLinkedLightPathList
-
getLinkedLightPath
-
setLinkedLightPath
-
linkLightPath
-
unlinkLightPath
-
sizeOfLinkedROIList
public int sizeOfLinkedROIList() -
copyLinkedROIList
-
getLinkedROI
-
setLinkedROI
-
linkROI
-
unlinkROI
-
sizeOfLinkedShapeList
public int sizeOfLinkedShapeList() -
copyLinkedShapeList
-
getLinkedShape
-
setLinkedShape
-
linkShape
-
unlinkShape
-
sizeOfLinkedPlateList
public int sizeOfLinkedPlateList() -
copyLinkedPlateList
-
getLinkedPlate
-
setLinkedPlate
-
linkPlate
-
unlinkPlate
-
sizeOfLinkedReagentList
public int sizeOfLinkedReagentList() -
copyLinkedReagentList
-
getLinkedReagent
-
setLinkedReagent
-
linkReagent
-
unlinkReagent
-
sizeOfLinkedScreenList
public int sizeOfLinkedScreenList() -
copyLinkedScreenList
-
getLinkedScreen
-
setLinkedScreen
-
linkScreen
-
unlinkScreen
-
sizeOfLinkedPlateAcquisitionList
public int sizeOfLinkedPlateAcquisitionList() -
copyLinkedPlateAcquisitionList
-
getLinkedPlateAcquisition
-
setLinkedPlateAcquisition
-
linkPlateAcquisition
-
unlinkPlateAcquisition
-
sizeOfLinkedWellList
public int sizeOfLinkedWellList() -
copyLinkedWellList
-
getLinkedWell
-
setLinkedWell
-
linkWell
-
unlinkWell
-
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 Annotation_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.Annotation_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-