ome-xml
5.2.0
|
StructuredAnnotations model object. More...
#include <ome/xml/model/StructuredAnnotations.h>
Classes | |
class | Impl |
Private implementation details of StructuredAnnotations model object. More... | |
Public Member Functions | |
StructuredAnnotations () | |
Default constructor. | |
StructuredAnnotations (const StructuredAnnotations ©) | |
Copy constructor. More... | |
virtual | ~StructuredAnnotations () |
Destructor. | |
const std::string & | elementName () const |
Get the element name of this model object. More... | |
bool | validElementName (const std::string &name) const |
Check if a given element name is valid for processing by this model object. More... | |
virtual void | update (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Update the object hierarchy recursively from an XML DOM tree. More... | |
bool | link (ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ome::xml::model::OMEModelObject > &object) |
Link a given OME model object to this model object. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > >::size_type | sizeOfXMLAnnotationList () const |
Get size of linked XMLAnnotation list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > > & | getXMLAnnotationList () |
Get the XMLAnnotation list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > > & | getXMLAnnotationList () const |
Get the XMLAnnotation list. More... | |
ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > & | getXMLAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > >::size_type index) |
Get XMLAnnotation. More... | |
const ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > & | getXMLAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > >::size_type index) const |
Get XMLAnnotation. More... | |
void | setXMLAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > &xmlAnnotation) |
Set XMLAnnotation. More... | |
void | addXMLAnnotation (ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > &xmlAnnotation) |
Add XMLAnnotation. More... | |
void | removeXMLAnnotation (ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > &xmlAnnotation) |
Remove XMLAnnotation. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > >::size_type | sizeOfFileAnnotationList () const |
Get size of linked FileAnnotation list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > > & | getFileAnnotationList () |
Get the FileAnnotation list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > > & | getFileAnnotationList () const |
Get the FileAnnotation list. More... | |
ome::compat::shared_ptr< ome::xml::model::FileAnnotation > & | getFileAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > >::size_type index) |
Get FileAnnotation. More... | |
const ome::compat::shared_ptr< ome::xml::model::FileAnnotation > & | getFileAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > >::size_type index) const |
Get FileAnnotation. More... | |
void | setFileAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::FileAnnotation > &fileAnnotation) |
Set FileAnnotation. More... | |
void | addFileAnnotation (ome::compat::shared_ptr< ome::xml::model::FileAnnotation > &fileAnnotation) |
Add FileAnnotation. More... | |
void | removeFileAnnotation (ome::compat::shared_ptr< ome::xml::model::FileAnnotation > &fileAnnotation) |
Remove FileAnnotation. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > >::size_type | sizeOfListAnnotationList () const |
Get size of linked ListAnnotation list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > > & | getListAnnotationList () |
Get the ListAnnotation list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > > & | getListAnnotationList () const |
Get the ListAnnotation list. More... | |
ome::compat::shared_ptr< ome::xml::model::ListAnnotation > & | getListAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > >::size_type index) |
Get ListAnnotation. More... | |
const ome::compat::shared_ptr< ome::xml::model::ListAnnotation > & | getListAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > >::size_type index) const |
Get ListAnnotation. More... | |
void | setListAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::ListAnnotation > &listAnnotation) |
Set ListAnnotation. More... | |
void | addListAnnotation (ome::compat::shared_ptr< ome::xml::model::ListAnnotation > &listAnnotation) |
Add ListAnnotation. More... | |
void | removeListAnnotation (ome::compat::shared_ptr< ome::xml::model::ListAnnotation > &listAnnotation) |
Remove ListAnnotation. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > >::size_type | sizeOfLongAnnotationList () const |
Get size of linked LongAnnotation list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > > & | getLongAnnotationList () |
Get the LongAnnotation list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > > & | getLongAnnotationList () const |
Get the LongAnnotation list. More... | |
ome::compat::shared_ptr< ome::xml::model::LongAnnotation > & | getLongAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > >::size_type index) |
Get LongAnnotation. More... | |
const ome::compat::shared_ptr< ome::xml::model::LongAnnotation > & | getLongAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > >::size_type index) const |
Get LongAnnotation. More... | |
void | setLongAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::LongAnnotation > &longAnnotation) |
Set LongAnnotation. More... | |
void | addLongAnnotation (ome::compat::shared_ptr< ome::xml::model::LongAnnotation > &longAnnotation) |
Add LongAnnotation. More... | |
void | removeLongAnnotation (ome::compat::shared_ptr< ome::xml::model::LongAnnotation > &longAnnotation) |
Remove LongAnnotation. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > >::size_type | sizeOfDoubleAnnotationList () const |
Get size of linked DoubleAnnotation list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > > & | getDoubleAnnotationList () |
Get the DoubleAnnotation list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > > & | getDoubleAnnotationList () const |
Get the DoubleAnnotation list. More... | |
ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > & | getDoubleAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > >::size_type index) |
Get DoubleAnnotation. More... | |
const ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > & | getDoubleAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > >::size_type index) const |
Get DoubleAnnotation. More... | |
void | setDoubleAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > &doubleAnnotation) |
Set DoubleAnnotation. More... | |
void | addDoubleAnnotation (ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > &doubleAnnotation) |
Add DoubleAnnotation. More... | |
void | removeDoubleAnnotation (ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > &doubleAnnotation) |
Remove DoubleAnnotation. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > >::size_type | sizeOfCommentAnnotationList () const |
Get size of linked CommentAnnotation list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > > & | getCommentAnnotationList () |
Get the CommentAnnotation list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > > & | getCommentAnnotationList () const |
Get the CommentAnnotation list. More... | |
ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > & | getCommentAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > >::size_type index) |
Get CommentAnnotation. More... | |
const ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > & | getCommentAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > >::size_type index) const |
Get CommentAnnotation. More... | |
void | setCommentAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > &commentAnnotation) |
Set CommentAnnotation. More... | |
void | addCommentAnnotation (ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > &commentAnnotation) |
Add CommentAnnotation. More... | |
void | removeCommentAnnotation (ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > &commentAnnotation) |
Remove CommentAnnotation. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > >::size_type | sizeOfBooleanAnnotationList () const |
Get size of linked BooleanAnnotation list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > > & | getBooleanAnnotationList () |
Get the BooleanAnnotation list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > > & | getBooleanAnnotationList () const |
Get the BooleanAnnotation list. More... | |
ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > & | getBooleanAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > >::size_type index) |
Get BooleanAnnotation. More... | |
const ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > & | getBooleanAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > >::size_type index) const |
Get BooleanAnnotation. More... | |
void | setBooleanAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > &booleanAnnotation) |
Set BooleanAnnotation. More... | |
void | addBooleanAnnotation (ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > &booleanAnnotation) |
Add BooleanAnnotation. More... | |
void | removeBooleanAnnotation (ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > &booleanAnnotation) |
Remove BooleanAnnotation. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > >::size_type | sizeOfTimestampAnnotationList () const |
Get size of linked TimestampAnnotation list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > > & | getTimestampAnnotationList () |
Get the TimestampAnnotation list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > > & | getTimestampAnnotationList () const |
Get the TimestampAnnotation list. More... | |
ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > & | getTimestampAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > >::size_type index) |
Get TimestampAnnotation. More... | |
const ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > & | getTimestampAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > >::size_type index) const |
Get TimestampAnnotation. More... | |
void | setTimestampAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > ×tampAnnotation) |
Set TimestampAnnotation. More... | |
void | addTimestampAnnotation (ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > ×tampAnnotation) |
Add TimestampAnnotation. More... | |
void | removeTimestampAnnotation (ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > ×tampAnnotation) |
Remove TimestampAnnotation. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > >::size_type | sizeOfTagAnnotationList () const |
Get size of linked TagAnnotation list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > > & | getTagAnnotationList () |
Get the TagAnnotation list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > > & | getTagAnnotationList () const |
Get the TagAnnotation list. More... | |
ome::compat::shared_ptr< ome::xml::model::TagAnnotation > & | getTagAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > >::size_type index) |
Get TagAnnotation. More... | |
const ome::compat::shared_ptr< ome::xml::model::TagAnnotation > & | getTagAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > >::size_type index) const |
Get TagAnnotation. More... | |
void | setTagAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::TagAnnotation > &tagAnnotation) |
Set TagAnnotation. More... | |
void | addTagAnnotation (ome::compat::shared_ptr< ome::xml::model::TagAnnotation > &tagAnnotation) |
Add TagAnnotation. More... | |
void | removeTagAnnotation (ome::compat::shared_ptr< ome::xml::model::TagAnnotation > &tagAnnotation) |
Remove TagAnnotation. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > >::size_type | sizeOfTermAnnotationList () const |
Get size of linked TermAnnotation list. More... | |
std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > > & | getTermAnnotationList () |
Get the TermAnnotation list. More... | |
const std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > > & | getTermAnnotationList () const |
Get the TermAnnotation list. More... | |
ome::compat::shared_ptr< ome::xml::model::TermAnnotation > & | getTermAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > >::size_type index) |
Get TermAnnotation. More... | |
const ome::compat::shared_ptr< ome::xml::model::TermAnnotation > & | getTermAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > >::size_type index) const |
Get TermAnnotation. More... | |
void | setTermAnnotation (std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::TermAnnotation > &termAnnotation) |
Set TermAnnotation. More... | |
void | addTermAnnotation (ome::compat::shared_ptr< ome::xml::model::TermAnnotation > &termAnnotation) |
Add TermAnnotation. More... | |
void | removeTermAnnotation (ome::compat::shared_ptr< ome::xml::model::TermAnnotation > &termAnnotation) |
Remove TermAnnotation. More... | |
virtual common::xml::dom::Element | asXMLElement (common::xml::dom::Document &document) const |
Transform the object hierarchy rooted at this element to XML. More... | |
const std::string & | getXMLNamespace () const |
Get the XML namespace for this model object. More... | |
Public Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
virtual | ~OMEModelObject () |
Destructor. | |
virtual void | update (const common::xml::dom::Element &element,::ome::xml::model::OMEModel &model) |
Update the object hierarchy recursively from an XML DOM tree. More... | |
virtual bool | link (ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ::ome::xml::model::OMEModelObject > &object) |
Link a given OME model object to this model object. More... | |
Public Member Functions inherited from ome::xml::model::OMEModelObject | |
virtual bool | link (ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< OMEModelObject > &object)=0 |
Link a given OME model object to this model object. More... | |
Static Public Member Functions | |
static ome::compat::shared_ptr< StructuredAnnotations > | create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Create a StructuredAnnotations model object from DOM element. More... | |
Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
static std::vector< common::xml::dom::Element > | getChildrenByTagName (const common::xml::dom::Element &parent, const std::string &name) |
Retrieve all the children of an element that have a given tag name. More... | |
static std::string | stripNamespacePrefix (const std::string &value) |
Strip the namespace prefix from a tag name. More... | |
Protected Member Functions | |
virtual common::xml::dom::Element | asXMLElementInternal (common::xml::dom::Document &document, common::xml::dom::Element &element) const |
Transform the object hierarchy rooted at this element to XML. More... | |
Protected Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
OMEModelObject (const std::string &objectType="OMEModelObject") | |
Constructor. | |
OMEModelObject (const OMEModelObject ©) | |
Copy constructor. More... | |
template<class C , typename T > | |
bool | contains (const C &container, const ome::compat::shared_ptr< T > &element) |
Check if a container contains a particular element. More... | |
Protected Member Functions inherited from ome::xml::model::OMEModelObject | |
OMEModelObject () | |
Constructor. | |
Private Attributes | |
ome::compat::shared_ptr< Impl > | impl |
Private implementation details. | |
Additional Inherited Members | |
Protected Attributes inherited from ome::xml::model::detail::OMEModelObject | |
ome::common::Logger | logger |
Message logger. | |
StructuredAnnotations model object.
ome::xml::model::StructuredAnnotations::StructuredAnnotations | ( | const StructuredAnnotations & | copy | ) |
Copy constructor.
copy | the StructuredAnnotations to copy. |
void ome::xml::model::StructuredAnnotations::addBooleanAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > & | booleanAnnotation | ) |
Add BooleanAnnotation.
booleanAnnotation | the BooleanAnnotation to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
void ome::xml::model::StructuredAnnotations::addCommentAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > & | commentAnnotation | ) |
Add CommentAnnotation.
commentAnnotation | the CommentAnnotation to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
void ome::xml::model::StructuredAnnotations::addDoubleAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > & | doubleAnnotation | ) |
Add DoubleAnnotation.
doubleAnnotation | the DoubleAnnotation to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
void ome::xml::model::StructuredAnnotations::addFileAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::FileAnnotation > & | fileAnnotation | ) |
Add FileAnnotation.
fileAnnotation | the FileAnnotation to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
void ome::xml::model::StructuredAnnotations::addListAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::ListAnnotation > & | listAnnotation | ) |
Add ListAnnotation.
listAnnotation | the ListAnnotation to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
void ome::xml::model::StructuredAnnotations::addLongAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::LongAnnotation > & | longAnnotation | ) |
Add LongAnnotation.
longAnnotation | the LongAnnotation to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
void ome::xml::model::StructuredAnnotations::addTagAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::TagAnnotation > & | tagAnnotation | ) |
Add TagAnnotation.
tagAnnotation | the TagAnnotation to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
void ome::xml::model::StructuredAnnotations::addTermAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::TermAnnotation > & | termAnnotation | ) |
Add TermAnnotation.
termAnnotation | the TermAnnotation to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
void ome::xml::model::StructuredAnnotations::addTimestampAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > & | timestampAnnotation | ) |
Add TimestampAnnotation.
timestampAnnotation | the TimestampAnnotation to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
void ome::xml::model::StructuredAnnotations::addXMLAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > & | xmlAnnotation | ) |
Add XMLAnnotation.
xmlAnnotation | the XMLAnnotation to add. |
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
|
virtual |
Transform the object hierarchy rooted at this element to XML.
document | document for element creation |
Implements ome::xml::model::OMEModelObject.
References asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), and getXMLNamespace().
|
protectedvirtual |
Transform the object hierarchy rooted at this element to XML.
This internal implementation of asXMLelement also requires an XML element, which must not be null, or may be instantiated and passed from superclasses.
document | XML document for element creation. |
element | XML element for setting model data. |
Implements ome::xml::model::detail::OMEModelObject.
References ome::common::xml::dom::Node::appendChild(), ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), and impl.
Referenced by asXMLElement().
|
static |
Create a StructuredAnnotations model object from DOM element.
element | root of the XML DOM tree to from which to construct the model object graph. |
model | handler for the OME model used to track instances and references seen during the update. |
EnumerationException | if there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing. |
Referenced by ome::xml::model::OME::update().
|
virtual |
Get the element name of this model object.
This will be the most-derived class name.
Implements ome::xml::model::OMEModelObject.
ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > & ome::xml::model::StructuredAnnotations::getBooleanAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > >::size_type | index | ) |
Get BooleanAnnotation.
index | the index number of the BooleanAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > & ome::xml::model::StructuredAnnotations::getBooleanAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > >::size_type | index | ) | const |
Get BooleanAnnotation.
index | the index number of the BooleanAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > > & ome::xml::model::StructuredAnnotations::getBooleanAnnotationList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > > & ome::xml::model::StructuredAnnotations::getBooleanAnnotationList | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > & ome::xml::model::StructuredAnnotations::getCommentAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > >::size_type | index | ) |
Get CommentAnnotation.
index | the index number of the CommentAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > & ome::xml::model::StructuredAnnotations::getCommentAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > >::size_type | index | ) | const |
Get CommentAnnotation.
index | the index number of the CommentAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > > & ome::xml::model::StructuredAnnotations::getCommentAnnotationList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > > & ome::xml::model::StructuredAnnotations::getCommentAnnotationList | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > & ome::xml::model::StructuredAnnotations::getDoubleAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > >::size_type | index | ) |
Get DoubleAnnotation.
index | the index number of the DoubleAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > & ome::xml::model::StructuredAnnotations::getDoubleAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > >::size_type | index | ) | const |
Get DoubleAnnotation.
index | the index number of the DoubleAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > > & ome::xml::model::StructuredAnnotations::getDoubleAnnotationList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > > & ome::xml::model::StructuredAnnotations::getDoubleAnnotationList | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::FileAnnotation > & ome::xml::model::StructuredAnnotations::getFileAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > >::size_type | index | ) |
Get FileAnnotation.
index | the index number of the FileAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::FileAnnotation > & ome::xml::model::StructuredAnnotations::getFileAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > >::size_type | index | ) | const |
Get FileAnnotation.
index | the index number of the FileAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > > & ome::xml::model::StructuredAnnotations::getFileAnnotationList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > > & ome::xml::model::StructuredAnnotations::getFileAnnotationList | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::ListAnnotation > & ome::xml::model::StructuredAnnotations::getListAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > >::size_type | index | ) |
Get ListAnnotation.
index | the index number of the ListAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::ListAnnotation > & ome::xml::model::StructuredAnnotations::getListAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > >::size_type | index | ) | const |
Get ListAnnotation.
index | the index number of the ListAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > > & ome::xml::model::StructuredAnnotations::getListAnnotationList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > > & ome::xml::model::StructuredAnnotations::getListAnnotationList | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::LongAnnotation > & ome::xml::model::StructuredAnnotations::getLongAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > >::size_type | index | ) |
Get LongAnnotation.
index | the index number of the LongAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::LongAnnotation > & ome::xml::model::StructuredAnnotations::getLongAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > >::size_type | index | ) | const |
Get LongAnnotation.
index | the index number of the LongAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > > & ome::xml::model::StructuredAnnotations::getLongAnnotationList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > > & ome::xml::model::StructuredAnnotations::getLongAnnotationList | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::TagAnnotation > & ome::xml::model::StructuredAnnotations::getTagAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > >::size_type | index | ) |
Get TagAnnotation.
index | the index number of the TagAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::TagAnnotation > & ome::xml::model::StructuredAnnotations::getTagAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > >::size_type | index | ) | const |
Get TagAnnotation.
index | the index number of the TagAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > > & ome::xml::model::StructuredAnnotations::getTagAnnotationList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > > & ome::xml::model::StructuredAnnotations::getTagAnnotationList | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::TermAnnotation > & ome::xml::model::StructuredAnnotations::getTermAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > >::size_type | index | ) |
Get TermAnnotation.
index | the index number of the TermAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::TermAnnotation > & ome::xml::model::StructuredAnnotations::getTermAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > >::size_type | index | ) | const |
Get TermAnnotation.
index | the index number of the TermAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > > & ome::xml::model::StructuredAnnotations::getTermAnnotationList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > > & ome::xml::model::StructuredAnnotations::getTermAnnotationList | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > & ome::xml::model::StructuredAnnotations::getTimestampAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > >::size_type | index | ) |
Get TimestampAnnotation.
index | the index number of the TimestampAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > & ome::xml::model::StructuredAnnotations::getTimestampAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > >::size_type | index | ) | const |
Get TimestampAnnotation.
index | the index number of the TimestampAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > > & ome::xml::model::StructuredAnnotations::getTimestampAnnotationList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > > & ome::xml::model::StructuredAnnotations::getTimestampAnnotationList | ( | ) | const |
ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > & ome::xml::model::StructuredAnnotations::getXMLAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > >::size_type | index | ) |
Get XMLAnnotation.
index | the index number of the XMLAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
const ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > & ome::xml::model::StructuredAnnotations::getXMLAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > >::size_type | index | ) | const |
Get XMLAnnotation.
index | the index number of the XMLAnnotation. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > > & ome::xml::model::StructuredAnnotations::getXMLAnnotationList | ( | ) |
const std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > > & ome::xml::model::StructuredAnnotations::getXMLAnnotationList | ( | ) | const |
|
virtual |
Get the XML namespace for this model object.
Implements ome::xml::model::OMEModelObject.
Referenced by asXMLElement(), and asXMLElementInternal().
bool ome::xml::model::StructuredAnnotations::link | ( | ome::compat::shared_ptr< Reference > & | reference, |
ome::compat::shared_ptr< ome::xml::model::OMEModelObject > & | object | ||
) |
Link a given OME model object to this model object.
reference | type qualifier for the reference. This should be the corresponding reference type for object. If, for example, object is of type Image, reference must be of type ImageRef. |
object | Model object to link to. |
true
if this model object was able to handle the reference, otherwise false
.References ome::xml::model::detail::OMEModelObject::link(), and ome::xml::model::detail::OMEModelObject::logger.
void ome::xml::model::StructuredAnnotations::removeBooleanAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > & | booleanAnnotation | ) |
Remove BooleanAnnotation.
booleanAnnotation | the BooleanAnnotation to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::StructuredAnnotations::removeCommentAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > & | commentAnnotation | ) |
Remove CommentAnnotation.
commentAnnotation | the CommentAnnotation to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::StructuredAnnotations::removeDoubleAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > & | doubleAnnotation | ) |
Remove DoubleAnnotation.
doubleAnnotation | the DoubleAnnotation to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::StructuredAnnotations::removeFileAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::FileAnnotation > & | fileAnnotation | ) |
Remove FileAnnotation.
fileAnnotation | the FileAnnotation to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::StructuredAnnotations::removeListAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::ListAnnotation > & | listAnnotation | ) |
Remove ListAnnotation.
listAnnotation | the ListAnnotation to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::StructuredAnnotations::removeLongAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::LongAnnotation > & | longAnnotation | ) |
Remove LongAnnotation.
longAnnotation | the LongAnnotation to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::StructuredAnnotations::removeTagAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::TagAnnotation > & | tagAnnotation | ) |
Remove TagAnnotation.
tagAnnotation | the TagAnnotation to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::StructuredAnnotations::removeTermAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::TermAnnotation > & | termAnnotation | ) |
Remove TermAnnotation.
termAnnotation | the TermAnnotation to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::StructuredAnnotations::removeTimestampAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > & | timestampAnnotation | ) |
Remove TimestampAnnotation.
timestampAnnotation | the TimestampAnnotation to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::StructuredAnnotations::removeXMLAnnotation | ( | ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > & | xmlAnnotation | ) |
Remove XMLAnnotation.
xmlAnnotation | the XMLAnnotation to remove. |
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
void ome::xml::model::StructuredAnnotations::setBooleanAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > & | booleanAnnotation | ||
) |
Set BooleanAnnotation.
index | the index number of the BooleanAnnotation. |
booleanAnnotation | the BooleanAnnotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::StructuredAnnotations::setCommentAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > & | commentAnnotation | ||
) |
Set CommentAnnotation.
index | the index number of the CommentAnnotation. |
commentAnnotation | the CommentAnnotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::StructuredAnnotations::setDoubleAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > & | doubleAnnotation | ||
) |
Set DoubleAnnotation.
index | the index number of the DoubleAnnotation. |
doubleAnnotation | the DoubleAnnotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::StructuredAnnotations::setFileAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::FileAnnotation > & | fileAnnotation | ||
) |
Set FileAnnotation.
index | the index number of the FileAnnotation. |
fileAnnotation | the FileAnnotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::StructuredAnnotations::setListAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::ListAnnotation > & | listAnnotation | ||
) |
Set ListAnnotation.
index | the index number of the ListAnnotation. |
listAnnotation | the ListAnnotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::StructuredAnnotations::setLongAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::LongAnnotation > & | longAnnotation | ||
) |
Set LongAnnotation.
index | the index number of the LongAnnotation. |
longAnnotation | the LongAnnotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::StructuredAnnotations::setTagAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::TagAnnotation > & | tagAnnotation | ||
) |
Set TagAnnotation.
index | the index number of the TagAnnotation. |
tagAnnotation | the TagAnnotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::StructuredAnnotations::setTermAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::TermAnnotation > & | termAnnotation | ||
) |
Set TermAnnotation.
index | the index number of the TermAnnotation. |
termAnnotation | the TermAnnotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::StructuredAnnotations::setTimestampAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > & | timestampAnnotation | ||
) |
Set TimestampAnnotation.
index | the index number of the TimestampAnnotation. |
timestampAnnotation | the TimestampAnnotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::StructuredAnnotations::setXMLAnnotation | ( | std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > >::size_type | index, |
ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > & | xmlAnnotation | ||
) |
Set XMLAnnotation.
index | the index number of the XMLAnnotation. |
xmlAnnotation | the XMLAnnotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
std::vector< ome::compat::shared_ptr< ome::xml::model::BooleanAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfBooleanAnnotationList | ( | ) | const |
std::vector< ome::compat::shared_ptr< ome::xml::model::CommentAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfCommentAnnotationList | ( | ) | const |
std::vector< ome::compat::shared_ptr< ome::xml::model::DoubleAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfDoubleAnnotationList | ( | ) | const |
std::vector< ome::compat::shared_ptr< ome::xml::model::FileAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfFileAnnotationList | ( | ) | const |
std::vector< ome::compat::shared_ptr< ome::xml::model::ListAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfListAnnotationList | ( | ) | const |
std::vector< ome::compat::shared_ptr< ome::xml::model::LongAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfLongAnnotationList | ( | ) | const |
std::vector< ome::compat::shared_ptr< ome::xml::model::TagAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfTagAnnotationList | ( | ) | const |
std::vector< ome::compat::shared_ptr< ome::xml::model::TermAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfTermAnnotationList | ( | ) | const |
std::vector< ome::compat::shared_ptr< ome::xml::model::TimestampAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfTimestampAnnotationList | ( | ) | const |
std::vector< ome::compat::shared_ptr< ome::xml::model::XMLAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfXMLAnnotationList | ( | ) | const |
|
virtual |
Update the object hierarchy recursively from an XML DOM tree.
element | root of the XML DOM tree to from which to construct the model object graph. |
model | handler for the OME model used to track instances and references seen during the update. |
EnumerationException | if there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing. |
Implements ome::xml::model::OMEModelObject.
References addBooleanAnnotation(), addCommentAnnotation(), addDoubleAnnotation(), addFileAnnotation(), addListAnnotation(), addLongAnnotation(), addTagAnnotation(), addTermAnnotation(), addTimestampAnnotation(), addXMLAnnotation(), ome::xml::model::BooleanAnnotation::create(), ome::xml::model::CommentAnnotation::create(), ome::xml::model::DoubleAnnotation::create(), ome::xml::model::TermAnnotation::create(), ome::xml::model::XMLAnnotation::create(), ome::xml::model::ListAnnotation::create(), ome::xml::model::LongAnnotation::create(), ome::xml::model::TagAnnotation::create(), ome::xml::model::FileAnnotation::create(), ome::xml::model::TimestampAnnotation::create(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), ome::common::xml::dom::Element::getTagName(), ome::xml::model::detail::OMEModelObject::logger, ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().
|
virtual |
Check if a given element name is valid for processing by this model object.
Used for processing nodes when interitance is involved.
name | the element name to check. |
true
if valid, false
if invalid. Implements ome::xml::model::detail::OMEModelObject.
References ome::xml::model::detail::OMEModelObject::validElementName().
Referenced by update().