IdXMLFile.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <unordered_map>
 
#include <OpenMS/CONCEPT/ProgressLogger.h>
#include <OpenMS/METADATA/ProteinIdentification.h>
#include <OpenMS/METADATA/PeptideIdentification.h>
#include <OpenMS/METADATA/PeptideIdentificationList.h>
#include <OpenMS/FORMAT/HANDLERS/XMLHandler.h>
#include <OpenMS/FORMAT/XMLFile.h>
 
#include <functional>
#include <iosfwd>
#include <vector>
 
namespace OpenMS
{
  namespace Internal
  {
    class FeatureXMLHandler;
    class ConsensusXMLHandler;
  }
  class OPENMS_DLLAPI IdXMLFile :
    protected Internal::XMLHandler,
    public Internal::XMLFile,
    public ProgressLogger
  {
public:
    // both ConsensusXMLFile and FeatureXMLFile use some protected IdXML helper functions to parse identifications without code duplication
    friend class Internal::ConsensusXMLHandler;
    friend class Internal::FeatureXMLHandler;
 
    IdXMLFile();
 
    void load(const std::string& filename, std::vector<ProteinIdentification>& protein_ids, PeptideIdentificationList& peptide_ids);
 
    void load(const std::string& filename, std::vector<ProteinIdentification>& protein_ids, PeptideIdentificationList& peptide_ids, std::string& document_id);
 
    void store(const std::string& filename, const std::vector<ProteinIdentification>& protein_ids, const PeptideIdentificationList& peptide_ids, const std::string& document_id = "");
 
 
protected:
    void storeFile_(const std::string& filename, const std::vector<ProteinIdentification>& protein_ids, const PeptideIdentificationList& peptide_ids, const std::string& document_id);
 
    // Docu in base class
    void onEndElement(const char16_t* qname) override;
 
    // Docu in base class
    void onStartElement(const char16_t* qname, const Internal::XMLAttributes& attributes) override;
 
    void addProteinGroups_(MetaInfoInterface& meta, const std::vector<ProteinIdentification::ProteinGroup>& groups,
                           const std::string& group_name, const std::unordered_map<std::string, UInt>& accession_to_id, XMLHandler::ActionMode mode);
 
    void getProteinGroups_(std::vector<ProteinIdentification::ProteinGroup>& groups, const std::string& group_name);
 
    static std::ostream& createFlankingAAXMLString_(const std::vector<PeptideEvidence> & pes, std::ostream& os);
 
    static std::ostream& createPositionXMLString_(const std::vector<PeptideEvidence> & pes, std::ostream& os);
 
 
    static void writeFragmentAnnotations_(const std::string & tag_name, std::ostream & os, 
                                          const std::vector<PeptideHit::PeakAnnotation>& annotations, UInt indent);
 
    static void parseFragmentAnnotation_(const std::string& s, std::vector<PeptideHit::PeakAnnotation> & annotations);
 
    static void formatBlock_(std::ostream& block_os, const std::function<void(std::ostream&)>& write);
 
 
 
 
    std::vector<ProteinIdentification>* prot_ids_;
    PeptideIdentificationList* pep_ids_;
    MetaInfoInterface* last_meta_;
    std::map<std::string, ProteinIdentification::SearchParameters> parameters_;
    ProteinIdentification::SearchParameters param_;
    std::string id_;
    ProteinIdentification prot_id_;
    PeptideIdentification pep_id_;
    ProteinHit prot_hit_;
    PeptideHit pep_hit_;
    PeptideHit::PepXMLAnalysisResult current_analysis_result_;
    std::vector<PeptideEvidence> peptide_evidences_;
    std::unordered_map<std::string, std::string> proteinid_to_accession_;
    std::unordered_map<std::string, std::string> proteinid_to_run_;
    std::string* document_id_;
    bool prot_id_in_run_;
  };
 
} // namespace OpenMS