bioformats
5.1.8
|
#include <ome/xml/model/Project.h>
Classes | |
class | Impl |
Private implementation details of Project model object. More... | |
Public Member Functions | |
Project () | |
Default constructor. | |
Project (const Project ©) | |
Copy constructor. More... | |
virtual | ~Project () |
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::Dataset, ome::compat::weak_ptr >::type::size_type | sizeOfLinkedDatasetList () const |
Get size of linked Dataset list. More... | |
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type | getLinkedDatasetList () const |
Get the linked Dataset list. More... | |
const ome::compat::weak_ptr< ome::xml::model::Dataset > & | getLinkedDataset (OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type index) const |
Get linked Dataset. More... | |
const ome::compat::weak_ptr< ome::xml::model::Dataset > & | setLinkedDataset (OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset) |
Set linked Dataset. More... | |
bool | linkDataset (const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset) |
Link Dataset. More... | |
bool | unlinkDataset (const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset) |
Unlink Dataset. 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... | |
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< Project > | create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Create a Project 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. | |
Project model object.
ome::xml::model::Project::Project | ( | const Project & | copy | ) |
Copy constructor.
copy | the Project 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(), 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(), impl, and ome::common::xml::dom::Element::setAttribute().
Referenced by asXMLElement().
|
static |
Create a Project 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::Project::getDescription | ( | ) |
const ome::compat::shared_ptr< std::string > ome::xml::model::Project::getDescription | ( | ) | const |
const std::string & ome::xml::model::Project::getID | ( | ) | const |
const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Project::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 impl.
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type ome::xml::model::Project::getLinkedAnnotationList | ( | ) | const |
const ome::compat::weak_ptr< ome::xml::model::Dataset > & ome::xml::model::Project::getLinkedDataset | ( | OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type | index | ) | const |
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type ome::xml::model::Project::getLinkedDatasetList | ( | ) | const |
ome::compat::weak_ptr< ome::xml::model::Experimenter > ome::xml::model::Project::getLinkedExperimenter | ( | ) |
const ome::compat::weak_ptr< ome::xml::model::Experimenter > ome::xml::model::Project::getLinkedExperimenter | ( | ) | const |
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > ome::xml::model::Project::getLinkedExperimenterGroup | ( | ) |
Get linked ExperimenterGroup.
References impl.
const ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > ome::xml::model::Project::getLinkedExperimenterGroup | ( | ) | const |
Get linked ExperimenterGroup.
References impl.
ome::compat::shared_ptr< std::string > ome::xml::model::Project::getName | ( | ) |
const ome::compat::shared_ptr< std::string > ome::xml::model::Project::getName | ( | ) | const |
|
virtual |
Get the XML namespace for this model object.
Implements ome::xml::model::OMEModelObject.
Referenced by asXMLElement(), and asXMLElementInternal().
bool ome::xml::model::Project::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 impl, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::Dataset::linkProject(), ome::xml::model::ExperimenterGroup::linkProject(), ome::xml::model::Experimenter::linkProject(), ome::xml::model::Annotation::linkProject(), and ome::xml::model::detail::OMEModelObject::logger.
bool ome::xml::model::Project::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 impl.
bool ome::xml::model::Project::linkDataset | ( | const ome::compat::shared_ptr< ome::xml::model::Dataset > & | dataset | ) |
void ome::xml::model::Project::linkExperimenter | ( | ome::compat::shared_ptr< ome::xml::model::Experimenter > & | experimenter | ) |
void ome::xml::model::Project::linkExperimenterGroup | ( | ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > & | experimenterGroup | ) |
void ome::xml::model::Project::setDescription | ( | ome::compat::shared_ptr< std::string > & | description | ) |
void ome::xml::model::Project::setID | ( | const std::string & | id | ) |
const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Project::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 impl.
const ome::compat::weak_ptr< ome::xml::model::Dataset > & ome::xml::model::Project::setLinkedDataset | ( | OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type | index, |
const ome::compat::shared_ptr< ome::xml::model::Dataset > & | dataset | ||
) |
void ome::xml::model::Project::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::Project::sizeOfLinkedAnnotationList | ( | ) | const |
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type ome::xml::model::Project::sizeOfLinkedDatasetList | ( | ) | const |
bool ome::xml::model::Project::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 impl.
bool ome::xml::model::Project::unlinkDataset | ( | const ome::compat::shared_ptr< ome::xml::model::Dataset > & | dataset | ) |
Unlink Dataset.
dataset | the Dataset to unlink. |
true
if the Dataset was unlinked, otherwise false
if the Dataset 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 impl.
void ome::xml::model::Project::unlinkExperimenter | ( | ome::compat::shared_ptr< ome::xml::model::Experimenter > & | experimenter | ) |
Unlink Experimenter.
experimenter | the Experimenter to unlink. |
link(0)
internally. References impl.
void ome::xml::model::Project::unlinkExperimenterGroup | ( | ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > & | experimenterGroup | ) |
Unlink ExperimenterGroup.
experimenterGroup | the ExperimenterGroup to unlink. |
link(0)
internally. References impl.
|
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().