FeatureXMLHandler.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// 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,
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// 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: Chris Bielow $
// $Authors: Marc Sturm, Chris Bielow, Clemens Groepl $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/FORMAT/OPTIONS/FeatureFileOptions.h>
#include <OpenMS/FORMAT/XMLFile.h>
#include <OpenMS/FORMAT/HANDLERS/XMLHandler.h>
#include <OpenMS/CONCEPT/ProgressLogger.h>
#include <OpenMS/METADATA/ProteinIdentification.h>
#include <OpenMS/METADATA/PeptideIdentification.h>
#include <OpenMS/DATASTRUCTURES/ConvexHull2D.h>
#include <OpenMS/DATASTRUCTURES/Param.h>

#include <iosfwd>
#include <map>

namespace OpenMS
{
  class Feature;
  class FeatureMap;

  namespace Internal
  {

  class OPENMS_DLLAPI FeatureXMLHandler :
    public Internal::XMLHandler,
    public ProgressLogger
  {

public:

    FeatureXMLHandler(FeatureMap& map, const String& filename);
    FeatureXMLHandler(const FeatureMap& map, const String& filename);
    ~FeatureXMLHandler() override;


    void writeTo(std::ostream& os) override;

    FeatureFileOptions& getOptions();

    const FeatureFileOptions& getOptions() const;

    void setOptions(const FeatureFileOptions&);

    void setSizeOnly(const bool size_only)
    {
      size_only_ = size_only;
    }

    Size getSize() const
    {
      return expected_size_;
    }

protected:

    // restore default state for next load/store operation
    void resetMembers_();

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

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

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

    void writeFeature_(const String& filename, std::ostream& os, const Feature& feat, const String& identifier_prefix, UInt64 identifier, UInt indentation_level);

    void writePeptideIdentification_(const String& filename, std::ostream& os, const PeptideIdentification& id, const String& tag_name, UInt indentation_level);

    void updateCurrentFeature_(bool create);

    Int disable_parsing_;

    Feature* current_feature_;
    FeatureMap* map_;
    const FeatureMap* cmap_;
    FeatureFileOptions options_;
    bool size_only_;
    Size expected_size_;

    Param param_;
    ConvexHull2D::PointArrayType current_chull_;
    DPosition<2> hull_position_;

    UInt dim_;

    bool in_description_;

    Int subordinate_feature_level_;

    MetaInfoInterface* last_meta_;

    ProteinIdentification prot_id_;
    PeptideIdentification pep_id_;
    ProteinHit prot_hit_;
    PeptideHit pep_hit_;
    std::map<String, String> proteinid_to_accession_;
    std::map<String, Size> accession_to_id_;
    std::map<String, String> identifier_id_;
    std::map<String, String> id_identifier_;
    ProteinIdentification::SearchParameters search_param_;

  };

} // namespace Internal
} // namespace OpenMS