libopenms-dev 1.11.1-5 / usr / include / OpenMS / FORMAT / QcMLFile.h

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Mathias Walzer $
// $Authors: Mathias Walzer $
// --------------------------------------------------------------------------

#ifndef OPENMS_FORMAT_QCMLFILE_H
#define OPENMS_FORMAT_QCMLFILE_H

#include <OpenMS/CONCEPT/ProgressLogger.h>
#include <OpenMS/FORMAT/HANDLERS/XMLHandler.h>
#include <OpenMS/FORMAT/XMLFile.h>
#include <OpenMS/CONCEPT/UniqueIdGenerator.h>

#include <vector>
#include <map>
#include <set>
#include <algorithm>

namespace OpenMS
{
  /**
      @brief File adapter for QcML files

      This Class is supposed to internally collect the data for the qcML File

      @ingroup FileIO
  */
  class OPENMS_DLLAPI QcMLFile :
    public Internal::XMLHandler,
    public Internal::XMLFile,
    public ProgressLogger
  {
public:
    /// Representation of a quality parameter
    struct OPENMS_DLLAPI QualityParameter
    {
      String name; ///< Name
      String id; ///< Identifier
      String value; ///< Value
      String cvRef; ///< cv reference
      String cvAcc; ///< cv accession
      String unitRef; ///< cv reference of the unit
      String unitAcc; ///< cv accession of the unit
      String flag; ///< cv accession of the unit

      ///Default constructor
      QualityParameter();

      QualityParameter(const QualityParameter& rhs);

      QualityParameter& operator=(const QualityParameter& rhs);
      bool operator==(const QualityParameter& rhs) const;
      bool operator<(const QualityParameter& rhs) const;
      bool operator>(const QualityParameter& rhs) const;

      String toXMLString(UInt indentation_level) const;
    };

    /// Representation of an attachment
    struct OPENMS_DLLAPI Attachment
    {
      String name; ///< Name
      String id; ///< Name
      String value; ///< Value
      String cvRef; ///< cv reference
      String cvAcc; ///< cv accession
      String unitRef; ///< cv reference of the unit
      String unitAcc; ///< cv accession of the unit
      String binary; ///< binary content of the attachment
      String qualityRef; ///< reference to qp to which attachment, if empty attached to run/set
      std::vector<String> colTypes; ///< type of the cols if QP has a table of values
      std::vector< std::vector<String> > tableRows; ///< cell values if QP has a table, type see colType
      //~ TODO -schema- coltypes with full definition (uintRef, unitAcc)

      ///Default constructor
      Attachment();

      Attachment(const Attachment& rhs);

      Attachment& operator=(const Attachment& rhs);
      bool operator==(const Attachment& rhs) const;
      bool operator<(const Attachment& rhs) const;
      bool operator>(const Attachment& rhs) const;

      String toXMLString(UInt indentation_level) const;
      String toCSVString(String separator) const;
    };

    ///Default constructor
    QcMLFile();
    ///Destructor
    ~QcMLFile();

    String map2csv(const std::map< String, std::map<String, String> >& cvs_table, const String& separator) const;
    String exportIDstats(const String& filename) const;
    
    ///Registers a run in the qcml file with the respective mappings
    void registerRun(const String id, const String name);
    ///Registers a set in the qcml file with the respective mappings
    void registerSet(const String id, const String name, const std::set<String>& names);
    ///Just adds a qualityparameter to run by the name r
    void addRunQualityParameter(String r, QualityParameter qp);
    ///Just adds a attachment to run by the name r
    void addRunAttachment(String r, Attachment at);
    ///Just adds a qualityparameter to set by the name r
    void addSetQualityParameter(String r, QualityParameter qp);
    ///Just adds a attachment to set by the name r
    void addSetAttachment(String r, Attachment at);
    ///Removes attachments referencing a id given in ids, from run/set r. All attachments if no attachment name is given with at.
    void removeAttachment(String r, std::vector<String>& ids, String at = "");
    ///Removes attachment with cv accession at from run/set r.
    void removeAttachment(String r, String at);
    ///Removes attachment with cv accession at from  all runs/sets.
    void removeAllAttachments(String at);
    ///Just removes qualityparameter going by one of the ID attributes given in ids.
    void removeQualityParameter(String r, std::vector<String>& ids);
    ///merges the given QCFile into this one
    void merge(const QcMLFile & addendum, String setname = "");
    ///collects the values of given QPs (as CVid) of the given set
    void/* std::vector<String>& */ collectSetParameter(const String setname, const String qp, std::vector<String>& ret);
    ///Returns a String of a tab separated rows if found empty string else from run/set by the name filename of the qualityparameter by the name qpname
    String exportAttachment(const String filename, const String qpname) const; 
    ///Returns a String value in qutation of a qualityparameter by the name qpname in run/set by the name filename
    String exportQP(const String filename, const String qpname) const;
    ///Returns a String of a tab separated qualityparameter by the name qpname in run/set by the name filename
    String exportQPs(const String filename, const StringList qpnames) const;
    ///Gives the ids of the registered runs in the vector ids.
    void getRunIDs (std::vector<String>& ids) const;
    ///Gives the names of the registered runs in the vector ids.
    void getRunNames (std::vector<String>& ids) const;
    ///Returns true if the given run id is present in this file, if checkname is true it also checks the names
    bool existsRun(const String filename, bool checkname = false) const;
    ///Returns true if the given set id is present in this file, if checkname is true it also checks the names
    bool existsSet(const String filename, bool checkname = false) const;
    ///Returns the ids of the parameter name given if found in given run empty else
    void existsRunQualityParameter(const String filename, const String qpname, std::vector<String>& ids) const;
    ///Returns the ids of the parameter name given if found in given set, empty else
    void existsSetQualityParameter(const String filename, const String qpname, std::vector<String>& ids) const;
    ///Store the QCFile
    void store(const String & filename) const;
    ///Load a QCFile
    void load(const String & filename);

    //~ int siz; //debug

protected:
    // Docu in base class
    virtual void endElement(const XMLCh * const /*uri*/, const XMLCh * const /*local_name*/, const XMLCh * const qname);

    // Docu in base class
    virtual void startElement(const XMLCh * const /*uri*/, const XMLCh * const /*local_name*/, const XMLCh * const qname, const xercesc::Attributes & attributes);

    // Docu in base class
    virtual void characters(const XMLCh * const chars, const XMLSize_t length);

    std::map<String, std::vector< QualityParameter > > runQualityQPs_; //TODO run name attribute to schema of RunQuality
    std::map<String, std::vector< Attachment > > runQualityAts_;
    std::map<String, std::vector< QualityParameter > > setQualityQPs_;
    std::map<String, std::vector< Attachment > > setQualityAts_;
    std::map<String, std::set< String > > setQualityQPs_members_;
    std::map<String, String > run_Name_ID_map_;
    std::map<String, String > set_Name_ID_map_;

    String tag_;
    UInt progress_;
    QualityParameter qp_;
    Attachment at_;
    std::vector<String> row_;
    std::vector<String> header_;
    String name_;
    String run_id_;
    std::set<String> names_;
    std::vector<QualityParameter> qps_;
    std::vector<Attachment> ats_;

  };

} // namespace OpenMS

#endif // OPENMS_FORMAT_QCMLFILE_H