| OpenMS 2.5.0

MzMLValidator.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-2020.
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: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/FORMAT/VALIDATORS/SemanticValidator.h>
38
39 namespace OpenMS
40 {
41 class ControlledVocabulary;
42 namespace Internal
43 {
44
48 class OPENMS_DLLAPI MzMLValidator :
49 public SemanticValidator
50 {
51 public:
58 MzMLValidator(const CVMappings & mapping, const ControlledVocabulary & cv);
59
61 ~MzMLValidator() override;
62
63 protected:
64
65 // Docu in base class
66 void startElement(const XMLCh * const /*uri*/, const XMLCh * const /*local_name*/, const XMLCh * const qname, const xercesc::Attributes & attributes) override;
67
68 // Docu in base class
69 String getPath_(UInt remove_from_end = 0) const override;
70
71 // Docu in base class
72 void handleTerm_(const String & path, const CVTerm & parsed_term) override;
73
75 Map<String, std::vector<CVTerm> > param_groups_;
76
78 String current_id_;
79
81 String binary_data_array_;
83 String binary_data_type_;
84
85 private:
86
88 MzMLValidator();
89
91 MzMLValidator(const MzMLValidator & rhs);
92
94 MzMLValidator & operator=(const MzMLValidator & rhs);
95
96 };
97
98 } // namespace Internal
99
100 } // namespace OpenMS
101
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::Internal::MzMLValidator
Semantically validates MzXML files.
Definition: MzMLValidator.h:48
SemanticValidator.h
OpenMS::Internal::MzMLValidator::binary_data_type_
String binary_data_type_
Binary data array type.
Definition: MzMLValidator.h:83
OpenMS::CVMappings
Representation of controlled vocabulary mapping rules (for PSI formats)
Definition: CVMappings.h:56
OpenMS::Internal::SemanticValidator
Semantically validates XML files using CVMappings and a ControlledVocabulary.
Definition: SemanticValidator.h:55
OpenMS::CVTerm
Representation of controlled vocabulary term.
Definition: CVTerm.h:52
OpenMS::Map
Map class based on the STL map (containing several convenience functions)
Definition: Map.h:50
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::UInt
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
OpenMS::Internal::MzMLValidator::param_groups_
Map< String, std::vector< CVTerm > > param_groups_
CV terms which can have a value (term => value type)
Definition: MzMLValidator.h:75
OpenMS::Internal::MzMLValidator::binary_data_array_
String binary_data_array_
Binary data array name.
Definition: MzMLValidator.h:81
OpenMS::ControlledVocabulary
Representation of a controlled vocabulary.
Definition: ControlledVocabulary.h:54
OpenMS::Internal::MzMLValidator::current_id_
String current_id_
Current referenceableParamGroup identifier.
Definition: MzMLValidator.h:78