urn_query_service.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2017-03-07
 * Last modified: 2018-03-23
 *
 * License:
 *
 * Copyright (C) 2017-2018 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 query service.
 *
 */

#ifndef DATATOOLS_URN_QUERY_SERVICE_H
#define DATATOOLS_URN_QUERY_SERVICE_H

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

// Third party:
#include <boost/noncopyable.hpp>

// This project:
#include <datatools/base_service.h>
#include <datatools/urn_info.h>

namespace datatools {

  class urn_db_service;
  class urn_to_path_resolver_service;
  class dependency_graph;

  class urn_query_service
    : public ::datatools::base_service
    , private boost::noncopyable
  {
  public:

    urn_query_service();

    virtual ~urn_query_service();

    virtual bool is_initialized() const;

    virtual int initialize(const datatools::properties & config_,
                           datatools::service_dict_type & services_);

    virtual int reset();

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

    bool check_urn_info(const std::string & urn_,
                        const std::string & category_ = "") const;

    bool find_urn_info(std::vector<std::string> & urn_list_,
                       const std::string & urn_db_regex_ = "",
                       const std::string & urn_regex_ = "",
                       const std::string & urn_category_regex_ = "",
                       bool clear_ = true) const;

    const urn_info & get_urn_info(const std::string & urn_) const;

    bool find_urn_to_path(std::vector<std::string> & urn_path_list_,
                          const std::string & urn_resolver_regex_ = "",
                          const std::string & urn_regex_ = "",
                          const std::string & urn_category_regex_ = "",
                          const std::string & urn_mime_regex_ = "",
                          bool clear_ = true) const;

    bool check_urn_to_path(const std::string & urn_) const;

    bool resolve_urn_to_path(const std::string & urn_,
                             std::string & category_,
                             std::string & mime_,
                             std::string & path_) const;

    bool get_urn_to_path(const std::string & urn_,
                         std::string & category_,
                         std::string & mime_,
                         std::string & path_) const;

    bool has_db(const std::string & name_) const;

    bool has_db(const urn_db_service &) const;

    const urn_db_service & get_db(const std::string & name_) const;

    void build_list_of_dbs(std::set<std::string> & dbs_) const;

    void add_db(const urn_db_service &);

    void add_db(const urn_db_service &, const std::string & name_);

    void remove_db(const urn_db_service &);

    void remove_db(const std::string & name_);

    bool has_path_resolver(const std::string & name_) const;

    void build_list_of_path_resolvers(std::set<std::string> & prs_) const;

    bool has_path_resolver(const urn_to_path_resolver_service &) const;

    const urn_to_path_resolver_service & get_path_resolver(const std::string & name_) const;

    void add_path_resolver(const urn_to_path_resolver_service &);

    void add_path_resolver(const urn_to_path_resolver_service &,
                           const std::string & name_);

    void remove_path_resolver(const urn_to_path_resolver_service &);

    void remove_path_resolver(const std::string & name_);

    const dependency_graph & get_dependency_graph() const;

    void update_dependency_graph();

  private:

    void _build_dependency_graph_();

    void _dependency_graph_process_db(const urn_db_service * db_,
                                      std::set<const urn_db_service*> & processed_dbs_);

  private:

    // Management:
    bool _initialized_ = false; 

    // Private implementation:
    struct pimpl_type;
    std::unique_ptr<pimpl_type>       _pimpl_;  
    std::unique_ptr<dependency_graph> _dg_ptr_; 

    // Service registration
    DATATOOLS_SERVICE_REGISTRATION_INTERFACE(urn_query_service)

  };

} // end of namespace datatools

#endif // DATATOOLS_URN_QUERY_SERVICE_H

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