Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
CVMappingFile.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2017.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Andreas Bertsch $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_CVMAPPINGFILE_H
36 #define OPENMS_FORMAT_CVMAPPINGFILE_H
37 
38 #include <OpenMS/FORMAT/XMLFile.h>
42 
43 #include <vector>
44 
45 namespace OpenMS
46 {
47  class String;
48 
57  class OPENMS_DLLAPI CVMappingFile :
58  protected Internal::XMLHandler,
59  public Internal::XMLFile
60  {
61 public:
62 
64  CVMappingFile();
65 
67  virtual ~CVMappingFile();
68 
78  void load(const String& filename, CVMappings& cv_mappings, bool strip_namespaces = false);
79 
80 protected:
81 
82  // Docu in base class
83  void startElement(const XMLCh* const /*uri*/, const XMLCh* const /*local_name*/, const XMLCh* const qname, const xercesc::Attributes& attributes);
84 
85  // Docu in base class
86  void endElement(const XMLCh* const /*uri*/, const XMLCh* const /*local_name*/, const XMLCh* const qname);
87 
88  // Docu in base class
89  void characters(const XMLCh* const chars, const XMLSize_t /*length*/);
90 
91 private:
92 
94  CVMappingFile(const CVMappingFile& rhs);
95 
97  CVMappingFile& operator=(const CVMappingFile& rhs);
98 
100 
102 
104 
105  std::vector<CVMappingRule> rules_;
106 
107  std::vector<CVReference> cv_references_;
108 
109  };
110 
111 } // namespace OpenMS
112 
113 #endif // OPENMS_FORMAT_CVMAPPINGFILE_H
A more convenient string class.
Definition: String.h:57
Base class for XML handlers.
Definition: XMLHandler.h:110
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
String tag_
Definition: CVMappingFile.h:99
bool strip_namespaces_
Definition: CVMappingFile.h:101
std::vector< CVReference > cv_references_
Definition: CVMappingFile.h:107
Representation of a CV Mapping rule used by CVMappings.
Definition: CVMappingRule.h:54
CVMappingRule actual_rule_
Definition: CVMappingFile.h:103
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition: XMLFile.h:49
Representation of controlled vocabulary mapping rules (for PSI formats)
Definition: CVMappings.h:57
std::vector< CVMappingRule > rules_
Definition: CVMappingFile.h:105
Used to load CvMapping files.
Definition: CVMappingFile.h:57

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:21:59 using doxygen 1.8.13