soa/serverlist.h

Go to the documentation of this file.

#ifndef  INC_SOA_SERVERLIST_H
#define  INC_SOA_SERVERLIST_H

#ifndef  INC_MI32_MILIST_H
   #include <mi32/milist.h>
#endif

#ifndef  INC_MI32_MISTRING_H
   #include <mi32/mistring.h>
#endif

#ifndef  INC_MI32_STRUTF8_H
   #include <mi32/strutf8.h>
#endif

#ifndef  INC_MI32_FILEPATH_H
   #include <mi32/filepath.h>
#endif

#include <vector>

class HTTPMESSAGE;
class XMLDOC;
class XMLNODE;

namespace SOA {

//=====================================================================================================================

class SERVERLIST {
   public:

      class ITEM;
      typedef MILIST<SERVERLIST::ITEM> ITEMLIST;

      class ITEM {
         public:

            ITEM (
               bool IsList = true
               );

            ITEM (
               bool IsList,
               std::vector<MISTRING> additionaltags
               );

            ITEM (
               const MISTRING& title
               );

            ITEM (
               const MISTRING& title,
               const MISTRING& url,
               bool IsList = false
               );

            ~ITEM ();

            ITEM& AddChildToBack (
               const ITEM& item
               );

            ITEM& AddChildToFront (
               const ITEM& item
               );

            const MISTRING& GetAbstract (
               ) const { return (m_Abstract); }

            const std::vector<MISTRING> GetAdditionalTagData (
                  ) const { return (m_AdditionalTagData); }

            const std::vector<MISTRING> GetAdditionalTagNames (
                  ) const { return (m_AdditionalTagNames); }

            const ITEMLIST& GetItemList (
               ) const { return (m_ItemList); }

            const ITEM* GetParent (
               ) const { return (m_pParent); }

            ITEM* GetParent (
               ) { return (m_pParent); }

            const STRUTF8& GetService (
               ) const { return (m_service); }

            const MISTRING& GetTitle (
               ) const { return (m_title); }

            const MISTRING& GetURL (
               ) const { return (m_url); }

            const MISTRING& GetBaseURL (
               ) const { return (m_baseurl); }

            ITEM& InsertChild (
               ITEMLIST::CONST_ITERATOR itInsertBefore,
               const ITEM& item
               );

            bool IsList (
               ) const { return (m_IsList); }

            ERRVALUE Parse (
               const XMLNODE* xmlnode
               );

            void RemoveChild (
               ITEMLIST::CONST_ITERATOR itChild
               );

            void SetAbstract (
               const MISTRING& Abstract
               ) { m_Abstract = Abstract; }

            void SetAdditionalTagNames (
               const std::vector<MISTRING>& additionaltags
               ) { m_AdditionalTagNames = additionaltags;
                   m_AdditionalTagData.resize(additionaltags.size());}

            void SetAdditionalTagData (
               const std::vector<MISTRING>& additionaltags
               ) { m_AdditionalTagData = additionaltags;}

            void SetURL (
               const MISTRING& url
               ) { m_url = url; }

            void SetBaseURL (
               const MISTRING& baseurl
               ) { m_baseurl = baseurl; }

            void SetTitle (
               const MISTRING& title
               ) { m_title = title; }

            void TransferList (
               ITEM& listitem
               );

            void TransferList (
               const ITEMLIST& list
               ) {m_ItemList = list;}

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            MISTRING m_title;
            MISTRING m_url;
            MISTRING m_baseurl;
            STRUTF8 m_service;
            MISTRING m_Abstract;
            std::vector<MISTRING> m_AdditionalTagNames;
            std::vector<MISTRING> m_AdditionalTagData;
            ITEMLIST m_ItemList;
            ITEM *m_pParent;
            bool m_IsList;

            ERRVALUE GetXML (XMLNODE *xmlnode) const;

            friend class SOA::SERVERLIST;
            #endif
         };

      SERVERLIST ();

      ~SERVERLIST ();

      const ITEMLIST& GetItemList (
         ) const { return (m_TopItem.GetItemList()); }

      const ITEM& GetTopItem (
         ) const { return (m_TopItem); }

      ITEM& GetTopItem (
         ) { return (m_TopItem); }

      ERRVALUE Load (
         const FILEPATH& filepath,
         std::vector<MISTRING> *additionaltags=0 
         );

      ERRVALUE Load (
         const HTTPMESSAGE& msg,
         std::vector<MISTRING> *additionaltags=0
         );

      ERRVALUE Save (
         const FILEPATH& filepath
         ) const;

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      ITEM m_TopItem;

      ERRVALUE ParseXML (const XMLDOC& doc);
      #endif
   };

//=====================================================================================================================

}  // End namespace SOA

#endif   // INC_SOA_SERVERLIST_H

---