bioformats  5.1.6
TagAnnotation.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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 /*─────────────────────────────────────────────────────────────────────────────
40  *
41  * THIS IS AUTOMATICALLY GENERATED CODE. DO NOT MODIFY.
42  *
43  *─────────────────────────────────────────────────────────────────────────────
44  */
45 
46 #ifndef OME_XML_MODEL_TAGANNOTATION_H
47 #define OME_XML_MODEL_TAGANNOTATION_H
48 
49 #include <algorithm>
50 #include <list>
51 #include <stdexcept>
52 #include <string>
53 #include <vector>
54 
55 #include <ome/common/log.h>
56 
57 #include <ome/common/xml/dom/Document.h>
58 #include <ome/common/xml/dom/Element.h>
59 #include <ome/common/xml/dom/Node.h>
60 #include <ome/common/xml/dom/NodeList.h>
61 
62 #include <ome/xml/model/StructuredAnnotations.h>
63 #include <ome/xml/model/TextAnnotation.h>
64 
65 namespace ome
66 {
67  namespace xml
68  {
69  namespace model
70  {
71 
72  // Forward declarations.
73  class OMEModel;
74 
79  {
80  private:
81  class Impl;
83  ome::compat::shared_ptr<Impl> impl;
84 
85  public:
87  TagAnnotation();
88 
94  TagAnnotation (const TagAnnotation& copy);
95 
97  virtual
98  ~TagAnnotation ();
99 
114  static ome::compat::shared_ptr< TagAnnotation>
115  create(const common::xml::dom::Element& element,
117 
118  // Documented in superclass.
119  const std::string&
120  elementName() const;
121 
122  // Documented in superclass.
123  bool
124  validElementName(const std::string& name) const;
125 
126 
127  // -- OMEModelObject API methods --
128 
130  virtual void
131  update(const common::xml::dom::Element& element,
133 
134  public:
135  // -- TagAnnotation API methods --
136 
138  bool
139  link (ome::compat::shared_ptr<Reference>& reference,
140  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
141 
147  const std::string&
148  getValue () const;
149 
155  void
156  setValue (const std::string& value);
157 
163  ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
165 
171  const ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
172  getStructuredAnnotations () const;
173 
179  void
180  setStructuredAnnotations (ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations_BackReference);
181 
182 
185  asXMLElement (common::xml::dom::Document& document) const;
186 
187 
188  protected:
189  // Documented in base class.
192  common::xml::dom::Element& element) const;
193 
194  public:
195  // Documented in superclass.
196  const std::string&
197  getXMLNamespace() const;
198  };
199 
200  }
201  }
202 }
203 
204 #endif // OME_XML_MODEL_TAGANNOTATION_H
205 
206 /*
207  * Local Variables:
208  * mode:C++
209  * End:
210  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: TagAnnotation.cpp:282
const std::string & elementName() const
Get the element name of this model object.
Definition: TagAnnotation.cpp:151
TextAnnotation model object.
Definition: TextAnnotation.h:77
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: TagAnnotation.h:81
void setStructuredAnnotations(ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations_BackReference)
Set the StructuredAnnotations property.
Definition: TagAnnotation.cpp:237
DOM Document wrapper.
Definition: Document.h:83
DOM Element wrapper.
Definition: Element.h:66
ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: TagAnnotation.cpp:223
const std::string & getValue() const
Get the Value property.
Definition: TagAnnotation.cpp:209
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: TagAnnotation.cpp:194
Private implementation details of TagAnnotation model object.
Definition: TagAnnotation.cpp:71
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: TagAnnotation.cpp:251
TagAnnotation()
Default constructor.
Definition: TagAnnotation.cpp:118
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
virtual ~TagAnnotation()
Destructor.
Definition: TagAnnotation.cpp:137
TagAnnotation model object.
Definition: TagAnnotation.h:78
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: TagAnnotation.cpp:244
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: TagAnnotation.cpp:167
static ome::compat::shared_ptr< TagAnnotation > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a TagAnnotation model object from DOM element.
Definition: TagAnnotation.cpp:142
Boost.Log compatibility.
void setValue(const std::string &value)
Set the Value property.
Definition: TagAnnotation.cpp:216
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: TagAnnotation.cpp:158
Xerces-C modern C++ wrapper.
Definition: Base.h:53