fwXML
8.4.0
|
private const int | fwXml_PARSING_DOWNORACROSS = 0 |
private const int | fwXml_PARSING_WHEN_LEAVING = 1 |
const int | fwXml_SAXSTARTELEMENT = 2 |
const int | fwXml_SAXENDELEMENT = 3 |
const int | fwXml_SAXTEXT = 6 |
const int | fwXml_CONTAINS_SIMPLE_ELEMENT_NODES = 0 |
const int | fwXml_CONTAINS_TEXT_NODES = 8 |
const int | fwXml_CONTAINS_COMMENT_NODES = 256 |
const int | fwXml_CONTAINS_COMPLEX_ELEMENT_NODES = 2 |
const string | fwXml_CHILDNODESTYPE = "fwXml_ChildNodesType" |
const string | fwXml_CHILDSUBTREEID = "fwXml_ChildSubTreeId" |
private int | _fwXml_getTypeOfCallback (int parsingDownAcrossOrUp, int nodeType) |
private void | _fwXml_parseSaxRecursive (int documentId, mapping callBackList, int level, int topNodeId, dyn_string &exceptionInfo) |
public int | fwXml_parseSaxFromFile (string xmlDocumentName, mapping callBackList, dyn_string &exceptionInfo) |
private void | _fwXml_getElementsRecursive (unsigned documentId, int topNodeId, string tagName, dyn_int &elements, dyn_string &exceptionInfo) |
public dyn_int | fwXml_elementsByTagName (unsigned documentId, int topNodeId, string tagName, dyn_string &exceptionInfo) |
public bool | fwXml_containsNodeTypes (int setOfTypes, int requestedTypes) |
public int | fwXml_childNodesContent (unsigned documentId, int topNodeId, dyn_string &node_names, dyn_anytype &attributes, dyn_string &nodevalues, dyn_string &exceptionInfo) |
public int | fwXml_appendChildContent (unsigned documentId, int topNodeId, dyn_string node_names, dyn_anytype attributes, dyn_string nodevalues, dyn_string &exceptionInfo) |
This library contains the XML SAX function call and some additional XML DOM function calls.
private int _fwXml_getTypeOfCallback | ( | int | parsingDownAcrossOrUp, |
int | nodeType | ||
) |
'_fwXml_getTypeOfCallback' calculates the type of 'callback' that needs to be executed!
parsingDownAcrossOrUp | input, the parsing direction |
nodeType | input, the node-type of the encopuntered node |
private void _fwXml_parseSaxRecursive | ( | int | documentId, |
mapping | callBackList, | ||
int | level, | ||
int | topNodeId, | ||
dyn_string & | exceptionInfo | ||
) |
'_fwXml_parseSaxRecursive' called by 'fwXml_parseSaxFromFile' and itself in a recursive way.
documentId | input, the document-ident of the loaded Xml file |
callBackList | input, the callback functions to be called while parsing |
level | input, the current nesting-level of the recursive calls |
topNodeId | input, the top node-ident from which the sub-tree is parsed |
exceptionInfo | inout, returns details of any exceptions |
public int fwXml_parseSaxFromFile | ( | string | xmlDocumentName, |
mapping | callBackList, | ||
dyn_string & | exceptionInfo | ||
) |
'fwXml_parseSaxFromFile' parses an Xml-file according to the SAX mechanism with user-defined callbacks.
xmlDocumentName | input, the file-name of the Xml file to be parsed |
callBackList | input, the callback functions to be called while parsing |
exceptionInfo | inout, returns details of any exceptions |
private void _fwXml_getElementsRecursive | ( | unsigned | documentId, |
int | topNodeId, | ||
string | tagName, | ||
dyn_int & | elements, | ||
dyn_string & | exceptionInfo | ||
) |
'_fwXml_getElementsRecursive' called by 'fwXml_elementsByTagName' and itself in a recursive way.
documentId | input, the document identifier |
topNodeId | input, the top node-identifier of the parent or -1 (root-node) |
tagName | input, the tag-name of the children which need to be returned |
elements | inout, the elements satisfying the tag-name condition |
exceptionInfo | inout, returns details of any exceptions |
public dyn_int fwXml_elementsByTagName | ( | unsigned | documentId, |
int | topNodeId, | ||
string | tagName, | ||
dyn_string & | exceptionInfo | ||
) |
'fwXml_elementsByTagName' returns all children which have a specific element's tag-name
documentId | input, the document identifier |
topNodeId | input, the top node-identifier of the parent or -1 (root-node) |
tagName | input, the tag-name of the children which need to be returned |
exceptionInfo | inout, returns details of any exceptions |
public bool fwXml_containsNodeTypes | ( | int | setOfTypes, |
int | requestedTypes | ||
) |
'fwXml_containsNodeTypes'
Checks if the returned contents node-types are all present in the set of requested ones.
setOfTypes | input, contents node-types to be checked |
requestedTypes | input, set of requested node-types that are allowed |
public int fwXml_childNodesContent | ( | unsigned | documentId, |
int | topNodeId, | ||
dyn_string & | node_names, | ||
dyn_anytype & | attributes, | ||
dyn_string & | nodevalues, | ||
dyn_string & | exceptionInfo | ||
) |
'fwXml_childNodesContent' returns tags, attributes and contained data of all children
documentId | input, the document identifier |
topNodeId | input, the top node-identifier of the parent element-node container |
node_names | output, the node-names or tag-names for element-nodes |
attributes | output, the attributes of element-nodes and added infomation |
nodevalues | output, the node-values or values of the unique child's text-node |
exceptionInfo | inout, returns details of any exceptions |
public int fwXml_appendChildContent | ( | unsigned | documentId, |
int | topNodeId, | ||
dyn_string | node_names, | ||
dyn_anytype | attributes, | ||
dyn_string | nodevalues, | ||
dyn_string & | exceptionInfo | ||
) |
'fwXml_appendChildContent' appends element-nodes, attributes and contained data to the Xml Tree
documentId | input, the document identifier |
topNodeId | input, the top node-identifier of the parent element-node container |
node_names | input, tag-names for element-nodes |
attributes | input, the attributes of element-nodes |
nodevalues | input, the values of the unique child's text-node |
exceptionInfo | inout, returns details of any exceptions |
private const int fwXml_PARSING_DOWNORACROSS = 0 |
fwXml_PARSING_DOWNORACROSS
Constant used in calculating the type of 'callback' that needs to be executed! This directive specifiy the 'callbacks' to be executed when parsing down or across for leave-nodes.
private const int fwXml_PARSING_WHEN_LEAVING = 1 |
fwXml_PARSING_DOWNORACROSS
Constant used in calculating the type of 'callback' that needs to be executed! This directive specifiy the 'callbacks' to be executed when parsing up, which means leaving the node.
const int fwXml_SAXSTARTELEMENT = 2 |
fwXml_SAXSTARTELEMENT
Constant used in the mapping that associates the user-defined callback to the start of an Xml element-node
const int fwXml_SAXENDELEMENT = 3 |
fwXml_SAXENDELEMENT
Constant used in the mapping that associates the user-defined callback to the end of an Xml element-node
const int fwXml_SAXTEXT = 6 |
fwXml_SAXTEXT
Constant used in the mapping that associates the user-defined callback to an Xml text-node
const int fwXml_CONTAINS_SIMPLE_ELEMENT_NODES = 0 |
fwXml_CONTAINS_SIMPLE_ELEMENT_NODES
The constants used to check the return-code of the 'fwXml_childNodesContent' function. One needs to OR those flags together and pass it as the 'requestedTypes' parameter in the call to 'fwXml_containsNodeTypes'. The return-value of the function 'fwXml_childNodesContent' is then passed as the 'setOfTypes' parameter in the same call to 'fwXml_containsNodeTypes'.
const int fwXml_CONTAINS_TEXT_NODES = 8 |
fwXml_CONTAINS_TEXT_NODES
The constants used to check the return-code of the 'fwXml_childNodesContent' function. One needs to OR those flags together and pass it as the 'requestedTypes' parameter in the call to 'fwXml_containsNodeTypes'. The return-value of the function 'fwXml_childNodesContent' is then passed as the 'setOfTypes' parameter in the same call to 'fwXml_containsNodeTypes'.
const int fwXml_CONTAINS_COMMENT_NODES = 256 |
fwXml_CONTAINS_COMMENT_NODES
The constants used to check the return-code of the 'fwXml_childNodesContent' function. One needs to OR those flags together and pass it as the 'requestedTypes' parameter in the call to 'fwXml_containsNodeTypes'. The return-value of the function 'fwXml_childNodesContent' is then passed as the 'setOfTypes' parameter in the same call to 'fwXml_containsNodeTypes'.
const int fwXml_CONTAINS_COMPLEX_ELEMENT_NODES = 2 |
fwXml_CONTAINS_COMPLEX_ELEMENT_NODES
The constants used to check the return-code of the 'fwXml_childNodesContent' function. One needs to OR those flags together and pass it as the 'requestedTypes' parameter in the call to 'fwXml_containsNodeTypes'. The return-value of the function 'fwXml_childNodesContent' is then passed as the 'setOfTypes' parameter in the same call to 'fwXml_containsNodeTypes'.
const string fwXml_CHILDNODESTYPE = "fwXml_ChildNodesType" |
fwXml_CHILDNODESTYPE
Constant used in the mapping that identifies the node-type of the node in question
const string fwXml_CHILDSUBTREEID = "fwXml_ChildSubTreeId" |
fwXml_CHILDSUBTREEID
Constant used in the mapping that identifies the node-identifier of the node in question