xml::XmlDelegate Class Reference

Interface for overriding XML handling (must be capable of handling multiple threads) More...

#include <src/api/mip/xml_delegate.h>

Public Member Functions
virtual XmlReaderResult	CreateXmlReader (const std::string &xmlParserInput) const =0
	Create an xml reader that can transverse the input.
virtual XmlDocumentResult	ParseData (const std::string &data) const =0
	Parse an xml formatted buffer into an XmlDocument.

Detailed Description

Interface for overriding XML handling (must be capable of handling multiple threads)

Definition at line 50 of file xml_delegate.h.

Member Function Documentation

CreateXmlReader()

virtual XmlReaderResult xml::XmlDelegate::CreateXmlReader ( const std::string & xmlParserInput ) const

pure virtual

Create an xml reader that can transverse the input.

This method will throw an XmlLoadException if it cannot initialize an XML reader, if the input is invalid, or if the input is too large to handle.

Parameters

xmlParserInput

Input containing either xml in string format or a uri to xml

Returns

A delegate response that contains either a shared pointer to a reader that can look at each node of the xml sequentially, or an XmlLoadException

ParseData()

virtual XmlDocumentResult xml::XmlDelegate::ParseData ( const std::string & data ) const

pure virtual

Parse an xml formatted buffer into an XmlDocument.

Parameters

data	A string that should be in xml format

Warning

The XmlDocument returned should memory manage itself. That is, when it goes out of scope, it should take care of any free functions needed to release memory. In our native implementation, this is achieved with a unique_ptr with a specialized deleter function.

Returns

A delegate response that contains either a shared_ptr to an XmlDocument or an exception if parsing fails

---

The documentation for this class was generated from the following file:

• src/api/mip/xml_delegate.h