ome::xml::model::detail::OMEModel Class Reference

OME model (concrete implementation). More...

#include <ome/xml/model/detail/OMEModel.h>

Inheritance diagram for ome::xml::model::detail::OMEModel:

Collaboration diagram for ome::xml::model::detail::OMEModel:

Public Member Functions
	OMEModel ()
	Constructor.
	~OMEModel ()
	Destructor.
std::shared_ptr<::ome::xml::model::OMEModelObject >	addModelObject (const std::string &id, std::shared_ptr<::ome::xml::model::OMEModelObject > &object)
	Add a model object to the model. More...
std::shared_ptr<::ome::xml::model::OMEModelObject >	removeModelObject (const std::string &id)
	Remove a model object from the model. More...
std::shared_ptr<::ome::xml::model::OMEModelObject >	getModelObject (const std::string &id) const
	Retrieve a model object from the model. More...
const object_map_type &	getModelObjects () const
	Retrieve all model objects from the model. More...
bool	addReference (std::shared_ptr<::ome::xml::model::OMEModelObject > &a, std::shared_ptr< Reference > &b)
	Add a reference to a model object. More...
const reference_map_type &	getReferences () const
	Retrieve all references from the model. More...
size_type	resolveReferences ()
	Resolve all references. More...
Public Member Functions inherited from ome::xml::model::OMEModel
virtual SKIP std::shared_ptr< OMEModelObject >	addModelObject (const std::string &id, std::shared_ptr< OMEModelObject > &object)=0
	Add a model object to the model. More...
virtual bool	addReference (std::shared_ptr< OMEModelObject > &a, std::shared_ptr< Reference > &b)=0
	Add a reference to a model object. More...

Private Attributes
ome::common::Logger	logger
	Message logger.
object_map_type	modelObjects
	Mapping of id to model object.
reference_map_type	references
	Mapping of model object to reference.

Additional Inherited Members
Public Types inherited from ome::xml::model::OMEModel
typedef std::vector< std::shared_ptr< Reference > >	reference_list_type
	A list of Reference objects.
typedef std::map< std::string, std::shared_ptr< OMEModelObject > >	object_map_type
	A map of string model object identifiers to model objects.
typedef std::map< std::shared_ptr< OMEModelObject >, reference_list_type >	reference_map_type
	A map of model objects to list of Reference objects.
typedef reference_map_type::size_type	size_type
	Size type for reference map.
Protected Member Functions inherited from ome::xml::model::OMEModel
	OMEModel ()
	Constructor.

Detailed Description

OME model (concrete implementation).

Member Function Documentation

addModelObject()

std::shared_ptr<::ome::xml::model::OMEModelObject > ome::xml::model::detail::OMEModel::addModelObject	(	const std::string &	id,
		std::shared_ptr<::ome::xml::model::OMEModelObject > &	object
	)

Add a model object to the model.

Note that the concrete implementation will not add types derived from Reference.

Parameters

id	the model object identifier.
object	the model object to add.

Returns

the model object.

Todo:

What is the point of returning the object? The object is returned under all conditions, even when adding the object failed (e.g. if the object was a Reference). Should it be possible to insert null objects?

References modelObjects.

addReference()

bool ome::xml::model::detail::OMEModel::addReference	(	std::shared_ptr<::ome::xml::model::OMEModelObject > &	a,
		std::shared_ptr< Reference > &	b
	)

Add a reference to a model object.

Parameters

a	the model object to reference.
b	the reference to add.

Returns

true

Todo:

There is no validation of whether the model object was valid for this model (as for the java implementation). The return type is an artifact of the java map implementation. Consider removing the return type and throwing if the model object is not already present in the object map; or adding the object to the object map implicitly and not throwing.

References references.

getModelObject()

std::shared_ptr<::ome::xml::model::OMEModelObject > ome::xml::model::detail::OMEModel::getModelObject ( const std::string &  id ) const

virtual

Retrieve a model object from the model.

Parameters

id	the model object identifier of the model object to retrieve.

Returns

the model object or null if the identifier does not exist.

Todo:

: Would a const reference be better for the return?

Implements ome::xml::model::OMEModel.

References modelObjects.

Referenced by resolveReferences().

Here is the caller graph for this function:

getModelObjects()

const OMEModel::object_map_type & ome::xml::model::detail::OMEModel::getModelObjects ( ) const

virtual

Retrieve all model objects from the model.

Returns

a reference to the object model map.

Implements ome::xml::model::OMEModel.

References modelObjects.

getReferences()

const OMEModel::reference_map_type & ome::xml::model::detail::OMEModel::getReferences ( ) const

virtual

Retrieve all references from the model.

Returns

a reference to the reference map.

Implements ome::xml::model::OMEModel.

References references.

removeModelObject()

std::shared_ptr<::ome::xml::model::OMEModelObject > ome::xml::model::detail::OMEModel::removeModelObject ( const std::string &  id )

virtual

Remove a model object from the model.

Parameters

id	the model object identifier of the model object to remove.

Returns

the model object or null if the identifier does not exist.

Implements ome::xml::model::OMEModel.

References modelObjects.

resolveReferences()

OMEModel::size_type ome::xml::model::detail::OMEModel::resolveReferences ( )

virtual

Resolve all references.

Check for invalid references and null model objects.

Returns

the number of unhandled references.

Todo:

This method is a bit of a wart in the design. The model should not allow invalid references or insertion of null model objects to begin with.

Implements ome::xml::model::OMEModel.

References getModelObject(), logger, and references.

---

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

• ome/xml/model/detail/OMEModel.h
• ome/xml/model/detail/OMEModel.cpp