Package ome.xml.model
Class StructuredAnnotations
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.StructuredAnnotations
- All Implemented Interfaces:
OMEModelObject
public class StructuredAnnotations extends AbstractOMEModelObject
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAMESPACE
-
Constructor Summary
Constructors Constructor Description StructuredAnnotations()
Default constructor.StructuredAnnotations(StructuredAnnotations orig)
Copy constructor.StructuredAnnotations(org.w3c.dom.Element element, OMEModel model)
Constructs StructuredAnnotations 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
-
StructuredAnnotations
public StructuredAnnotations()Default constructor. -
StructuredAnnotations
public StructuredAnnotations(org.w3c.dom.Element element, OMEModel model) throws EnumerationExceptionConstructs StructuredAnnotations 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.
-
StructuredAnnotations
Copy constructor.
-
-
Method Details
-
update
Updates StructuredAnnotations 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.
-
sizeOfXMLAnnotationList
public int sizeOfXMLAnnotationList() -
copyXMLAnnotationList
-
getXMLAnnotation
-
setXMLAnnotation
-
addXMLAnnotation
-
removeXMLAnnotation
-
sizeOfFileAnnotationList
public int sizeOfFileAnnotationList() -
copyFileAnnotationList
-
getFileAnnotation
-
setFileAnnotation
-
addFileAnnotation
-
removeFileAnnotation
-
sizeOfListAnnotationList
public int sizeOfListAnnotationList() -
copyListAnnotationList
-
getListAnnotation
-
setListAnnotation
-
addListAnnotation
-
removeListAnnotation
-
sizeOfLongAnnotationList
public int sizeOfLongAnnotationList() -
copyLongAnnotationList
-
getLongAnnotation
-
setLongAnnotation
-
addLongAnnotation
-
removeLongAnnotation
-
sizeOfDoubleAnnotationList
public int sizeOfDoubleAnnotationList() -
copyDoubleAnnotationList
-
getDoubleAnnotation
-
setDoubleAnnotation
-
addDoubleAnnotation
-
removeDoubleAnnotation
-
sizeOfCommentAnnotationList
public int sizeOfCommentAnnotationList() -
copyCommentAnnotationList
-
getCommentAnnotation
-
setCommentAnnotation
-
addCommentAnnotation
-
removeCommentAnnotation
-
sizeOfBooleanAnnotationList
public int sizeOfBooleanAnnotationList() -
copyBooleanAnnotationList
-
getBooleanAnnotation
-
setBooleanAnnotation
-
addBooleanAnnotation
-
removeBooleanAnnotation
-
sizeOfTimestampAnnotationList
public int sizeOfTimestampAnnotationList() -
copyTimestampAnnotationList
-
getTimestampAnnotation
-
setTimestampAnnotation
public TimestampAnnotation setTimestampAnnotation(int index, TimestampAnnotation timestampAnnotation) -
addTimestampAnnotation
-
removeTimestampAnnotation
-
sizeOfTagAnnotationList
public int sizeOfTagAnnotationList() -
copyTagAnnotationList
-
getTagAnnotation
-
setTagAnnotation
-
addTagAnnotation
-
removeTagAnnotation
-
sizeOfTermAnnotationList
public int sizeOfTermAnnotationList() -
copyTermAnnotationList
-
getTermAnnotation
-
setTermAnnotation
-
addTermAnnotation
-
removeTermAnnotation
-
sizeOfMapAnnotationList
public int sizeOfMapAnnotationList() -
copyMapAnnotationList
-
getMapAnnotation
-
setMapAnnotation
-
addMapAnnotation
-
removeMapAnnotation
-
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 StructuredAnnotations_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.StructuredAnnotations_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-