Class XMLData
#include <XMLData.h >
Super class: HashArray
This class represent hierarchical XML data.
XML properties are encapsulated in a HashArray class for any XML node.
The data structure can be serialized using toString() and loaded from text using fromString().
What makes this XML class special is that the XML is generated from records, so it
follows a readily parsable pattern when read back in.
<recordtype id="n" pname="paramname" >
<propname >propvalue </propname >
... additional properties
<subnodename >
<recordtype id="n" >
...
</recordtype >
</subnodename >
... additional subnodes
</recordtype >
Properties are simple values inside a record, HashArray. Subnodes are sub-records inside a record, XMLData.
Note that when writing out XML property values, substitutions happen for <, >, &, " and '.
This class uses the XMLData class for key-value properties.
Constructor. Create an emptry hierarchical data structure.
Each level of hierarchy has a number of properties and child nodes.
const string& xmltext |
a serialized HashArray or XMLData value |
This constructor accepts serialized HashArray or XMLData text and converts into into this structure.
const HashArray& props |
a group of key-value properties |
const string& recordType |
Default value: "" |
Create a named node of XMLData.
Get the id of this record (if set). It is the value of the "id" property.
Return value: record id if set, otherwise 0
Get the record name. That is, the value of the "pname" property.
Return value: record name
Get the record type. In XML, this is the record tag.
Return value: the record type
const string& key |
the key of the property to fetch; if it's a node, then the node is serialized to XML text |
General purpose - will always return something, whether property or child.
If a property, the string value of the key provided is returned.
If a child node, the serialized value of the child as XML.
Return value: string value for the key provided, null string if no such key or child
XMLId newId |
the new id value |
Set the "id" property to the value provided.
string newName |
the record name |
Set the name of the record, e.g. the value of "pname".
Note that the value must be alphanumeric characters or colonm ,otherwise, they will be converetd to "_" characters.
Return value: the value of newName
string newType |
the new type of the record |
Set the record type for this node. This becomes the XML tag name.
Note that the value must be alphanumeric characters or colonm ,otherwise, they will be converetd to "_" characters.
const string& key |
the key name |
const string& value |
the value as string |
Assign a key-value property into this node
const string& key |
the key name |
int value |
the value as int |
Assign a key-value property into this node
const string& key |
the key name |
long value |
the value as long |
Assign a key-value property into this node
const string& key |
the key name |
unsigned int value |
the value as unsigned int |
Assign a key-value property into this node
const string& key |
the key name |
unsigned long value |
the value as unsigned long |
Assign a key-value property into this node
const string& key |
the key name |
bool value |
the value as boolean. |
Assign a key-value property into this node
const string& key |
the key name |
float value |
the value as float |
Assign a key-value property into this node
const string& key |
the key name |
double value |
the value as double |
Assign a key-value property into this node
const string& key |
the key or child name to remove. |
Unset the property with key name provided or with the child name provided.
const HashArray& props |
the new properties for this node |
Replace this node's existing properties with the provided ones.
const string& key |
the name of the child node |
XMLId id |
the id of the child node |
const XMLData& record |
the new child node |
Add or Replace an indexed/id'ed child node with the new record provided. Multiple children may exist, but only the one specific to the id is addressed.
Return value: the new child node
const string& key |
the name of the child node |
const XMLData& record |
the new child node |
Add or Replace an indexed/id'ed child node with the new record provided. Multiple children may exist, but only the one specific to the new record's id is addressed.
Return value: the new child node
const XMLData& record |
the new child node |
Add or Replace an indexed/id'ed child node with the new record provided. Multiple children may exist, but only the one specific to the new record's id and record's name is addressed.
Return value: the new child node
const string& key |
the name of the child node |
XMLId id |
the id of the child node |
Locate the child node with the name and id and remove it.
const string& key |
the name of the child node |
Locate all child node with the name and remove them (if any).
@param id - the id of the child node
Return the number of properties (not children) of this node.
Return value: count of properties in this node and level
const string& key |
the name of the sub-nodes to look for |
Determine how many children of the key exist.
Return value: number of instances of sub-nodes of the key name
const string& key |
(optional) the name of the sub-nodes to count; if non-null, it returns size(key) Default value: "" |
Determine the number of children of this node. If a key is provided, then determine the number of children with that name.
Return value: number of children
const string& key |
the name of the sub-nodes to look for |
Given a child node name, return the node of that child. If more than one sub-node exists, return the first one.
Return value: child node; if not found, returns an empty node (valid() returns null false)
const string& key |
the name of the sub-nodes to look for |
XMLId id |
the id of the sub-node |
Given a child node name and id, return the node of that child.
Return value: child node; if not found, returns an empty node (valid() returns null false)
int index |
the index position of the child, e.g. 0+ |
Return the indexed node of that child, regardless of its name. The first child instance is index=0, the second is index=1, etc.
Return value: child node; if not found, returns an empty node (valid() returns null false)
const string& key |
the name of the sub-nodes to look for |
int index |
the index position of the child, e.g. 0+ |
Return the indexed node of that child name. The first child instance is index=0, the second is index=1, etc.
Return value: child node; if not found, returns an empty node (valid() returns null false)
const string& key |
the name of the sub-nodes to look for |
const string& property |
the property name inside the child node |
const string& value |
the property value inside the child node |
Given a child node name, return the indexed node of that child. The first child instance is index=0, the second is index=1, etc.
Return value: child node; if not found, returns an empty node (valid() returns null false)
const string& key |
the name of the sub-nodes to look for |
const string& property |
the property name inside the child node |
long value |
the property value inside the child node |
Given a child node name, a property of that child, and the value for that property, return the node of that child.
Return value: child node; if not found, returns an empty node (valid() returns null false)
const string& key |
the name of the sub-nodes to look for |
Given a child node name, return the node of that child. If more than one sub-node exists, return the first one.
Return value: child node (as a const); if not found, returns an empty node (valid() returns null false)
const string& key |
the name of the sub-nodes to look for |
XMLId id |
the id of the sub-node |
Given a child node name and id, return the node of that child.
Return value: child node (as a const); if not found, returns an empty node (valid() returns null false)
int index |
the index position of the child |
Return the indexed node of that child, regardless of its name. The first child instance is index=0, the second is index=1, etc.
Return value: child node (as a const); if not found, returns an empty node (valid() returns null false)
const string& key |
the name of the sub-nodes to look for |
int index |
the index position of the child |
Given a child node name, return the indexed node of that child. The first child instance is index=0, the second is index=1, etc.
Return value: child node (as a const); if not found, returns an empty node (valid() returns null false)
const string& key |
the name of the sub-nodes to look for |
const string& property |
the property name inside the child node |
const string& value |
the property value inside the child node |
Given a child node name, return the indexed node of that child. The first child instance is index=0, the second is index=1, etc.
Return value: child node (as a const); if not found, returns an empty node (valid() returns null false)
const string& key |
the name of the sub-nodes to look for |
const string& property |
the property name inside the child node |
long value |
the property value inside the child node |
Given a child node name, return the indexed node of that child. The first child instance is index=0, the second is index=1, etc.
Return value: child node (as a const); if not found, returns an empty node (valid() returns null false)
Get a list of all child names that are unique.
Return value: a list of unique all child names
const string& xpath |
the XPath discribing how to navigate the structure to get the value |
Fetching using XPath
Given an XPath, return the value. Sample XPaths supported:
/top/middle/middle2/leaf
/top[4]/middle/leaf
Return value: the property value (as string)
const string& xpath |
the XPath discribing how to navigate the structure to get the value |
Fetching using XPath
Given an XPath, return the value. Sample XPaths supported:
/top/middle/middle2/leaf
/top[4]/middle/leaf
Return value: the property value (as long)
const string& xpath |
the XPath discribing how to navigate the structure to get the value |
Fetching using XPath
Given an XPath, return the value. Sample XPaths supported:
/top/middle/middle2/leaf
/top[4]/middle/leaf
Return value: the property value (as float)
const string& xpath |
the XPath discribing how to navigate the structure to get the value |
Fetching using XPath
Given an XPath, return the value. Sample XPaths supported:
/top/middle/middle2/leaf
/top[4]/middle/leaf
Return value: the property value (as double)
const string& xpath |
the XPath discribing how to navigate the structure to get the value |
Fetching using XPath
Given an XPath, return the value. Sample XPaths supported:
/top/middle/middle2/leaf
/top[4]/middle/leaf
Return value: the property value (as bool)
const string& xpath |
the XPath discribing how to navigate the structure to get the value |
Fetching using XPath
Given an XPath, return the node it points to. Sample XPaths supported:
/top/middle/middle2/leaf
/top[4]/middle/leaf
Return value: the property value (as string)
const string& key |
the key to use to find the value |
Get a property (or child as XML text) from its key
Return value: the value for the key
const XMLData& b |
the other XMLData to add to this XMLData |
Merge together the properties from the provided node and add all the children of the provided node.
Return value: a new XMLData with both structures combined
const XMLData& b |
the other XMLData to add to node |
Merge the properties from the provided node and add all the children of the provided node to the current node.
Return value: the updated XMLData with both structures combined
Convert the node and all sub-nodes into serialized text.
Return value: the XMLData, serialized as text
string& result |
(output) the serialized text |
Convert the node and all sub-nodes into serialized text into the provided string.
Return value: the resulting output in the result parameter
Truncate all the XMLData children and return only the properties of the current nodes - as a HashArray.
Return value: just the properties (as HashArray)
string text |
XML as text to convert into our structure |
Convert serialized XMLData text into the current XMLData structure, clearing any previous data.
Return value: true if data fully loaded
Determine if the current XMLData instance is valid or empty.
Return value: true if valid, false if empty/invalid
Clear all data int his XMLData node and remove all sub-nodes.
bool yes |
true if tags should be valid identifiers Default value: true |
By default, tags must be identifiers (alphanumeric tokens, but may include :).
Return value: true if tags will be enforced as identifiers.
string text |
the input tag |
Ensure text is a valid identifer (no spaces or punctuation except :)
Return value: the input text, but now as a valid identifier
int depth |
the starting tree depth (used for indentation) Default value: 0 |
Produce a text tree of XML data.
Return value: a string representation as output text of the tree
XMLId id |
the id of this node |
string name |
node name for this record |
string type |
record type |
unsigned int noChildren |
count of the number of children nodes (not including properties) |
vector <XMLData > child |
child records |
static bool tagsAreIdentifiers |
Flag: treat tags as identifiers (not spaces allowed), default: true |
const string& text |
text to encode |
Encode the provided text into XML printable text
Return value: encoded text
const string& text |
text to decode |
Decode the XML printable text into the original text
Return value: decoded text
string& text |
text to parse |
char leadchar |
lead character |
Given text, extract the identifier.
Return value: the identifier found
string& text |
text to parse |
char leadchar |
lead character |
Given text, extract the quoted value.
Return value: the quoted text found
string& text |
text to parse |
bool isSubrecord |
Flag: true if subrecord, false if not Default value: false |
Parse the text to get the tag label.
const XMLData& newchild |
the new XMLData node to add |
Append another child node to this XMLData.
const string& xpath |
the XPath to use |
string& childName |
(output) |
int& index |
(output) |
bool& ok |
(output) |
Given an XPath, get the child name and index and return the parent node
Return value: parent node of XPath provided