fromXML: Convert an XML node to an R type

fromXMLR Documentation

Convert an XML node to an R type

Description

Convert an XML node representing a Schema value to an S object. The different functions handle different types of SOAP objets. This also works on an XML string or filename. The fromSOAPArray supports the offset and position attributes for partially transmitted and sparse arrays. Currently, there are limits on the ....

Usage

fromXML(node, root = NULL, converters = SchemaPrimitiveConverters,
        append = TRUE, type = NULL, multiRefs = list(),
         namespaces = gatherNamespaceDefs(node))

Arguments

node

the XML node (and sub-nodes) giving the SOAP content. The fromSOAP function works recursively, operating on sub-nodes, etc. This argument is the individual node.

root

the top-most node of the XML “document” which is used for resolving href references within elements to other nodes. This doesn't change across the recursive calls.

converters

a named-list of functions. The names are used to find the appropriate converter for a non-array or non-struct SOAP object. The name comes from the value of the “xsi:type” attribute or from the string “xsd:<element name>” where element-name is the name of the XML node. This will become more advanced in the future. This allows user to provide call-specific customizations to the conversion rather than just relying on "global" method definitions.

append

a logical value indicating whether to merge the converters with the default SOAPPrimitiveConverters, or use them as is. This is available for covenience so that the caller doesn't have to perform the two-step merging herself.

type

an optional type identifier that if not specified is computed from the xsi:type attribute of the XML node (node) if available.

multiRefs

?

namespaces

a list of namespace information providing the mappings of the prefix to the namespace URI so that we can correctly resolve types such as "xsd:string".

Value

An R object corresponding to the information in the XML node. If there is a converter to create an instance of a class defined from the XML schema, then this is what is returned.

Author(s)

Duncan Temple Lang <duncan@wald.ucdavis.edu>

References

http://www.w3.org/TR/SOAP/ http://www.omegahat.org/SSOAP, http://www.omegahat.org/bugs.

See Also

The SSOAP package.


omegahat/XMLSchema documentation built on Jan. 17, 2024, 7:08 p.m.