SemanticValidator.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, Andreas Bertsch $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/FORMAT/XMLFile.h>
#include <OpenMS/FORMAT/HANDLERS/XMLHandler.h>
#include <OpenMS/DATASTRUCTURES/CVMappings.h>
#include <map>
 
 
namespace OpenMS
{
  class ControlledVocabulary;
  namespace Internal
  {
 
    class OPENMS_DLLAPI SemanticValidator :
      protected Internal::XMLHandler,
      public Internal::XMLFile
    {
public:
      SemanticValidator(const CVMappings & mapping, const ControlledVocabulary & cv);
 
      ~SemanticValidator() override;
 
      struct CVTerm
      {
        std::string accession;
        std::string name;
        std::string value;
        bool has_value{};
        std::string unit_accession;
        bool has_unit_accession{};
        std::string unit_name;
        bool has_unit_name{};
      };
 
      bool validate(const std::string & filename, StringList & errors, StringList & warnings);
 
      bool locateTerm(const std::string & path, const CVTerm & parsed_term) const;
 
      void setTag(const std::string & tag);
 
      void setAccessionAttribute(const std::string & accession);
 
      void setNameAttribute(const std::string & name);
 
      void setValueAttribute(const std::string & value);
 
      void setCheckTermValueTypes(bool check);
 
      void setCheckUnits(bool check);
 
      void setUnitAccessionAttribute(const std::string & accession);
 
      void setUnitNameAttribute(const std::string & name);
 
protected:
 
      // 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 endElement(const XMLCh * const /*uri*/, const XMLCh * const /*local_name*/, const XMLCh * const qname) override;
 
      // Docu in base class
      void characters(const XMLCh * const chars, const XMLSize_t /*length*/) override;
 
      virtual std::string getPath_(UInt remove_from_end = 0) const;
 
      virtual void getCVTerm_(const xercesc::Attributes & attributes, CVTerm & parsed_term);
 
      //~ forward dekl. of a inner struct/class not possible in C++ - or our Library is overtemplated
      //~ /// make a SemanticValidator::CVTerm from a ControlledVocabulary::CVTerm (without any value or unit), needed for writing only cvs at the right places in the xml (i.e. with cvmapping)
      //~ virtual void makeCVTerm_(const ControlledVocabulary::CVTerm & lc, CVTerm & parsed_term);
 
      virtual void handleTerm_(const std::string & path, const CVTerm & parsed_term);
 
      const CVMappings & mapping_;
 
      const ControlledVocabulary & cv_;
 
      StringList errors_;
 
      StringList warnings_;
 
      StringList open_tags_;
 
      std::map<std::string, std::vector<CVMappingRule> > rules_;
 
      std::map<std::string, std::map<std::string, std::map<std::string, UInt> > > fulfilled_;
 
 
 
      std::string cv_tag_;
      std::string accession_att_;
      std::string name_att_;
      std::string value_att_;
      std::string unit_accession_att_;
      std::string unit_name_att_;
      bool check_term_value_types_;
      bool check_units_;
 
private:
 
      SemanticValidator();
 
      SemanticValidator(const SemanticValidator & rhs);
 
      SemanticValidator & operator=(const SemanticValidator & rhs);
 
    };
 
  }   // namespace Internal
 
} // namespace OpenMS