mlclient::utilities::PugiXmlDocumentContent Class Reference

An ITextDocumentContent instance that wraps a pugixml xml_parse object. (Derived from pugi::xml_document) More...

#include <PugiXmlDocumentContent.hpp>

Inheritance diagram for mlclient::utilities::PugiXmlDocumentContent:

Public Member Functions
MLCLIENT_API	PugiXmlDocumentContent ()
	Default constructor.
virtual MLCLIENT_API	~PugiXmlDocumentContent ()
	Virtual destructor to allow subclassing.
pugixmldocumentcontent_overrides Overridden functions from base class
MLCLIENT_API void	setContent (const pugi::xml_document &xml)
	Sets the content of this document instance from a pugixml xml_document instance. More...
MLCLIENT_API std::istream *	getStream () const override
	Returns the content of this ITextDocumentContent as an istream. More...
MLCLIENT_API void	setContent (std::string content) override
	Sets the textual content for this document. More...
MLCLIENT_API std::string	getContent () const override
	Returns the content as a string. More...
MLCLIENT_API std::string	getMimeType () const override
	Returns the MIME type of this content. More...
MLCLIENT_API void	setMimeType (const std::string &mt) override
	Sets the MIME type of this content. More...
MLCLIENT_API int	getLength () const override
	Returns the number of characters in the content string. More...
MLCLIENT_API IDocumentNavigator *	navigate (bool firstElementAsRoot=false) const override
	Returns an IDocumentNavigator instance, as per the Document Traversal API. More...
pugixmldocumentcontent_functions These functions are new to this subclass.
MLCLIENT_API const pugi::xml_document &	getXml () const
	Returns the underlying pugixml xml_document object. More...
Public Member Functions inherited from mlclient::IDocumentContent
MLCLIENT_API	IDocumentContent ()
virtual MLCLIENT_API	~IDocumentContent ()=0

Additional Inherited Members
Static Public Attributes inherited from mlclient::IDocumentContent
static MLCLIENT_API const std::string	MIME_JSON
static MLCLIENT_API const std::string	MIME_XML

Detailed Description

An ITextDocumentContent instance that wraps a pugixml xml_parse object. (Derived from pugi::xml_document)

Author

Adam Fowler adam..nosp@m.fowl.nosp@m.er@ma.nosp@m.rklo.nosp@m.gic.c.nosp@m.om

Since

8.0.2

Date

2016-07-30

Used by the PugiXmlHelper class

Note

This class has an internal dependency on the pugixml API. As this API is shipped within MarkLogic's C++ wrapper (this API) , this does not introduce any extra dependencies.

Member Function Documentation

MLCLIENT_API std::string mlclient::utilities::PugiXmlDocumentContent::getContent ( ) const

overridevirtual

Returns the content as a string.

Returns

The string representation of the content.

Implements mlclient::IDocumentContent.

MLCLIENT_API int mlclient::utilities::PugiXmlDocumentContent::getLength ( ) const

overridevirtual

Returns the number of characters in the content string.

Note

This number does not include C null characters - just std::string length

Returns

The number of characters in the string. Does not include C null character.

Implements mlclient::ITextDocumentContent.

MLCLIENT_API std::string mlclient::utilities::PugiXmlDocumentContent::getMimeType ( ) const

overridevirtual

Returns the MIME type of this content.

E.g. application/xml or similar form

Returns

The string representation of the MIME type. Does not include encoding (always assume UTF-8 for MarkLogic Server)

Implements mlclient::IDocumentContent.

MLCLIENT_API std::istream* mlclient::utilities::PugiXmlDocumentContent::getStream ( ) const

overridevirtual

Returns the content of this ITextDocumentContent as an istream.

This allows streaming to a HTTP request of this string content.

Note

The stream may be read from asynchronously, so do not destroy the underlying content after returning the stream.

Returns

An istream instance wrapping the content of this Text Document Content instance

Implements mlclient::IDocumentContent.

MLCLIENT_API const pugi::xml_document& mlclient::utilities::PugiXmlDocumentContent::getXml

(

)

const

Returns the underlying pugixml xml_document object.

Returns

The underlying pugixml xml_document object.

MLCLIENT_API IDocumentNavigator* mlclient::utilities::PugiXmlDocumentContent::navigate ( bool  firstElementAsRoot = false ) const

overridevirtual

Returns an IDocumentNavigator instance, as per the Document Traversal API.

Parameters

firstElementAsRoot

Whether the root XML element is the Document node (false) or the first full XML element (true).

Returns

The IDocumentNavigator instance (caller OWNS the pointer, this class does not delete it)

Implements mlclient::ITextDocumentContent.

MLCLIENT_API void mlclient::utilities::PugiXmlDocumentContent::setContent

(

const pugi::xml_document &

xml

)

Sets the content of this document instance from a pugixml xml_document instance.

Parameters

json	The pugixml xml_document instance to copy

MLCLIENT_API void mlclient::utilities::PugiXmlDocumentContent::setContent ( std::string  content )

overridevirtual

Sets the textual content for this document.

Assumes content string is non null

Parameters

[in]

The

string content to copy in to this object.

Implements mlclient::ITextDocumentContent.

MLCLIENT_API void mlclient::utilities::PugiXmlDocumentContent::setMimeType ( const std::string &  mt )

overridevirtual

Sets the MIME type of this content.

E.g. application/json or application/xml

Parameters

[in]

mt

The mimetype string, not including encoding, for this Document Content. Assume always UTF-8 for MarkLogic Server)

Implements mlclient::IDocumentContent.

---

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

• include/mlclient/utilities/PugiXmlDocumentContent.hpp