MetadataDefinitions.h

#ifndef _METADATADEFINITIONS_H_
#define _METADATADEFINITIONS_H_
#include <string>
#include <map>
#include <tuple>
#include <list>
#include "mspass/utility/Metadata.h"
namespace mspass {
namespace utility {
using mspass::utility::MDtype;
enum class MDDefFormat { PF, YAML };
 
class MetadataDefinitions {
public:
  MetadataDefinitions();
  MetadataDefinitions(const std::string mdname);
  MetadataDefinitions(const std::string mdname,
                      const mspass::utility::MDDefFormat form);
  MetadataDefinitions(const MetadataDefinitions &parent);
  bool is_defined(const std::string key) const noexcept;
  std::string concept(const std::string key) const;
  mspass::utility::MDtype type(const std::string key) const;
  std::list<std::string> keys() const;
  void add(const std::string key, const std::string concept_, const MDtype mdt);
  bool has_alias(const std::string key) const;
  bool is_alias(const std::string key) const;
  std::list<std::string> aliases(const std::string key) const;
  std::pair<std::string, mspass::utility::MDtype>
  unique_name(const std::string aliasname) const;
  void add_alias(const std::string key, const std::string aliasname);
  bool writeable(const std::string key) const;
  bool readonly(const std::string key) const;
  void set_readonly(const std::string key);
  void set_writeable(const std::string key);
  bool is_normalized(const std::string key) const;
  std::string unique_id_key(const std::string key) const;
  std::string collection(const std::string key) const;
  std::pair<std::string, std::string>
  normalize_data(const std::string key) const;
  std::list<std::string> apply_aliases(mspass::utility::Metadata &d,
                                       const std::list<std::string> aliaslist);
  void clear_aliases(mspass::utility::Metadata &d);
  MetadataDefinitions &operator=(const MetadataDefinitions &other);
  MetadataDefinitions &operator+=(const MetadataDefinitions &other);
 
private:
  std::map<std::string, MDtype> tmap;
  std::map<std::string, std::string> cmap;
  std::multimap<std::string, std::string> aliasmap;
  std::map<std::string, std::string> alias_xref;
  std::set<std::string> roset;
  /* This map is used to handle normalized data in any database.   For the
  initial design the data could be a pair, but I make it a tuple because I
  can conveive extensions that would require additional information to provides
  a unique index definition.   e.g.  the antelope indexing of
  sta,chan,time:endtime.
  */
  std::map<std::string, std::tuple<std::string, std::string>> unique_id_data;
  void pfreader(const std::string pfname);
  void yaml_reader(const std::string fname);
};
} // namespace utility
} // namespace mspass
#endif