bioformats  5.1.6
Reference.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_REFERENCE_H
47 #define OME_XML_MODEL_REFERENCE_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/detail/OMEModelObject.h>
63 
64 namespace ome
65 {
66  namespace xml
67  {
68  namespace model
69  {
70 
71  // Forward declarations.
72  class OMEModel;
73 
78  {
79  private:
80  class Impl;
82  ome::compat::shared_ptr<Impl> impl;
83 
84  public:
86  Reference();
87 
93  Reference (const Reference& copy);
94 
96  virtual
97  ~Reference ();
98 
99 
100  // Documented in superclass.
101  bool
102  validElementName(const std::string& name) const;
103 
104  private:
106  Reference&
107  operator= (const Reference&);
108 
109  public:
110  // -- Custom content from Reference specific template --
111 
116  virtual
117  const std::string&
118  getID () const = 0;
119 
124  virtual
125  void
126  setID (const std::string& id) = 0;
127 
128  // -- OMEModelObject API methods --
129 
131  virtual void
132  update(const common::xml::dom::Element& element,
134 
135  public:
136  // -- Reference API methods --
137 
139  bool
140  link (ome::compat::shared_ptr<Reference>& reference,
141  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
142 
143 
146  asXMLElement (common::xml::dom::Document& document) const;
147 
148 
149  protected:
150  // Documented in base class.
153  common::xml::dom::Element& element) const;
154 
155  public:
156  // Documented in superclass.
157  const std::string&
158  getXMLNamespace() const;
159  };
160 
161  }
162  }
163 }
164 
165 #endif // OME_XML_MODEL_REFERENCE_H
166 
167 /*
168  * Local Variables:
169  * mode:C++
170  * End:
171  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
virtual ~Reference()
Destructor.
Definition: Reference.cpp:122
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Reference.h:80
DOM Document wrapper.
Definition: Document.h:83
DOM Element wrapper.
Definition: Element.h:66
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
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: Reference.cpp:150
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: Reference.cpp:172
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: Reference.cpp:137
virtual void setID(const std::string &id)=0
Sets the reference's target object ID.
Reference & operator=(const Reference &)
Assignment operator (deleted).
Private implementation details of Reference model object.
Definition: Reference.cpp:70
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
virtual const std::string & getID() const =0
Retrieves the reference's target object ID.
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Reference.cpp:187
Reference()
Default constructor.
Definition: Reference.cpp:103
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Reference.cpp:165
Reference model object.
Definition: Reference.h:77
Boost.Log compatibility.
Xerces-C modern C++ wrapper.
Definition: Base.h:53
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Reference.cpp:128