namelist.h

Go to the documentation of this file.

// OSB library ************************************************ -*- C++ -*-
/*
  AUTHOR(S): Stephan Broennimann (vb)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.9 $

  License
   OSB rating and billing library for communication networks
   Copyright (C) 2004, 2005, 2006  OSB systems

   This file may be distributed and/or modify under the terms of the
   GNU General Public License (GPL) as published by the Free Software
   Foundation which is provided in the file LICENSE.GPL included in the
   packaging of this file.

   The file 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.

   Holders of a OSB Commercial License may use this file under the terms
   and conditions of this commercial license.
 */
#ifndef _NAMELIST_H_
#define _NAMELIST_H_

// ************************************************************************
// included header files
#include "namelistfwd.h"

// + standard includes
#include <string>
#include <map>

// + libraries

// + local headers

// + class declarations
namespace OSB_DB {
    class Session;
}

// ************************************************************************
// namespace extensions
namespace OSB_LIB {

// ************************************************************************
// forward declarations

// ************************************************************************
// type definitions

// ************************************************************************
// class definitions
    template<typename Key, typename Comp>
    class NameList {
    public:
        typedef Key KeyType;

        struct Entry {
            explicit Entry(
                const std::string& name = "",
                const std::string& des  = ""
            );
            std::string name_;
            std::string des_;
        };                              // struct Entry

        typedef std::map<KeyType, Entry, Comp> Cont;

    public:
        NameList();
        NameList(const NameList& rhs);
        NameList& operator=(const NameList& rhs);
        ~NameList();



        const Entry& get(const Key& key) const;
        const std::string& name(const Key& key) const;
        const std::string& des(const Key& key) const;
        const Cont& entries() const;



        void clear();
        Entry& operator[](const Key& key);
        void setNullEntry(
            const Entry& nullEntry
        );

    private:
        const Entry* nullEntry() const;

    private:
        Cont entries_;
        mutable Entry* nullEntry_;
    };                                  // class NameList

    struct NameListReader {
    public:
        struct Row {
            Row();
            void reset();

            long id1_;
            long id2_;
            std::string name_;
            std::string des_;
        };                              // struct Row
    public:


        std::string table_;
        std::string colId1_;
        std::string colId2_;
        std::string colName_;
        std::string colDes_;

        void read(
            const OSB_DB::Session& session
        );

        virtual void addRow(
            const Row& row
        ) = 0;

    public:
        NameListReader();
        virtual ~NameListReader();

    protected:
        NameListReader(const NameListReader& rhs);
        NameListReader& operator=(const NameListReader& rhs);
    };                                  // struct NameListReader

    template<typename NameList>
    struct Id1InfoReader : public NameListReader {
        Id1InfoReader(
            const std::string& table,
            const std::string& colId1,
            const std::string& colName = "NAME",
            const std::string& colDes  = "DES"
        );

        void read(
            const OSB_DB::Session& session,
                  NameList&        dest
        );

        void addRow(const Row& row);
    private:
        NameList* namelist_;
    };                                  // struct Id1InfoReader

    template<typename NameList>
    struct Id2InfoReader : public NameListReader {
        Id2InfoReader(
            const std::string& table,
            const std::string& colId1,
            const std::string& colId2,
            const std::string& colName = "NAME",
            const std::string& colDes  = "DES"
        );

        void read(
            const OSB_DB::Session& session,
                  NameList&        dest
        );

        void addRow(const Row& row);
    private:
        NameList* namelist_;
    };                                  // struct Id2InfoReader
}                                       // namespace OSB_LIB

// ************************************************************************
// inline definitions
namespace OSB_LIB {
    // ********************************************************************
    // struct NameList:Entry
    template<typename Key, typename Comp>
    NameList<Key, Comp>::Entry::Entry(
        const std::string& name,
        const std::string& des
    ) : name_(name), des_(des)
    {
        // empty
    }

    // ********************************************************************
    // class NameList {
    template<typename Key, typename Comp>
    NameList<Key, Comp>::NameList()
      : nullEntry_(0)
    {
        // empty
    }

    template<typename Key, typename Comp>
    NameList<Key, Comp>::NameList(const NameList& rhs)
      : nullEntry_(0)
    {
        if (0 != rhs.nullEntry_) {
            setNullEntry(*rhs.nullEntry_);
        }
    }

    template<typename Key, typename Comp>
    NameList<Key, Comp>& NameList<Key, Comp>::operator=(
        const NameList& rhs
    )
    {
        if (this == &rhs) return;

        delete nullEntry_;
        nullEntry_ = 0;

        if (0 != rhs.nullEntry_) {
            setNullEntry(*rhs.nullEntry_);
        }
    }

    template<typename Key, typename Comp>
    NameList<Key, Comp>::~NameList()
    {
        delete nullEntry_;
    }

    template<typename Key, typename Comp>
    const typename NameList<Key, Comp>::Cont&
    NameList<Key, Comp>::entries() const
    {
        return entries_;
    }

    template<typename Key, typename Comp>
    void NameList<Key, Comp>::clear()
    {
        entries_.clear();
        delete nullEntry_;
        nullEntry_ = 0;
    }

    template<typename Key, typename Comp>
    inline typename NameList<Key, Comp>::Entry&
    NameList<Key, Comp>::operator[](const Key& key)
    {
        return entries_[key];
    }

    template<typename Key, typename Comp>
    void NameList<Key, Comp>::setNullEntry(
        const Entry& nullEntry
    )
    {
        delete nullEntry_;
        nullEntry_ = new Entry(nullEntry);
    }

    template<typename Key, typename Comp>
    inline const typename NameList<Key, Comp>::Entry&
    NameList<Key, Comp>::get(const Key& key) const
    {
        const Entry* rc = 0;
        typename Cont::const_iterator e = entries_.find(key);
        if (entries_.end() != e) rc = &(e->second);
        else                     rc = nullEntry();
        return *rc;
    }

    template<typename Key, typename Comp>
    inline const std::string&
    NameList<Key, Comp>::name(const Key& key) const
    {
        return get(key).name_;
    }

    template<typename Key, typename Comp>
    inline const std::string&
    NameList<Key, Comp>::des(const Key& key) const
    {
        return get(key).des_;
    }

    template<typename Key, typename Comp>
    const typename NameList<Key, Comp>::Entry*
    NameList<Key, Comp>::nullEntry() const
    {
        if (0 == nullEntry_) {
            nullEntry_ = new Entry();
        }
        return nullEntry_;
    }

    // ********************************************************************
    // struct Id1InfoReader
    template<typename NameList>
    Id1InfoReader<NameList>::Id1InfoReader(
        const std::string& table,
        const std::string& colId1,
        const std::string& colName,
        const std::string& colDes
    ) : namelist_(0)
    {
        table_   = table;
        colId1_  = colId1;
        colName_ = colName;
        colDes_  = colDes;
    }

    template<typename NameList>
    void Id1InfoReader<NameList>::read(
        const OSB_DB::Session& session,
              NameList&        dest
    )
    {
        namelist_ = &dest;
        NameListReader::read(session);
        namelist_ = 0;
    }

    template<typename NameList>
    void Id1InfoReader<NameList>::addRow(const Row& row)
    {
        typedef typename NameList::KeyType Key;
        typedef typename NameList::Entry   Entry;

        if (0 == namelist_) return;

        Key key(row.id1_);
        (*namelist_)[key] = Entry(row.name_, row.des_);
    }

    // ********************************************************************
    // struct Id2InfoReader
    template<typename NameList>
    Id2InfoReader<NameList>::Id2InfoReader(
        const std::string& table,
        const std::string& colId1,
        const std::string& colId2,
        const std::string& colName,
        const std::string& colDes
    ) : namelist_(0)
    {
        table_   = table;
        colId1_  = colId1;
        colId2_  = colId2;
        colName_ = colName;
        colDes_  = colDes;
    }

    template<typename NameList>
    void Id2InfoReader<NameList>::read(
        const OSB_DB::Session& session,
              NameList&        dest
    )
    {
        namelist_ = &dest;
        NameListReader::read(session);
        namelist_ = 0;
    }

    template<typename NameList>
    void Id2InfoReader<NameList>::addRow(const Row& row)
    {
        typedef typename NameList::KeyType Key;
        typedef typename NameList::Entry   Entry;

        if (0 == namelist_) return;

        Key key(row.id1_, row.id2_);
        (*namelist_)[key] = Entry(row.name_, row.des_);
    }
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _NAMELIST_H_

---