Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
XMLFile.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-2015.
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: Andreas Bertsch $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_XMLFILE_H
36 #define OPENMS_FORMAT_XMLFILE_H
37 
38 // OpenMS includes
41 
42 #include <xercesc/framework/XMLFormatter.hpp>
43 
44 #include <iosfwd>
45 
46 namespace OpenMS
47 {
48  namespace Internal
49  {
50  class XMLHandler;
51 
53  class OPENMS_DLLAPI XMLFile
54  {
55 
56 public:
57 
59  XMLFile();
61  XMLFile(const String & schema_location, const String & version);
63  virtual ~XMLFile();
64 
76  bool isValid(const String & filename, std::ostream & os);
77 
79  const String & getVersion() const;
80 
81 protected:
88  void parse_(const String & filename, XMLHandler * handler);
89 
95  void save_(const String & filename, XMLHandler * handler) const;
96 
99 
102 
105 
106  void enforceEncoding_(const String& encoding);
107  };
108 
115  String OPENMS_DLLAPI encodeTab(const String & to_encode);
116  } // namespace Internal
117 } // namespace OpenMS
118 
119 #endif // OPENMS_FOMAT_XMLFILE_H
String encodeTab(const String &to_encode)
Encodes tabs &#39;&#39; in the string as &#x9; and returns the encoded string.
String schema_version_
Version string.
Definition: XMLFile.h:101
A more convenient string class.
Definition: String.h:57
Base class for XML handlers.
Definition: XMLHandler.h:99
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
String enforced_encoding_
Encoding string that replaces the encoding (system dependent or specified in the XML). Disabled if empty. Used as a workaround for XTandem output xml.
Definition: XMLFile.h:104
String schema_location_
XML schema file location.
Definition: XMLFile.h:98
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition: XMLFile.h:53

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 12:49:26 using doxygen 1.8.11