ome::xml::model::Reference Class Reference

Reference model object. More...

#include <ome/xml/model/Reference.h>

Inheritance diagram for ome::xml::model::Reference:

Collaboration diagram for ome::xml::model::Reference:

Classes
class	Impl
	Private implementation details of Reference model object. More...

Public Member Functions
	Reference ()
	Default constructor.
	Reference (const Reference &copy)
	Copy constructor. More...
virtual	~Reference ()
	Destructor.
bool	validElementName (const std::string &name) const
	Check if a given element name is valid for processing by this model object. More...
virtual const std::string &	getID () const =0
	Retrieves the reference's target object ID. More...
virtual void	setID (const std::string &id)=0
	Sets the reference's target object ID. 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...
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 const std::string &	elementName () const =0
	Get the element name of this model object. More...
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...

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)
	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 Member Functions
Reference &	operator= (const Reference &)
	Assignment operator (deleted).

Private Attributes
ome::compat::shared_ptr< Impl >	impl
	Private implementation details.

Additional Inherited Members
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 Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger	logger
	Message logger.

Detailed Description

Reference model object.

Constructor & Destructor Documentation

ome::xml::model::Reference::Reference

(

const Reference &

copy

)

Copy constructor.

Parameters

copy	the Reference to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::Reference::asXMLElement ( common::xml::dom::Document &  document ) const

virtual

Transform the object hierarchy rooted at this element to XML.

Parameters

document

document for element creation

Returns

an XML DOM tree root element for this model object.

Implements ome::xml::model::OMEModelObject.

Reimplemented in ome::xml::model::DetectorSettings, ome::xml::model::LightSourceSettings, ome::xml::model::ObjectiveSettings, ome::xml::model::Leader, ome::xml::model::Pump, ome::xml::model::AnnotationRef, ome::xml::model::ChannelRef, ome::xml::model::DatasetRef, ome::xml::model::DichroicRef, ome::xml::model::ExperimenterGroupRef, ome::xml::model::ExperimenterRef, ome::xml::model::ExperimentRef, ome::xml::model::FilterRef, ome::xml::model::FilterSetRef, ome::xml::model::ImageRef, ome::xml::model::InstrumentRef, ome::xml::model::MicrobeamManipulationRef, ome::xml::model::PlateRef, ome::xml::model::ProjectRef, ome::xml::model::ReagentRef, ome::xml::model::ROIRef, ome::xml::model::WellSampleRef, ome::xml::model::EmissionFilterRef, ome::xml::model::ExcitationFilterRef, and ome::xml::model::Settings.

References asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), and getXMLNamespace().

common::xml::dom::Element ome::xml::model::Reference::asXMLElementInternal ( common::xml::dom::Document &  document, common::xml::dom::Element &  element  ) const

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.

Parameters

document	XML document for element creation.
element	XML element for setting model data.

Returns

an XML DOM tree root element for this model object.

Implements ome::xml::model::detail::OMEModelObject.

Reimplemented in ome::xml::model::DetectorSettings, ome::xml::model::LightSourceSettings, ome::xml::model::ObjectiveSettings, ome::xml::model::Leader, ome::xml::model::Pump, ome::xml::model::AnnotationRef, ome::xml::model::ChannelRef, ome::xml::model::DatasetRef, ome::xml::model::DichroicRef, ome::xml::model::ExperimenterGroupRef, ome::xml::model::ExperimenterRef, ome::xml::model::ExperimentRef, ome::xml::model::FilterRef, ome::xml::model::FilterSetRef, ome::xml::model::ImageRef, ome::xml::model::InstrumentRef, ome::xml::model::MicrobeamManipulationRef, ome::xml::model::PlateRef, ome::xml::model::ProjectRef, ome::xml::model::ReagentRef, ome::xml::model::ROIRef, ome::xml::model::WellSampleRef, ome::xml::model::EmissionFilterRef, ome::xml::model::ExcitationFilterRef, and ome::xml::model::Settings.

References ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), and getXMLNamespace().

Referenced by asXMLElement(), ome::xml::model::Settings::asXMLElementInternal(), ome::xml::model::ImageRef::asXMLElementInternal(), ome::xml::model::ROIRef::asXMLElementInternal(), ome::xml::model::FilterSetRef::asXMLElementInternal(), ome::xml::model::ReagentRef::asXMLElementInternal(), ome::xml::model::WellSampleRef::asXMLElementInternal(), ome::xml::model::ProjectRef::asXMLElementInternal(), ome::xml::model::PlateRef::asXMLElementInternal(), ome::xml::model::MicrobeamManipulationRef::asXMLElementInternal(), ome::xml::model::ChannelRef::asXMLElementInternal(), ome::xml::model::InstrumentRef::asXMLElementInternal(), ome::xml::model::ExperimenterGroupRef::asXMLElementInternal(), ome::xml::model::FilterRef::asXMLElementInternal(), ome::xml::model::DichroicRef::asXMLElementInternal(), ome::xml::model::ExperimentRef::asXMLElementInternal(), ome::xml::model::ExperimenterRef::asXMLElementInternal(), ome::xml::model::AnnotationRef::asXMLElementInternal(), ome::xml::model::DatasetRef::asXMLElementInternal(), ome::xml::model::Leader::asXMLElementInternal(), and ome::xml::model::Pump::asXMLElementInternal().

Here is the caller graph for this function:

virtual const std::string& ome::xml::model::Reference::getID ( ) const

pure virtual

Retrieves the reference's target object ID.

Returns

See above.

Implemented in ome::xml::model::DetectorSettings, ome::xml::model::LightSourceSettings, ome::xml::model::ObjectiveSettings, ome::xml::model::Leader, ome::xml::model::Pump, ome::xml::model::AnnotationRef, ome::xml::model::ChannelRef, ome::xml::model::DatasetRef, ome::xml::model::DichroicRef, ome::xml::model::ExperimenterGroupRef, ome::xml::model::ExperimenterRef, ome::xml::model::ExperimentRef, ome::xml::model::FilterRef, ome::xml::model::FilterSetRef, ome::xml::model::ImageRef, ome::xml::model::InstrumentRef, ome::xml::model::MicrobeamManipulationRef, ome::xml::model::PlateRef, ome::xml::model::ProjectRef, ome::xml::model::ReagentRef, ome::xml::model::ROIRef, and ome::xml::model::WellSampleRef.

const std::string & ome::xml::model::Reference::getXMLNamespace ( ) const

virtual

Get the XML namespace for this model object.

Returns

the XML namespace.

Implements ome::xml::model::OMEModelObject.

Reimplemented in ome::xml::model::ROIRef, ome::xml::model::WellSampleRef, and ome::xml::model::Settings.

Referenced by asXMLElement(), and asXMLElementInternal().

Here is the caller graph for this function:

bool ome::xml::model::Reference::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.

Parameters

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.

Returns

true if this model object was able to handle the reference, otherwise false.

Todo:

the use of reference to provide type information for the type of object is unconventional and quite possibly unnecessary–a simple string or type_info would suffice for what it's being used for, if it's needed at all. Is this true for all cases? The implementation also needs to do strict checking of the object type; it's not currently failing if it's of the wrong type. This applies to all generated model objects implementing this interface.

References ome::xml::model::detail::OMEModelObject::link(), and ome::xml::model::detail::OMEModelObject::logger.

Referenced by ome::xml::model::Settings::link(), ome::xml::model::WellSampleRef::link(), ome::xml::model::FilterSetRef::link(), ome::xml::model::ROIRef::link(), ome::xml::model::ReagentRef::link(), ome::xml::model::AnnotationRef::link(), ome::xml::model::ProjectRef::link(), ome::xml::model::PlateRef::link(), ome::xml::model::MicrobeamManipulationRef::link(), ome::xml::model::ChannelRef::link(), ome::xml::model::InstrumentRef::link(), ome::xml::model::ImageRef::link(), ome::xml::model::FilterRef::link(), ome::xml::model::DichroicRef::link(), ome::xml::model::ExperimentRef::link(), ome::xml::model::ExperimenterRef::link(), ome::xml::model::ExperimenterGroupRef::link(), ome::xml::model::DatasetRef::link(), ome::xml::model::Leader::link(), and ome::xml::model::Pump::link().

Here is the caller graph for this function:

virtual void ome::xml::model::Reference::setID ( const std::string &  id )

pure virtual

Sets the reference's target object ID.

Parameters

id	The object ID to set.

Implemented in ome::xml::model::DetectorSettings, ome::xml::model::LightSourceSettings, ome::xml::model::ObjectiveSettings, ome::xml::model::Leader, ome::xml::model::Pump, ome::xml::model::AnnotationRef, ome::xml::model::ChannelRef, ome::xml::model::DatasetRef, ome::xml::model::DichroicRef, ome::xml::model::ExperimenterGroupRef, ome::xml::model::ExperimenterRef, ome::xml::model::ExperimentRef, ome::xml::model::FilterRef, ome::xml::model::FilterSetRef, ome::xml::model::ImageRef, ome::xml::model::InstrumentRef, ome::xml::model::MicrobeamManipulationRef, ome::xml::model::PlateRef, ome::xml::model::ProjectRef, ome::xml::model::ReagentRef, ome::xml::model::ROIRef, and ome::xml::model::WellSampleRef.

void ome::xml::model::Reference::update ( const common::xml::dom::Element &  element, ome::xml::model::OMEModel &  model  )

virtual

Update the object hierarchy recursively from an XML DOM tree.

Note

No properties are removed, only added or updated.

Parameters

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.

Exceptions

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.

Reimplemented in ome::xml::model::LightSourceSettings, ome::xml::model::DetectorSettings, ome::xml::model::ObjectiveSettings, ome::xml::model::Leader, ome::xml::model::Pump, ome::xml::model::AnnotationRef, ome::xml::model::ChannelRef, ome::xml::model::DatasetRef, ome::xml::model::DichroicRef, ome::xml::model::EmissionFilterRef, ome::xml::model::ExcitationFilterRef, ome::xml::model::ExperimenterGroupRef, ome::xml::model::ExperimenterRef, ome::xml::model::ExperimentRef, ome::xml::model::FilterRef, ome::xml::model::FilterSetRef, ome::xml::model::ImageRef, ome::xml::model::InstrumentRef, ome::xml::model::MicrobeamManipulationRef, ome::xml::model::PlateRef, ome::xml::model::ProjectRef, ome::xml::model::ReagentRef, ome::xml::model::ROIRef, ome::xml::model::WellSampleRef, and ome::xml::model::Settings.

References 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().

Referenced by ome::xml::model::Settings::update(), ome::xml::model::WellSampleRef::update(), ome::xml::model::FilterSetRef::update(), ome::xml::model::ROIRef::update(), ome::xml::model::ReagentRef::update(), ome::xml::model::AnnotationRef::update(), ome::xml::model::ProjectRef::update(), ome::xml::model::PlateRef::update(), ome::xml::model::MicrobeamManipulationRef::update(), ome::xml::model::ChannelRef::update(), ome::xml::model::InstrumentRef::update(), ome::xml::model::ImageRef::update(), ome::xml::model::FilterRef::update(), ome::xml::model::DichroicRef::update(), ome::xml::model::ExperimentRef::update(), ome::xml::model::ExperimenterRef::update(), ome::xml::model::ExperimenterGroupRef::update(), ome::xml::model::DatasetRef::update(), ome::xml::model::Leader::update(), and ome::xml::model::Pump::update().

Here is the caller graph for this function:

bool ome::xml::model::Reference::validElementName ( const std::string &  name ) const

virtual

Check if a given element name is valid for processing by this model object.

Used for processing nodes when interitance is involved.

Parameters

name	the element name to check.

Returns

true if valid, false if invalid.

Implements ome::xml::model::detail::OMEModelObject.

Reimplemented in ome::xml::model::ROIRef, ome::xml::model::WellSampleRef, and ome::xml::model::Settings.

References ome::xml::model::detail::OMEModelObject::validElementName().

Referenced by update(), ome::xml::model::Settings::validElementName(), ome::xml::model::ImageRef::validElementName(), ome::xml::model::ROIRef::validElementName(), ome::xml::model::FilterSetRef::validElementName(), ome::xml::model::ReagentRef::validElementName(), ome::xml::model::WellSampleRef::validElementName(), ome::xml::model::ProjectRef::validElementName(), ome::xml::model::PlateRef::validElementName(), ome::xml::model::MicrobeamManipulationRef::validElementName(), ome::xml::model::ChannelRef::validElementName(), ome::xml::model::InstrumentRef::validElementName(), ome::xml::model::ExperimenterGroupRef::validElementName(), ome::xml::model::FilterRef::validElementName(), ome::xml::model::DichroicRef::validElementName(), ome::xml::model::ExperimentRef::validElementName(), ome::xml::model::ExperimenterRef::validElementName(), ome::xml::model::AnnotationRef::validElementName(), ome::xml::model::DatasetRef::validElementName(), ome::xml::model::Leader::validElementName(), and ome::xml::model::Pump::validElementName().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• ome/xml/model/Reference.h
• ome/xml/model/Reference.cpp