it_bus_pdk/xml_helper.h

#ifndef _IT_XML_HELPER_
#define _IT_XML_HELPER_

#include <it_bus/api_defines.h>
#include <it_bus/binary_buffer.h>
#include <it_bus/exception.h>
#include <it_bus/types.h>

// REVISIT: this header should not refer to any Xerces-C type!
//
namespace xercesc_2_4
{
    class DOMElement;
    class XercesDOMParser;
}

namespace IT_Bus
{
    class EntityResolverBase;
}

namespace IT_Bus
{
    class IT_BUS_XML_API XercesString
    {
      public:

        static char* 
        replicate(
            const char* source
        );

        static void 
        destroy(
            char* source
        );
    };

    class IT_BUS_XML_API XMLHelper 
    {
        friend class XMLIterator;

      public:

        XMLHelper();
        virtual ~XMLHelper();

        void 
        parse_from_url(
            const IT_Bus::String& strURL
        );
        
        void 
        parse_from_file(
            const IT_Bus::String& strFile
        );

        void 
        parse(
            const IT_Bus::BinaryBuffer& vvInputBuffer
        );
        
        void 
        serialize(
            IT_Bus::BinaryBuffer& vvOutputBuffer
        ) const;

        void 
        clear();

        operator IT_Bus::String() const;

        void 
        set_root_name(
            IT_Bus::String Name
        );

        IT_Bus::String 
        get_root_name();
        
        bool 
        is_root_name(
            IT_Bus::String Name
        );

        bool 
        is_empty();

        void 
        add_field(
            IT_Bus::String FieldName, 
            IT_Bus::String FieldValue
        );

        void 
        add_field(
            IT_Bus::String FieldName
        );

        IT_Bus::String 
        get_field_as_string(
            IT_Bus::String FieldName
        ) const;

        void 
        set_field_as_string(
            IT_Bus::String FieldName, 
            IT_Bus::String& FieldValue
        );

        const 
        IT_Bus::String& 
        get_wsdl_location_as_string() const;

        void 
        set_wsdl_location_as_string(
            const IT_Bus::String& strURL
        );

        // REVISIT: Internal use. May change in future.
        //
        void 
        set_entity_resolver(
            EntityResolverBase * entityResolverBase
        );

        xercesc_2_4::DOMElement *
        GetCurrentElement();

        const xercesc_2_4::DOMElement *
        GetCurrentElement() const;

      private:

        xercesc_2_4::XercesDOMParser*   m_parser;
        IT_Bus::String                  m_wsdl_location; 
        IT_Bus::EntityResolverBase      * m_entity_resolver_base; 
    };

    class IT_BUS_XML_API XMLIterator
    {
      public:

        XMLIterator(
            XMLHelper& XMLHelper
        );

        XMLIterator(
            const XMLIterator& Iterator
        );

        XMLIterator& 
        operator=(
            const XMLIterator& Iterator
        );

        virtual 
        ~XMLIterator();

        bool
        move_down();

        bool
        move_up();

        bool
        move_next();

        bool
        move_previous();

        bool
        move_first();

        bool
        move_last();

        bool 
        move_depth_first();

        bool 
        move_same_first();

        bool 
        move_same_previous();

        bool 
        move_same_next();

        bool 
        move_same_last();

        const IT_Bus::String &
        get_tag_name() const;

        bool 
        find_namespace(
            const char* szNamespace, 
            xercesc_2_4::DOMElement * & elm
        );

        bool 
        set_namespace(
            IT_Bus::String strNamespace
        );

        bool 
        set_sub_namespace(
            IT_Bus::String strNamespace
        );

        void 
        add_namespace(
            IT_Bus::String strNamespace
        );

        void 
        add_sub_namespace(
            IT_Bus::String strSubNamespace
        );

        long 
        get_count() const;

        void 
        get_nv_pair(
            long lIndex, 
            IT_Bus::String& strName, 
            IT_Bus::String& strValue
        ) const;

        IT_Bus::String 
        get_field_as_string(
            IT_Bus::String strFieldName
        ) const;

        void 
        set_field_as_string(
            IT_Bus::String strFieldName, 
            IT_Bus::String FieldValue
        );

        void 
        set_field(
            IT_Bus::String strFieldName, 
            IT_Bus::BinaryBuffer& FieldValue
        );

        void 
        serialize(
            IT_Bus::BinaryBuffer& vvOutputBuffer
        ) const;

        void 
        serialize(
            IT_Bus::BinaryBuffer& vvOutputBuffer,
            IT_Bus::Boolean is_root
        ) const;

        void 
        serialize_element(
            IT_Bus::BinaryBuffer& vvOutputBuffer,
            IT_Bus::Boolean is_root
        ) const;

        void 
        serialize_element(
            IT_Bus::BinaryBuffer& vvOutputBuffer,
            const IT_Bus::String & location,
            IT_Bus::Boolean is_root
        ) const;

        operator IT_Bus::String() const;

        void 
        add_new();

        long 
        get_element_count();

        long 
        get_sub_element_count() const;

        void 
        get_sub_element(
            long dwIndex, 
            XMLIterator& iterSubElement
        ) const;

        IT_Bus::String 
        get_element_value() const;

        XMLHelper& 
        get_xml_helper() const;

      private: 

        XMLHelper&                  m_xml_helper;
        xercesc_2_4::DOMElement*    m_elm_parent;
        xercesc_2_4::DOMElement*    m_elm;
        IT_Bus::String              m_tag_name;
        IT_Bus::String              m_full_name;
        long                        m_same_element_index;
        long                        m_node_index;
    };
}

IT_Bus::String 
IT_BUS_XML_API 
it_format_for_display(
    IT_Bus::XMLIterator iterData, 
    long dwIndentLevel = 0
);

#endif /*_IT_XML_HELPER_*/

---