OpenMS
MzIdentMLDOMHandler.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-2023.
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: Mathias Walzer $
32 // $Authors: Mathias Walzer$
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
46 
47 #include <xercesc/dom/DOM.hpp>
48 #include <xercesc/dom/DOMDocument.hpp>
49 #include <xercesc/dom/DOMDocumentType.hpp>
50 #include <xercesc/dom/DOMElement.hpp>
51 #include <xercesc/dom/DOMImplementation.hpp>
52 #include <xercesc/dom/DOMImplementationLS.hpp>
53 #include <xercesc/dom/DOMNodeIterator.hpp>
54 #include <xercesc/dom/DOMNodeList.hpp>
55 #include <xercesc/dom/DOMText.hpp>
56 #include <xercesc/util/OutOfMemoryException.hpp>
57 #include <xercesc/util/XMLString.hpp>
58 #include <xercesc/util/PlatformUtils.hpp>
59 #include <xercesc/framework/LocalFileFormatTarget.hpp>
60 
61 #include <xercesc/parsers/XercesDOMParser.hpp>
62 #include <xercesc/util/XMLUni.hpp>
63 #include <xercesc/framework/psvi/XSValue.hpp>
64 
65 #include <list>
66 #include <string>
67 #include <stdexcept>
68 #include <vector>
69 #include <map>
70 
71 // Error codes
72 //enum {
73 // ERROR_ARGS = 1,
74 // ERROR_XERCES_INIT,
75 // ERROR_PARSE,
76 // ERROR_EMPTY_DOCUMENT
77 //};
78 
79 namespace OpenMS
80 {
81  class ProgressLogger;
82 
83  namespace Internal
84  {
96  class OPENMS_DLLAPI MzIdentMLDOMHandler
97  {
98 public:
102  MzIdentMLDOMHandler(const std::vector<ProteinIdentification>& pro_id, const std::vector<PeptideIdentification>& pep_id, const String& version, const ProgressLogger& logger);
103 
105  MzIdentMLDOMHandler(std::vector<ProteinIdentification>& pro_id, std::vector<PeptideIdentification>& pep_id, const String& version, const ProgressLogger& logger);
106 
110 
112  void readMzIdentMLFile(const std::string& mzid_file);
114  void writeMzIdentMLFile(const std::string& mzid_file);
115 
116 protected:
119 
124 
126  std::vector<ProteinIdentification>* pro_id_;
128  std::vector<PeptideIdentification>* pep_id_;
129 
131  const std::vector<ProteinIdentification>* cpro_id_;
133  const std::vector<PeptideIdentification>* cpep_id_;
134 
137 
139  ControlledVocabulary::CVTerm getChildWithName_(const String& parent_accession, const String& name) const;
140 
143  std::pair<CVTermList, std::map<String, DataValue> > parseParamGroup_(xercesc::DOMNodeList* paramGroup);
144  CVTerm parseCvParam_(xercesc::DOMElement* param);
145  std::pair<String, DataValue> parseUserParam_(xercesc::DOMElement* param);
146  void parseAnalysisSoftwareList_(xercesc::DOMNodeList* analysisSoftwareElements);
147  void parseDBSequenceElements_(xercesc::DOMNodeList* dbSequenceElements);
148  void parsePeptideElements_(xercesc::DOMNodeList* peptideElements);
149  //AASequence parsePeptideSiblings_(xercesc::DOMNodeList* peptideSiblings);
150  AASequence parsePeptideSiblings_(xercesc::DOMElement* peptide);
151  void parsePeptideEvidenceElements_(xercesc::DOMNodeList* peptideEvidenceElements);
152  void parseSpectrumIdentificationElements_(xercesc::DOMNodeList* spectrumIdentificationElements);
153  void parseSpectrumIdentificationProtocolElements_(xercesc::DOMNodeList* spectrumIdentificationProtocolElements);
154  void parseInputElements_(xercesc::DOMNodeList* inputElements);
155  void parseSpectrumIdentificationListElements_(xercesc::DOMNodeList* spectrumIdentificationListElements);
156  void parseSpectrumIdentificationItemSetXLMS(std::set<String>::const_iterator set_it, std::multimap<String, int> xl_val_map, xercesc::DOMElement* element_res, const String& spectrumID);
157  void parseSpectrumIdentificationItemElement_(xercesc::DOMElement* spectrumIdentificationItemElement, PeptideIdentification& spectrum_identification, String& spectrumIdentificationList_ref);
158  void parseProteinDetectionHypothesisElement_(xercesc::DOMElement* proteinDetectionHypothesisElement, ProteinIdentification& protein_identification);
159  void parseProteinAmbiguityGroupElement_(xercesc::DOMElement* proteinAmbiguityGroupElement, ProteinIdentification& protein_identification);
160  void parseProteinDetectionListElements_(xercesc::DOMNodeList* proteinDetectionListElements);
161  static ProteinIdentification::SearchParameters findSearchParameters_(std::pair<CVTermList, std::map<String, DataValue> > as_params);
163 
165  void buildCvList_(xercesc::DOMElement* cvElements);
166  void buildAnalysisSoftwareList_(xercesc::DOMElement* analysisSoftwareElements);
167  void buildSequenceCollection_(xercesc::DOMElement* sequenceCollectionElements);
168  void buildAnalysisCollection_(xercesc::DOMElement* analysisCollectionElements);
169  void buildAnalysisProtocolCollection_(xercesc::DOMElement* protocolElements);
170  void buildInputDataCollection_(xercesc::DOMElement* inputElements);
171  void buildEnclosedCV_(xercesc::DOMElement* parentElement, const String& encel, const String& acc, const String& name, const String& cvref);
172  void buildAnalysisDataCollection_(xercesc::DOMElement* analysisElements);
174 
175 
176 private:
180 
183  {
186  };
189  {
190  int start;
191  int stop;
192  char pre;
193  char post;
194  bool idec;
195  };
197  struct DBSequence
198  {
203  };
206  {
211  };
214  {
216  long double mass_delta;
220  };
223  {
227  std::map<String, DataValue> parameter_ups;
228 // std::vector<ModificationParam> modification_parameter;
230  long double precursor_tolerance;
231  long double fragment_tolerance;
233  std::map<String, DataValue> threshold_ups;
234  };
237  {
242  };
243 
247 
248  xercesc::XercesDOMParser mzid_parser_;
249 
250  //from AnalysisSoftware
253  //mapping from AnalysisSoftware
254  std::map<String, AnalysisSoftware> as_map_;
255 
256  //mapping from DataCollection Inputs
257  std::map<String, String> sr_map_;
258  std::map<String, String> sd_map_;
259  std::map<String, DatabaseInput> db_map_;
260 
261  //mapping from SpectrumIdentification - SpectrumIdentification will be the new IdentificationRuns
262  std::map<String, SpectrumIdentification> si_map_;
263  std::map<String, size_t> si_pro_map_;
264 
265  //mapping from SpectrumIdentificationProtocol
266  std::map<String, SpectrumIdentificationProtocol> sp_map_;
267 
268  //mapping from SequenceCollection
269  std::map<String, AASequence> pep_map_;
270  std::map<String, PeptideEvidence> pe_ev_map_;
271  std::map<String, String> pv_db_map_;
272  std::multimap<String, String> p_pv_map_;
273  std::map<String, DBSequence> db_sq_map_;
274 
275  std::list<std::list<String> > hit_pev_;
276 
278  std::map<String, String> xl_id_donor_map_;
279  //std::map<String, String> xl_id_acceptor_map_; ///< mapping Peptide id -> cross-link acceptor value
280  std::map<String, String> xl_id_acceptor_map_;
281  std::map<String, SignedSize> xl_donor_pos_map_;
282  std::map<String, SignedSize> xl_acceptor_pos_map_;
283  std::map<String, double> xl_mass_map_;
284  std::map<String, String> xl_mod_map_;
285 
286  };
287  } // namespace Internal
288 } // namespace OpenMS
289 
Representation of a peptide/protein sequence.
Definition: AASequence.h:112
Representation of controlled vocabulary term list.
Definition: CVTermList.h:54
Representation of controlled vocabulary term.
Definition: CVTerm.h:53
Representation of a controlled vocabulary.
Definition: ControlledVocabulary.h:55
DateTime Class.
Definition: DateTime.h:59
XML DOM handler for MzIdentMLFile.
Definition: MzIdentMLDOMHandler.h:97
ControlledVocabulary::CVTerm getChildWithName_(const String &parent_accession, const String &name) const
Looks up a child CV term of parent_accession with the name name. If no such term is found,...
void readMzIdentMLFile(const std::string &mzid_file)
Provides the functionality of reading a mzid with a handler object.
std::map< String, SpectrumIdentification > si_map_
mapping SpectrumIdentification id -> SpectrumIdentification (id refs)
Definition: MzIdentMLDOMHandler.h:262
void buildAnalysisSoftwareList_(xercesc::DOMElement *analysisSoftwareElements)
std::map< String, DatabaseInput > db_map_
mapping database id -> DatabaseInput
Definition: MzIdentMLDOMHandler.h:259
CVTermList parameter_cvs
Definition: MzIdentMLDOMHandler.h:226
String search_database_ref
Definition: MzIdentMLDOMHandler.h:208
bool xl_ms_search_
is true when reading a file containing Cross-Linking MS search results
Definition: MzIdentMLDOMHandler.h:277
void parseSpectrumIdentificationItemElement_(xercesc::DOMElement *spectrumIdentificationItemElement, PeptideIdentification &spectrum_identification, String &spectrumIdentificationList_ref)
DateTime date
Definition: MzIdentMLDOMHandler.h:241
std::map< String, double > xl_mass_map_
mapping Peptide id -> cross-link mass
Definition: MzIdentMLDOMHandler.h:283
std::map< String, String > sd_map_
mapping spectradata id -> spectradata location
Definition: MzIdentMLDOMHandler.h:258
CVTerm parseCvParam_(xercesc::DOMElement *param)
std::map< String, DBSequence > db_sq_map_
mapping DBSequence id -> Sequence
Definition: MzIdentMLDOMHandler.h:273
XMLCh * xml_root_tag_ptr_
Definition: MzIdentMLDOMHandler.h:244
int start
Definition: MzIdentMLDOMHandler.h:190
String sequence
Definition: MzIdentMLDOMHandler.h:199
std::map< String, String > sr_map_
mapping sourcefile id -> sourcefile location
Definition: MzIdentMLDOMHandler.h:257
void parseProteinDetectionListElements_(xercesc::DOMNodeList *proteinDetectionListElements)
long double precursor_tolerance
Definition: MzIdentMLDOMHandler.h:230
void parseInputElements_(xercesc::DOMNodeList *inputElements)
std::pair< String, DataValue > parseUserParam_(xercesc::DOMElement *param)
String location
Definition: MzIdentMLDOMHandler.h:239
const std::vector< ProteinIdentification > * cpro_id_
Internal -w Identification Item for proteins.
Definition: MzIdentMLDOMHandler.h:131
void parseProteinDetectionHypothesisElement_(xercesc::DOMElement *proteinDetectionHypothesisElement, ProteinIdentification &protein_identification)
std::map< String, SignedSize > xl_acceptor_pos_map_
mapping acceptor value -> cross-link modification location
Definition: MzIdentMLDOMHandler.h:282
const ProgressLogger & logger_
Progress logger.
Definition: MzIdentMLDOMHandler.h:118
ControlledVocabulary cv_
Controlled vocabulary (psi-ms from OpenMS/share/OpenMS/CV/psi-ms.obo)
Definition: MzIdentMLDOMHandler.h:121
String search_engine_
Definition: MzIdentMLDOMHandler.h:251
void buildAnalysisCollection_(xercesc::DOMElement *analysisCollectionElements)
std::map< String, PeptideEvidence > pe_ev_map_
mapping PeptideEvidence id -> PeptideEvidence
Definition: MzIdentMLDOMHandler.h:270
void parseSpectrumIdentificationItemSetXLMS(std::set< String >::const_iterator set_it, std::multimap< String, int > xl_val_map, xercesc::DOMElement *element_res, const String &spectrumID)
long double mass_delta
Definition: MzIdentMLDOMHandler.h:216
CVTermList modification_param_cvs
Definition: MzIdentMLDOMHandler.h:218
String version
Definition: MzIdentMLDOMHandler.h:185
static ProteinIdentification::SearchParameters findSearchParameters_(std::pair< CVTermList, std::map< String, DataValue > > as_params)
XMLCh * xml_cvparam_tag_ptr_
Definition: MzIdentMLDOMHandler.h:245
long double fragment_tolerance
Definition: MzIdentMLDOMHandler.h:231
String spectrum_identification_list_ref
Definition: MzIdentMLDOMHandler.h:210
int stop
Definition: MzIdentMLDOMHandler.h:191
std::map< String, size_t > si_pro_map_
mapping SpectrumIdentificationList id -> index to ProteinIdentification in pro_id_
Definition: MzIdentMLDOMHandler.h:263
MzIdentMLDOMHandler & operator=(const MzIdentMLDOMHandler &rhs)
String database_ref
Definition: MzIdentMLDOMHandler.h:200
std::vector< ProteinIdentification > * pro_id_
Internal +w Identification Item for proteins.
Definition: MzIdentMLDOMHandler.h:126
void parseProteinAmbiguityGroupElement_(xercesc::DOMElement *proteinAmbiguityGroupElement, ProteinIdentification &protein_identification)
void parseSpectrumIdentificationElements_(xercesc::DOMNodeList *spectrumIdentificationElements)
void parsePeptideEvidenceElements_(xercesc::DOMNodeList *peptideEvidenceElements)
CVTerm searchtype
Definition: MzIdentMLDOMHandler.h:224
std::map< String, String > pv_db_map_
mapping PeptideEvidence id -> DBSequence id
Definition: MzIdentMLDOMHandler.h:271
void buildAnalysisDataCollection_(xercesc::DOMElement *analysisElements)
String search_engine_version_
Definition: MzIdentMLDOMHandler.h:252
std::map< String, AnalysisSoftware > as_map_
mapping AnalysisSoftware id -> AnalysisSoftware
Definition: MzIdentMLDOMHandler.h:254
std::vector< PeptideIdentification > * pep_id_
Internal +w Identification Item for peptides.
Definition: MzIdentMLDOMHandler.h:128
void buildEnclosedCV_(xercesc::DOMElement *parentElement, const String &encel, const String &acc, const String &name, const String &cvref)
bool idec
Definition: MzIdentMLDOMHandler.h:194
ControlledVocabulary unimod_
Controlled vocabulary for modifications (unimod from OpenMS/share/OpenMS/CV/unimod....
Definition: MzIdentMLDOMHandler.h:123
std::map< String, String > xl_mod_map_
mapping peptide id -> cross-linking reagent name
Definition: MzIdentMLDOMHandler.h:284
std::map< String, String > xl_id_donor_map_
mapping Peptide id -> cross-link donor value
Definition: MzIdentMLDOMHandler.h:278
void parseSpectrumIdentificationProtocolElements_(xercesc::DOMNodeList *spectrumIdentificationProtocolElements)
AASequence parsePeptideSiblings_(xercesc::DOMElement *peptide)
String name
Definition: MzIdentMLDOMHandler.h:184
std::multimap< String, String > p_pv_map_
mapping Peptide id -> PeptideEvidence id, multiple PeptideEvidences can have equivalent Peptides.
Definition: MzIdentMLDOMHandler.h:272
void buildInputDataCollection_(xercesc::DOMElement *inputElements)
void writeMzIdentMLFile(const std::string &mzid_file)
Provides the functionality to write a mzid with a handler object.
xercesc::XercesDOMParser mzid_parser_
Definition: MzIdentMLDOMHandler.h:248
CVTermList threshold_cvs
Definition: MzIdentMLDOMHandler.h:232
String fixed_mod
Definition: MzIdentMLDOMHandler.h:215
String accession
Definition: MzIdentMLDOMHandler.h:201
CVTermList specificities
Definition: MzIdentMLDOMHandler.h:219
char pre
Definition: MzIdentMLDOMHandler.h:192
String residues
Definition: MzIdentMLDOMHandler.h:217
std::map< String, DataValue > threshold_ups
Definition: MzIdentMLDOMHandler.h:233
std::pair< CVTermList, std::map< String, DataValue > > parseParamGroup_(xercesc::DOMNodeList *paramGroup)
CVTermList cvs
Definition: MzIdentMLDOMHandler.h:202
std::map< String, AASequence > pep_map_
mapping Peptide id -> Sequence
Definition: MzIdentMLDOMHandler.h:269
void parseAnalysisSoftwareList_(xercesc::DOMNodeList *analysisSoftwareElements)
MzIdentMLDOMHandler(const std::vector< ProteinIdentification > &pro_id, const std::vector< PeptideIdentification > &pep_id, const String &version, const ProgressLogger &logger)
Constructor for a write-only handler for internal identification structures.
MzIdentMLDOMHandler(std::vector< ProteinIdentification > &pro_id, std::vector< PeptideIdentification > &pep_id, const String &version, const ProgressLogger &logger)
Constructor for a read-only handler for internal identification structures.
std::list< std::list< String > > hit_pev_
writing help only
Definition: MzIdentMLDOMHandler.h:275
const std::vector< PeptideIdentification > * cpep_id_
Internal -w Identification Item for peptides.
Definition: MzIdentMLDOMHandler.h:133
MzIdentMLDOMHandler(const MzIdentMLDOMHandler &rhs)
std::map< String, SignedSize > xl_donor_pos_map_
mapping donor value -> cross-link modification location
Definition: MzIdentMLDOMHandler.h:281
std::map< String, SpectrumIdentificationProtocol > sp_map_
mapping SpectrumIdentificationProtocol id -> SpectrumIdentificationProtocol
Definition: MzIdentMLDOMHandler.h:266
CVTermList modification_parameter
Definition: MzIdentMLDOMHandler.h:229
void buildCvList_(xercesc::DOMElement *cvElements)
std::map< String, DataValue > parameter_ups
Definition: MzIdentMLDOMHandler.h:227
void buildSequenceCollection_(xercesc::DOMElement *sequenceCollectionElements)
void parseSpectrumIdentificationListElements_(xercesc::DOMNodeList *spectrumIdentificationListElements)
void parseDBSequenceElements_(xercesc::DOMNodeList *dbSequenceElements)
char post
Definition: MzIdentMLDOMHandler.h:193
void buildAnalysisProtocolCollection_(xercesc::DOMElement *protocolElements)
std::map< String, String > xl_id_acceptor_map_
mapping peptide id of acceptor peptide -> cross-link acceptor value
Definition: MzIdentMLDOMHandler.h:280
String spectrum_identification_protocol_ref
Definition: MzIdentMLDOMHandler.h:209
XMLCh * xml_name_attr_ptr_
Definition: MzIdentMLDOMHandler.h:246
virtual ~MzIdentMLDOMHandler()
Destructor.
String spectra_data_ref
Definition: MzIdentMLDOMHandler.h:207
const String schema_version_
Internal version keeping.
Definition: MzIdentMLDOMHandler.h:136
void parsePeptideElements_(xercesc::DOMNodeList *peptideElements)
Struct to hold the used analysis software for that file.
Definition: MzIdentMLDOMHandler.h:183
Struct to hold the information from the DBSequence xml tag.
Definition: MzIdentMLDOMHandler.h:198
Struct to hold the information from the DatabaseInput xml tag.
Definition: MzIdentMLDOMHandler.h:237
Struct to hold the information from the ModificationParam xml tag.
Definition: MzIdentMLDOMHandler.h:214
Struct to hold the PeptideEvidence information.
Definition: MzIdentMLDOMHandler.h:189
Struct to hold the information from the SpectrumIdentification xml tag.
Definition: MzIdentMLDOMHandler.h:206
Struct to hold the information from the SpectrumIdentificationProtocol xml tag.
Definition: MzIdentMLDOMHandler.h:223
Represents the peptide hits for a spectrum.
Definition: PeptideIdentification.h:65
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:53
Representation of a protein identification run.
Definition: ProteinIdentification.h:76
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
Representation of a CV term.
Definition: ControlledVocabulary.h:61
Search parameters of the DB search.
Definition: ProteinIdentification.h:273