MarkLogic Connect
MarkLogic Connect Client API Collection
Public Member Functions | List of all members
mlclient::utilities::PugiXmlContainerNode Class Reference

Document Traversal API generic container for Pugi XML. More...

#include <PugiXmlDocumentContent.hpp>

Inheritance diagram for mlclient::utilities::PugiXmlContainerNode:
mlclient::IDocumentNode mlclient::utilities::PugiXmlArrayNode mlclient::utilities::PugiXmlObjectNode

Public Member Functions

MLCLIENT_API bool isNull () const override
 Does this document element have a blank value? More...
 
MLCLIENT_API bool isBoolean () const override
 Whether this element or property is a boolean type. More...
 
MLCLIENT_API bool isInteger () const override
 Whether this element or property is a integer type. More...
 
MLCLIENT_API bool isDouble () const override
 Whether this element or property is a double type. More...
 
MLCLIENT_API bool isString () const override
 Whether this element or property is a string type. More...
 
MLCLIENT_API bool asBoolean () const override
 Returns the boolean value of this element or property. More...
 
MLCLIENT_API int32_t asInteger () const override
 Returns the integer value of this element or property. More...
 
MLCLIENT_API double asDouble () const override
 Returns the double value of this element or property. More...
 
MLCLIENT_API std::string asString () const override
 Returns the string value of this element or property. More...
 
- Public Member Functions inherited from mlclient::IDocumentNode
virtual MLCLIENT_API bool isArray () const =0
 Whether this element or property is an array type. More...
 
virtual MLCLIENT_API bool isObject () const =0
 Whether this element or property is an object type (i.e. a JSON object or an XML element with element content) More...
 
virtual MLCLIENT_API IDocumentNodeasArray () const =0
 Returns the array value of this element or property (i.e. the child objects) More...
 
virtual MLCLIENT_API IDocumentNodeasObject () const =0
 Returns the Object value of this element or property (i.e. the child object) More...
 
virtual MLCLIENT_API IDocumentNodeat (const std::string &key) const =0
 
virtual MLCLIENT_API IDocumentNodeat (const int32_t idx) const =0
 

Detailed Description

Document Traversal API generic container for Pugi XML.

See IDocumentNode for details.

Since
8.0.2

Member Function Documentation

MLCLIENT_API bool mlclient::utilities::PugiXmlContainerNode::asBoolean ( ) const
overridevirtual

Returns the boolean value of this element or property.

Exceptions
InvalidFormatExceptionif not of the right type
Returns
The boolean value

Implements mlclient::IDocumentNode.

MLCLIENT_API double mlclient::utilities::PugiXmlContainerNode::asDouble ( ) const
overridevirtual

Returns the double value of this element or property.

Exceptions
InvalidFormatExceptionif not of the right type
Returns
The double value

Implements mlclient::IDocumentNode.

MLCLIENT_API int32_t mlclient::utilities::PugiXmlContainerNode::asInteger ( ) const
overridevirtual

Returns the integer value of this element or property.

Exceptions
InvalidFormatExceptionif not of the right type
Returns
The integer value

Implements mlclient::IDocumentNode.

MLCLIENT_API std::string mlclient::utilities::PugiXmlContainerNode::asString ( ) const
overridevirtual

Returns the string value of this element or property.

Exceptions
InvalidFormatExceptionif not of the right type
Returns
The string value

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlContainerNode::isBoolean ( ) const
overridevirtual

Whether this element or property is a boolean type.

Returns
True if of type boolean

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlContainerNode::isDouble ( ) const
overridevirtual

Whether this element or property is a double type.

Returns
True if of type double

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlContainerNode::isInteger ( ) const
overridevirtual

Whether this element or property is a integer type.

Returns
True if of type integer

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlContainerNode::isNull ( ) const
overridevirtual

Does this document element have a blank value?

Returns
True if the value is blank. E.g. {"data":""} or <data>

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlContainerNode::isString ( ) const
overridevirtual

Whether this element or property is a string type.

Returns
True if of type string

Implements mlclient::IDocumentNode.


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