urn_info.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2017-03-06
 * Last modified: 2017-03-06
 *
 * License:
 *
 * Copyright (C) 2017 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   URN information node structure.
 *
 */

#ifndef DATATOOLS_URN_INFO_H
#define DATATOOLS_URN_INFO_H

// Standard Library:
#include <string>
#include <vector>
#include <map>

// Datatools:
#include <datatools/i_serializable.h>
#include <datatools/i_tree_dump.h>
#include <datatools/properties.h>

namespace datatools {

  class urn_info
    : public datatools::i_serializable
    , public datatools::i_tree_dumpable
  {
  public:

    typedef std::map<std::string, std::vector<std::string> > component_topic_dict_type;

    static bool validate_urn(const std::string &);

    static bool validate_category(const std::string &);

    static bool validate_topic(const std::string &);

    static const std::string & anonymous_topic();

    urn_info();

    urn_info(const std::string & urn_,
             const std::string & category_,
             const std::string & description_ = "");

    virtual ~urn_info();

    bool is_valid() const;


    void initialize(const properties &);

    void reset();

    void set_urn(const std::string & urn_);

    const std::string & get_urn() const;

    bool has_category() const;

    void set_category(const std::string & category_);

    const std::string & get_category() const;

    void set_description(const std::string & description_);

    bool has_description() const;

    const std::string & get_description() const;

    void lock();

    void unlock();

    bool is_locked() const;

    void remove_all_components();

    bool has_component(const std::string & comp_urn_) const;

    bool has_component_in_topic(const std::string & comp_urn_,
                                const std::string & comp_topic_) const;

    void add_component(const std::string & comp_urn_,
                       const std::string & comp_topic_ = "");

    void remove_component(const std::string & comp_urn_);

    bool has_components() const;

    std::size_t get_number_of_components() const;

    std::size_t get_number_of_components_by_topic(const std::string & comp_topic_) const;

    std::string get_component(const std::string & comp_topic_, int rank_ = 0) const;

    bool has_topic(const std::string & comp_topic_) const;

    const std::vector<std::string> &
    get_components_by_topic(const std::string & comp_topic_) const;

    void build_topics(std::vector<std::string> &) const;

    std::vector<std::string> get_topics() const;

    virtual void tree_dump(std::ostream& out = std::clog,
                           const std::string& title  = "",
                           const std::string& indent = "",
                           bool inherit = false) const;

    bool operator<(const urn_info & other_) const;

  private:

    // Management:
    bool _locked_ = false; 

    // Configuration:
    std::string _urn_;         
    std::string _category_;    
    std::string _description_; 
    component_topic_dict_type _components_; 

    DATATOOLS_SERIALIZATION_DECLARATION_ADVANCED(urn_info)

  };

} // end of namespace datatools

#endif // DATATOOLS_URN_INFO_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --