src/ArticleCollection.h

   1 //! \file ArticleCollection.h
   2
   3 #ifndef _ARTICLE_COLLECTION_H
   4 #define _ARTICLE_COLLECTION_H
   5
   6 #include <map>
   7
   8 // forward-declare, since we only store pointer
   9 class Article;
  10
  11 /*! Collection of available articles.
  12  *  This should be used as "cache".
  13  */
  14 class ArticleCollection
  15 {
  16 public:
  17     //! The way that articles are stored inside
  18     typedef std::map<std::string, Article*> storage_type;
  19
  20     //! iterator type
  21     typedef storage_type::iterator iterator;
  22
  23     //! constant iterator type
  24     typedef storage_type::const_iterator const_iterator;
  25
  26     /*! add article to collection.
  27       * \param article article to add
  28       * \return true if insertion took place
  29       *          false if it failed (e.g. another article with the same title already exists
  30       */
  31     bool add(Article* article);
  32
  33     //! get number of articles in collection
  34     size_t getNumArticles() const
  35     {
  36         return articleSet.size();
  37     }
  38
  39     /*! get pointer to article.
  40      * \param title title of the article to request
  41      * \return pointer to article, or nullptr, if not found
  42      */
  43     Article* get(std::string title);
  44
  45     ArticleCollection() {}
  46
  47     /*! Returns an iterator to the first article in the collection.
  48      * \returns iterator to the first article
  49      */
  50     iterator begin();
  51
  52     /*! Returns an iterator to the article following the last article in the collection
  53      * \returns iterator to element after last article
  54      */
  55     iterator end();
  56
  57     /*! Returns a const_iterator to the first article in the collection
  58      * \returns constant iterator to the first article
  59      */
  60     const_iterator begin() const;
  61
  62     /*! Returns a const_iterator to the article following the last article in the collection
  63      * \returns constant iterator to element after last article
  64      */
  65     const_iterator end() const;
  66
  67     ~ArticleCollection();
  68
  69     //! deleted copy constructor. Because it stores raw pointers.
  70     ArticleCollection(const ArticleCollection&) = delete;
  71     //! deleted copy assignment. Because it stores raw pointers.
  72     ArticleCollection& operator=(const ArticleCollection&) = delete;
  73
  74 private:
  75     // we need to avoid duplicate article instances.
  76     // we do this by associating an article title with its instance
  77     storage_type articleSet;
  78 };
  79
  80 #endif // _ARTICLE_COLLECTION_H