Package ome.xml.model
Class StructuredAnnotations
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.StructuredAnnotations
- All Implemented Interfaces:
OMEModelObject
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Copy constructor.StructuredAnnotations(Element element, OMEModel model) Constructs StructuredAnnotations recursively from an XML DOM tree. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddBooleanAnnotation(BooleanAnnotation booleanAnnotation) voidaddCommentAnnotation(CommentAnnotation commentAnnotation) voidaddDoubleAnnotation(DoubleAnnotation doubleAnnotation) voidaddFileAnnotation(FileAnnotation fileAnnotation) voidaddListAnnotation(ListAnnotation listAnnotation) voidaddLongAnnotation(LongAnnotation longAnnotation) voidaddMapAnnotation(MapAnnotation mapAnnotation) voidaddTagAnnotation(TagAnnotation tagAnnotation) voidaddTermAnnotation(TermAnnotation termAnnotation) voidaddTimestampAnnotation(TimestampAnnotation timestampAnnotation) voidaddXMLAnnotation(XMLAnnotation xmlAnnotation) asXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.asXMLElement(Document document, Element StructuredAnnotations_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.voidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidgetBooleanAnnotation(int index) getCommentAnnotation(int index) getDoubleAnnotation(int index) getFileAnnotation(int index) getListAnnotation(int index) getLongAnnotation(int index) getMapAnnotation(int index) getTagAnnotation(int index) getTermAnnotation(int index) getTimestampAnnotation(int index) getXMLAnnotation(int index) booleanlink(Reference reference, OMEModelObject o) Link a given OME model object to this model object.voidremoveBooleanAnnotation(BooleanAnnotation booleanAnnotation) voidremoveCommentAnnotation(CommentAnnotation commentAnnotation) voidremoveDoubleAnnotation(DoubleAnnotation doubleAnnotation) voidremoveFileAnnotation(FileAnnotation fileAnnotation) voidremoveListAnnotation(ListAnnotation listAnnotation) voidremoveLongAnnotation(LongAnnotation longAnnotation) voidremoveMapAnnotation(MapAnnotation mapAnnotation) voidremoveTagAnnotation(TagAnnotation tagAnnotation) voidremoveTermAnnotation(TermAnnotation termAnnotation) voidremoveTimestampAnnotation(TimestampAnnotation timestampAnnotation) voidremoveXMLAnnotation(XMLAnnotation xmlAnnotation) setBooleanAnnotation(int index, BooleanAnnotation booleanAnnotation) setCommentAnnotation(int index, CommentAnnotation commentAnnotation) setDoubleAnnotation(int index, DoubleAnnotation doubleAnnotation) setFileAnnotation(int index, FileAnnotation fileAnnotation) setListAnnotation(int index, ListAnnotation listAnnotation) setLongAnnotation(int index, LongAnnotation longAnnotation) setMapAnnotation(int index, MapAnnotation mapAnnotation) setTagAnnotation(int index, TagAnnotation tagAnnotation) setTermAnnotation(int index, TermAnnotation termAnnotation) setTimestampAnnotation(int index, TimestampAnnotation timestampAnnotation) setXMLAnnotation(int index, XMLAnnotation xmlAnnotation) intintintintintintintintintintintvoidUpdates StructuredAnnotations recursively from an XML DOM tree.Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
- See Also:
-
-
Constructor Details
-
StructuredAnnotations
public StructuredAnnotations()Default constructor. -
StructuredAnnotations
Constructs 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:
updatein interfaceOMEModelObject- Overrides:
updatein 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:OMEModelObjectLink a given OME model object to this model object.- Specified by:
linkin interfaceOMEModelObject- Overrides:
linkin classAbstractOMEModelObject- Parameters:
reference- The type qualifier for the reference. This should be the corresponding reference type foro. If, for example,ois of typeImage,referenceMUST be of typeImageRef.o- Model object to link to.- Returns:
trueif this model object was able to handle the reference,falseotherwise.
-
sizeOfXMLAnnotationList
public int sizeOfXMLAnnotationList() -
copyXMLAnnotationList
-
clearXMLAnnotationList
public void clearXMLAnnotationList() -
getXMLAnnotation
-
setXMLAnnotation
-
addXMLAnnotation
-
removeXMLAnnotation
-
sizeOfFileAnnotationList
public int sizeOfFileAnnotationList() -
copyFileAnnotationList
-
clearFileAnnotationList
public void clearFileAnnotationList() -
getFileAnnotation
-
setFileAnnotation
-
addFileAnnotation
-
removeFileAnnotation
-
sizeOfListAnnotationList
public int sizeOfListAnnotationList() -
copyListAnnotationList
-
clearListAnnotationList
public void clearListAnnotationList() -
getListAnnotation
-
setListAnnotation
-
addListAnnotation
-
removeListAnnotation
-
sizeOfLongAnnotationList
public int sizeOfLongAnnotationList() -
copyLongAnnotationList
-
clearLongAnnotationList
public void clearLongAnnotationList() -
getLongAnnotation
-
setLongAnnotation
-
addLongAnnotation
-
removeLongAnnotation
-
sizeOfDoubleAnnotationList
public int sizeOfDoubleAnnotationList() -
copyDoubleAnnotationList
-
clearDoubleAnnotationList
public void clearDoubleAnnotationList() -
getDoubleAnnotation
-
setDoubleAnnotation
-
addDoubleAnnotation
-
removeDoubleAnnotation
-
sizeOfCommentAnnotationList
public int sizeOfCommentAnnotationList() -
copyCommentAnnotationList
-
clearCommentAnnotationList
public void clearCommentAnnotationList() -
getCommentAnnotation
-
setCommentAnnotation
-
addCommentAnnotation
-
removeCommentAnnotation
-
sizeOfBooleanAnnotationList
public int sizeOfBooleanAnnotationList() -
copyBooleanAnnotationList
-
clearBooleanAnnotationList
public void clearBooleanAnnotationList() -
getBooleanAnnotation
-
setBooleanAnnotation
-
addBooleanAnnotation
-
removeBooleanAnnotation
-
sizeOfTimestampAnnotationList
public int sizeOfTimestampAnnotationList() -
copyTimestampAnnotationList
-
clearTimestampAnnotationList
public void clearTimestampAnnotationList() -
getTimestampAnnotation
-
setTimestampAnnotation
public TimestampAnnotation setTimestampAnnotation(int index, TimestampAnnotation timestampAnnotation) -
addTimestampAnnotation
-
removeTimestampAnnotation
-
sizeOfTagAnnotationList
public int sizeOfTagAnnotationList() -
copyTagAnnotationList
-
clearTagAnnotationList
public void clearTagAnnotationList() -
getTagAnnotation
-
setTagAnnotation
-
addTagAnnotation
-
removeTagAnnotation
-
sizeOfTermAnnotationList
public int sizeOfTermAnnotationList() -
copyTermAnnotationList
-
clearTermAnnotationList
public void clearTermAnnotationList() -
getTermAnnotation
-
setTermAnnotation
-
addTermAnnotation
-
removeTermAnnotation
-
sizeOfMapAnnotationList
public int sizeOfMapAnnotationList() -
copyMapAnnotationList
-
clearMapAnnotationList
public void clearMapAnnotationList() -
getMapAnnotation
-
setMapAnnotation
-
addMapAnnotation
-
removeMapAnnotation
-
asXMLElement
Description copied from interface:OMEModelObjectTakes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElementin interfaceOMEModelObject- Specified by:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
Description copied from class:AbstractOMEModelObjectTakes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.- Overrides:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.StructuredAnnotations_element- Element from the subclass. Ifnulla new element will be created of this class.- Returns:
elementpopulated with properties from this class.
-