ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

MapPairs.h
1 /*
2 * #%L
3 * OME-XML C++ library for working with OME-XML metadata structures.
4 * %%
5 * Copyright © 2006 - 2016 Open Microscopy Environment:
6 * - Massachusetts Institute of Technology
7 * - National Institutes of Health
8 * - University of Dundee
9 * - Board of Regents of the University of Wisconsin-Madison
10 * - Glencoe Software, Inc.
11 * %%
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 * The views and conclusions contained in the software and documentation are
34 * those of the authors and should not be interpreted as representing official
35 * policies, either expressed or implied, of any organization.
36 * #L%
37 */
38
39 #ifndef OME_XML_MODEL_MAPPAIRS_H
40 #define OME_XML_MODEL_MAPPAIRS_H
41
42 #include <algorithm>
43 #include <map>
44 #include <string>
45 #include <vector>
46
47 #include <ome/compat/memory.h>
48
49 #include <ome/common/xml/dom/Document.h>
50 #include <ome/common/xml/dom/Element.h>
51 #include <ome/common/xml/dom/Node.h>
52 #include <ome/common/xml/dom/NodeList.h>
53
54 #include <ome/xml/model/detail/OMEModelObject.h>
55
56 namespace ome
57 {
58 namespace xml
59 {
60 namespace model
61 {
62
63 // Forward declarations.
64 class OMEModel;
65
69 class MapPairs : public detail::OMEModelObject
70 {
71 public:
73 typedef std::map<std::string, std::string> map_type;
74
75 private:
77 map_type map;
78
79 public:
81 MapPairs ();
82
88 MapPairs (const MapPairs& copy);
89
97 MapPairs (const map_type& map);
98
109 MapPairs (common::xml::dom::Element& element, ::ome::xml::model::OMEModel& model);
110
112 virtual
113 ~MapPairs ();
114
115 // Documented in superclass.
116 const std::string&
117 elementName() const;
118
119 // Documented in superclass.
120 bool
121 validElementName(const std::string& name) const;
122
124 virtual void
125 update(const common::xml::dom::Element& element,
126 ::ome::xml::model::OMEModel& model);
127
128 public:
130 bool
131 link (ome::compat::shared_ptr<Reference>& reference,
132 ome::compat::shared_ptr< ::ome::xml::model::OMEModelObject>& object);
133
139 map_type&
140 getMap ();
141
147 const map_type&
148 getMap () const;
149
155 void
156 setMap (const map_type& map);
157
159 virtual common::xml::dom::Element
160 asXMLElement (common::xml::dom::Document& document) const;
161
162 protected:
163 // Documented in base class.
164 virtual common::xml::dom::Element
165 asXMLElementInternal (common::xml::dom::Document& document,
166 common::xml::dom::Element& element) const;
167
168 public:
169 // Documented in superclass.
170 const std::string&
171 getXMLNamespace() const;
172 };
173
174 }
175 }
176 }
177
178 #endif // OME_XML_MODEL_MAPPAIRS_H
179
180 /*
181 * Local Variables:
182 * mode:C++
183 * End:
184 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::MapPairs::link
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.
Definition: MapPairs.cpp:147
ome::xml::model::MapPairs::update
virtual void update(const common::xml::dom::Element &element,::ome::xml::model::OMEModel &model)
Update the object hierarchy recursively from an XML DOM tree.
Definition: MapPairs.cpp:115
ome::xml::model::MapPairs::setMap
void setMap(const map_type &map)
Set the key-value pair mappings.
Definition: MapPairs.cpp:209
memory.h
ome::xml::model::MapPairs::getMap
map_type & getMap()
Get the key-value pair mappings.
Definition: MapPairs.cpp:197
ome::xml::model::MapPairs::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: MapPairs.cpp:107
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::MapPairs::~MapPairs
virtual ~MapPairs()
Destructor.
Definition: MapPairs.cpp:95
ome::xml::model::MapPairs::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: MapPairs.cpp:100
ome::xml::model::MapPairs::asXMLElementInternal
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.
Definition: MapPairs.cpp:168
ome::xml::model::MapPairs::map_type
std::map< std::string, std::string > map_type
Type of map stored internally.
Definition: MapPairs.h:73
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::MapPairs::MapPairs
MapPairs()
Default constructor.
Definition: MapPairs.cpp:56
ome::xml::model::MapPairs
MapPairs model object.
Definition: MapPairs.h:69
ome::xml::model::MapPairs::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: MapPairs.cpp:161
ome::xml::model::MapPairs::map
map_type map
Key-value pair mappings.
Definition: MapPairs.h:77
ome::xml::model::MapPairs::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: MapPairs.cpp:215