bioformats
5.1.2
|
#include <ome/xml/model/Dataset.h>
Public Member Functions | |
Dataset () | |
Default constructor. | |
Dataset (const Dataset ©) | |
Copy constructor. More... | |
virtual | ~Dataset () |
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... | |
ome::compat::shared_ptr< std::string > | getName () |
Get the Name property. More... | |
const ome::compat::shared_ptr< std::string > | getName () const |
Get the Name property. More... | |
void | setName (ome::compat::shared_ptr< std::string > &name) |
Set the Name property. More... | |
const std::string & | getID () const |
Get the ID property. More... | |
void | setID (const std::string &id) |
Set the ID property. More... | |
ome::compat::shared_ptr< std::string > | getDescription () |
Get the Description property. More... | |
const ome::compat::shared_ptr< std::string > | getDescription () const |
Get the Description property. More... | |
void | setDescription (ome::compat::shared_ptr< std::string > &description) |
Set the Description property. More... | |
ome::compat::weak_ptr< ome::xml::model::Experimenter > | getLinkedExperimenter () |
Get linked Experimenter. More... | |
const ome::compat::weak_ptr< ome::xml::model::Experimenter > | getLinkedExperimenter () const |
Get linked Experimenter. More... | |
void | linkExperimenter (ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter) |
Link Experimenter. More... | |
void | unlinkExperimenter (ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter) |
Unlink Experimenter. More... | |
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > | getLinkedExperimenterGroup () |
Get linked ExperimenterGroup. More... | |
const ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > | getLinkedExperimenterGroup () const |
Get linked ExperimenterGroup. More... | |
void | linkExperimenterGroup (ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup) |
Link ExperimenterGroup. More... | |
void | unlinkExperimenterGroup (ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup) |
Unlink ExperimenterGroup. More... | |
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type | sizeOfLinkedImageList () const |
Get size of linked Image list. More... | |
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type | getLinkedImageList () const |
Get the linked Image list. More... | |
const ome::compat::weak_ptr< ome::xml::model::Image > & | getLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index) const |
Get linked Image. More... | |
const ome::compat::weak_ptr< ome::xml::model::Image > & | setLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Image > &image) |
Set linked Image. More... | |
bool | linkImage (const ome::compat::shared_ptr< ome::xml::model::Image > &image) |
Link Image. More... | |
bool | unlinkImage (const ome::compat::shared_ptr< ome::xml::model::Image > &image) |
Unlink Image. More... | |
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type | sizeOfLinkedAnnotationList () const |
Get size of linked Annotation list. More... | |
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type | getLinkedAnnotationList () const |
Get the linked Annotation list. More... | |
const ome::compat::weak_ptr< ome::xml::model::Annotation > & | getLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const |
Get linked Annotation. More... | |
const ome::compat::weak_ptr< ome::xml::model::Annotation > & | setLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation) |
Set linked Annotation. More... | |
bool | linkAnnotation (const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation) |
Link Annotation. More... | |
bool | unlinkAnnotation (const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation) |
Unlink Annotation. More... | |
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type | sizeOfLinkedProjectList () const |
Get size of linked Project list. More... | |
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type | getLinkedProjectList () const |
Get the linked Project list. More... | |
const ome::compat::weak_ptr< ome::xml::model::Project > & | getLinkedProject (OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type index) const |
Get linked Project. More... | |
const ome::compat::weak_ptr< ome::xml::model::Project > & | setLinkedProject (OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference) |
Set linked Project. More... | |
bool | linkProject (const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference) |
Link Project. More... | |
bool | unlinkProject (const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference) |
Unlink Project. 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< Dataset > | create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Create a Dataset 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< std::string > | name |
Name property. | |
std::string | id |
ID property. | |
ome::compat::shared_ptr< std::string > | description |
Description property. | |
ome::compat::weak_ptr< ome::xml::model::Experimenter > | experimenter |
ExperimenterRef reference. | |
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > | experimenterGroup |
ExperimenterGroupRef reference. | |
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type | imageLinks |
ImageRef reference (occurs more than once) | |
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type | annotationLinks |
AnnotationRef reference (occurs more than once) | |
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type | projectLinks |
Project_BackReference back reference (occurs more than once) | |
Additional Inherited Members | |
Protected Attributes inherited from ome::xml::model::detail::OMEModelObject | |
ome::common::Logger | logger |
Message logger. | |
Dataset model object.
ome::xml::model::Dataset::Dataset | ( | const Dataset & | copy | ) |
Copy constructor.
copy | the Dataset to copy. |
|
virtual |
Transform the object hierarchy rooted at this element to XML.
document | document for element creation |
Implements ome::xml::model::OMEModelObject.
References asXMLElementInternal(), and ome::common::xml::dom::Document::createElementNS().
|
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 annotationLinks, ome::common::xml::dom::Node::appendChild(), ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), description, experimenter, experimenterGroup, id, imageLinks, name, and ome::common::xml::dom::Element::setAttribute().
Referenced by asXMLElement().
|
static |
Create a Dataset 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< std::string > ome::xml::model::Dataset::getDescription | ( | ) |
const ome::compat::shared_ptr< std::string > ome::xml::model::Dataset::getDescription | ( | ) | const |
const std::string & ome::xml::model::Dataset::getID | ( | ) | const |
const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Dataset::getLinkedAnnotation | ( | OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type | index | ) | const |
Get linked Annotation.
index | the index number of the Annotation. |
std::out_of_range | if the index is invalid. |
References annotationLinks.
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type ome::xml::model::Dataset::getLinkedAnnotationList | ( | ) | const |
ome::compat::weak_ptr< ome::xml::model::Experimenter > ome::xml::model::Dataset::getLinkedExperimenter | ( | ) |
Get linked Experimenter.
References experimenter.
const ome::compat::weak_ptr< ome::xml::model::Experimenter > ome::xml::model::Dataset::getLinkedExperimenter | ( | ) | const |
Get linked Experimenter.
References experimenter.
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > ome::xml::model::Dataset::getLinkedExperimenterGroup | ( | ) |
Get linked ExperimenterGroup.
References experimenterGroup.
const ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > ome::xml::model::Dataset::getLinkedExperimenterGroup | ( | ) | const |
Get linked ExperimenterGroup.
References experimenterGroup.
const ome::compat::weak_ptr< ome::xml::model::Image > & ome::xml::model::Dataset::getLinkedImage | ( | OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type | index | ) | const |
Get linked Image.
index | the index number of the Image. |
std::out_of_range | if the index is invalid. |
References imageLinks.
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type ome::xml::model::Dataset::getLinkedImageList | ( | ) | const |
const ome::compat::weak_ptr< ome::xml::model::Project > & ome::xml::model::Dataset::getLinkedProject | ( | OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type | index | ) | const |
Get linked Project.
index | the index number of the Project. |
std::out_of_range | if the index is invalid. |
References projectLinks.
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type ome::xml::model::Dataset::getLinkedProjectList | ( | ) | const |
ome::compat::shared_ptr< std::string > ome::xml::model::Dataset::getName | ( | ) |
const ome::compat::shared_ptr< std::string > ome::xml::model::Dataset::getName | ( | ) | const |
|
virtual |
Get the XML namespace for this model object.
Implements ome::xml::model::OMEModelObject.
bool ome::xml::model::Dataset::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 annotationLinks, experimenter, experimenterGroup, imageLinks, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::ExperimenterGroup::linkDataset(), ome::xml::model::Experimenter::linkDataset(), ome::xml::model::Image::linkDataset(), ome::xml::model::Annotation::linkDataset(), ome::xml::model::detail::OMEModelObject::logger, and name.
bool ome::xml::model::Dataset::linkAnnotation | ( | const ome::compat::shared_ptr< ome::xml::model::Annotation > & | annotation | ) |
Link Annotation.
annotation | the Annotation to link. |
true
if the object was added to the internal annotationLinks list, otherwise false
.References annotationLinks.
void ome::xml::model::Dataset::linkExperimenter | ( | ome::compat::shared_ptr< ome::xml::model::Experimenter > & | experimenter | ) |
void ome::xml::model::Dataset::linkExperimenterGroup | ( | ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > & | experimenterGroup | ) |
Link ExperimenterGroup.
experimenterGroup | the ExperimenterGroup to link. |
References experimenterGroup.
bool ome::xml::model::Dataset::linkImage | ( | const ome::compat::shared_ptr< ome::xml::model::Image > & | image | ) |
Link Image.
image | the Image to link. |
true
if the object was added to the internal imageLinks list, otherwise false
.References imageLinks.
bool ome::xml::model::Dataset::linkProject | ( | const ome::compat::shared_ptr< ome::xml::model::Project > & | project_BackReference | ) |
Link Project.
project_BackReference | the Project to link. |
true
if the object was added to the internal projectLinks list, otherwise false
.References projectLinks.
Referenced by ome::xml::model::Project::link().
void ome::xml::model::Dataset::setDescription | ( | ome::compat::shared_ptr< std::string > & | description | ) |
Set the Description property.
description | the value to set. |
References description.
Referenced by update().
void ome::xml::model::Dataset::setID | ( | const std::string & | id | ) |
const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Dataset::setLinkedAnnotation | ( | OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type | index, |
const ome::compat::shared_ptr< ome::xml::model::Annotation > & | annotation | ||
) |
Set linked Annotation.
index | the index number of the Annotation. |
annotation | the Annotation to set. |
std::out_of_range | if the index is invalid. |
References annotationLinks.
const ome::compat::weak_ptr< ome::xml::model::Image > & ome::xml::model::Dataset::setLinkedImage | ( | OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type | index, |
const ome::compat::shared_ptr< ome::xml::model::Image > & | image | ||
) |
Set linked Image.
std::out_of_range | if the index is invalid. |
References imageLinks.
const ome::compat::weak_ptr< ome::xml::model::Project > & ome::xml::model::Dataset::setLinkedProject | ( | OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type | index, |
const ome::compat::shared_ptr< ome::xml::model::Project > & | project_BackReference | ||
) |
Set linked Project.
std::out_of_range | if the index is invalid. |
References projectLinks.
void ome::xml::model::Dataset::setName | ( | ome::compat::shared_ptr< std::string > & | name | ) |
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type ome::xml::model::Dataset::sizeOfLinkedAnnotationList | ( | ) | const |
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type ome::xml::model::Dataset::sizeOfLinkedImageList | ( | ) | const |
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type ome::xml::model::Dataset::sizeOfLinkedProjectList | ( | ) | const |
bool ome::xml::model::Dataset::unlinkAnnotation | ( | const ome::compat::shared_ptr< ome::xml::model::Annotation > & | annotation | ) |
Unlink Annotation.
annotation | the Annotation to unlink. |
true
if the Annotation was unlinked, otherwise false
if the Annotation was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References annotationLinks.
void ome::xml::model::Dataset::unlinkExperimenter | ( | ome::compat::shared_ptr< ome::xml::model::Experimenter > & | experimenter | ) |
Unlink Experimenter.
experimenter | the Experimenter to unlink. |
link(0)
internally. void ome::xml::model::Dataset::unlinkExperimenterGroup | ( | ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > & | experimenterGroup | ) |
Unlink ExperimenterGroup.
experimenterGroup | the ExperimenterGroup to unlink. |
link(0)
internally. bool ome::xml::model::Dataset::unlinkImage | ( | const ome::compat::shared_ptr< ome::xml::model::Image > & | image | ) |
Unlink Image.
image | the Image to unlink. |
true
if the Image was unlinked, otherwise false
if the Image was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References imageLinks.
bool ome::xml::model::Dataset::unlinkProject | ( | const ome::compat::shared_ptr< ome::xml::model::Project > & | project_BackReference | ) |
Unlink Project.
project_BackReference | the Project to unlink. |
true
if the Project was unlinked, otherwise false
if the Project was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References projectLinks.
|
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 ome::xml::model::OMEModel::addModelObject(), ome::xml::model::OMEModel::addReference(), ome::common::xml::dom::Element::getAttribute(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), getID(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setDescription(), setID(), setName(), 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().