CatalogItem.h

// -*- mode: c++; c-basic-offset:4 -*-
 
// This file is part of the OPeNDAP Back-End Server (BES)
 
// Copyright (c) 2018 OPeNDAP, Inc.
// Author: James Gallagher <jgallagher@opendap.org>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
 
#ifndef I_CatalogItem_h
#define I_CatalogItem_h 1
 
#include <string>
#include <ostream>
#include <utility>
 
#include "BESObj.h"
 
class BESInfo;
 
namespace bes {
 
#if 0
Class Node {
    Name
    LMT
    Item_count (number of nodes or leaves it holds)
    Items (zero or more Item instances)
 
    Class Item {
        Name
        Size
        Type (node or leaf)
        Is_data
        LMT
    }
}
#endif

class CatalogItem: public BESObj {
public:
    enum item_type {unknown, node, leaf};
 
private:
    std::string d_name;
    size_t d_size{0};
    std::string d_lmt;
    bool d_is_data{false};
    item_type d_type;
    std::string d_description;
    std::string d_dap_service_url;
 
    CatalogItem(const CatalogItem &rhs);
    CatalogItem &operator=(const CatalogItem &rhs);
 
public:
    CatalogItem() : d_type(unknown) { }

    CatalogItem(const std::string &name, size_t size, const std::string &lmt, item_type type)
        : d_name(name), d_size(size), d_lmt(lmt), d_type(type) { }

    CatalogItem(const std::string &name, size_t size, const std::string &lmt, bool is_data, item_type type)
        : d_name(name), d_size(size), d_lmt(lmt), d_is_data(is_data), d_type(type) { }
 
    virtual ~CatalogItem() { }
 
    struct CatalogItemAscending {
      bool operator() (CatalogItem *i,CatalogItem *j) { return (i->d_name < j->d_name); }
    };

    std::string get_name() const { return d_name; }
    void set_name(const std::string &n) { d_name = n; }

    std::string get_description() const { return d_description; }
    void set_description(const std::string &n) { d_description = n; }

    size_t get_size() const { return d_size; }
    void set_size(size_t s) { d_size = s; }

    std::string get_lmt() const { return d_lmt; }
    void set_lmt(const std::string &lmt) { d_lmt = lmt; }

    bool is_data() const { return d_is_data; }
    void set_is_data(bool id) { d_is_data = id; }

    std::string get_dap_service_url() const { return d_dap_service_url; }
    void set_dap_service_url( const std::string &url) { d_dap_service_url = url; }

    item_type get_type() const { return d_type; }
    void set_type(item_type t) { d_type = t; }
 
    void encode_item(BESInfo *info) const;
 
    virtual void dump(std::ostream &strm) const;
};
 
} // namespace bes
 
#endif // I_BESCatalogItem_h