urn_to_path.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2017-03-10
 * Last modified: 2017-03-10
 *
 * 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 to path association record.
 *
 */

#ifndef DATATOOLS_URN_TO_PATH_H
#define DATATOOLS_URN_TO_PATH_H

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

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

namespace datatools {

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

    urn_to_path();

    urn_to_path(const std::string & urn_,
                const std::string & path_,
                const std::string & category_ = "",
                const std::string & mime_ = "");

    urn_to_path(const std::string & urn_,
                const std::string & category_,
                const std::string & mime_,
                const std::vector<std::string> & paths_);

    virtual ~urn_to_path();

    bool is_valid() const;

    void reset();

    bool has_urn() const;

    void set_urn(const std::string &);

    const std::string & get_urn() const;

    bool has_single_path() const;

    bool has_path() const;

    bool has_path_by_value(const std::string &) const;

    void set_path(const std::string & path_);

    const std::string & get_path() const;

    std::size_t get_number_of_paths() const;

    const std::string & get_path_by_index(const std::size_t index_ = 0) const;

    void add_path(const std::string &, bool preprend_ = false);

    void clear_paths();

    bool has_category() const;

    void set_category(const std::string &);

    const std::string & get_category() const;

    void reset_category();

    bool has_mime() const;

    void set_mime(const std::string &);

    const std::string & get_mime() const;

    void reset_mime();

    virtual void tree_dump (std::ostream & out_ = std::clog,
                            const std::string & title_  = "",
                            const std::string & indent_ = "",
                            bool inherit_ = false) const;

  private:

    std::string _urn_;      
    std::string _category_; 
    std::string _mime_;     
    std::vector<std::string> _paths_; 

    DATATOOLS_SERIALIZATION_DECLARATION_ADVANCED(urn_to_path)

  };

} // end of namespace datatools

#endif // DATATOOLS_URN_TO_PATH_H

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