inc/Walker.h

   1 //! \file Walker.h
   2
   3 #ifndef WIKIWALKER_WALKER_H
   4 #define WIKIWALKER_WALKER_H
   5
   6 #include "ArticleCollection.h"
   7
   8 namespace WikiWalker
   9 {
  10   //! Base class for article analyzers
  11   class Walker
  12   {
  13   public:
  14     /*! get the ArticleCollection with stored articles
  15      * \returns const reference to collection with stored reference
  16      * \todo looks code-smelly, is this really neccessary?
  17      */
  18     const CollectionUtils::ArticleCollection& collection() const
  19     {
  20       return articleSet_;
  21     }
  22
  23     //! virtual base class destructor
  24     virtual ~Walker() = default;
  25
  26   protected:
  27     //! article collection, used as cache, for walked articles
  28     CollectionUtils::ArticleCollection articleSet_;
  29   };
  30 }  // namespace WikiWalker
  31 #endif  // WIKIWALKER_WALKER_H