OpenLayers. Format.XML

Read and write XML.  For cross-browser XML generation, use methods on an instance of the XML format class instead of on <code>document<end>.  The DOM creation and traversing methods exposed here all mimic the W3C XML DOM methods.  Create a new parser with the OpenLayers.Format.XML constructor.

Inherits from

Summary
Read and write XML.
Construct an XML parser.
Serialize a DOM node into a XML string.
Create a new element with namespace.
Create a text node.
Get a list of elements on a node given the namespace URI and local name.
Get an attribute node given the namespace URI and local name.
Get an attribute value given the namespace URI and local name.
Get the value of the first child node if it exists, or return an optional default string.
Concatenate the value of all child nodes if any exist, or return an optional default string.
Determine whether a node has a particular attribute matching the given name and namespace.

Constructor

OpenLayers. Format.XML

Construct an XML parser.  The parser is used to read and write XML.  Reading XML from a string returns a DOM element.  Writing XML from a DOM element returns a string.

Parameters

options{Object} Optional object whose properties will be set on the object.

Functions

write

write: function(node)

Serialize a DOM node into a XML string.

Parameters

node{DOMElement} A DOM node.

Returns

{String} The XML string representation of the input node.

createElementNS

createElementNS: function(uri,
name)

Create a new element with namespace.  This node can be appended to another node with the standard node.appendChild method.  For cross-browser support, this method must be used instead of document.createElementNS.

Parameters

uri{String} Namespace URI for the element.
name{String} The qualified name of the element (prefix:localname).

Returns

{Element} A DOM element with namespace.

createTextNode

createTextNode: function(text)

Create a text node.  This node can be appended to another node with the standard node.appendChild method.  For cross-browser support, this method must be used instead of document.createTextNode.

Parameters

text{String} The text of the node.

Returns

{DOMElement} A DOM text node.

getElementsByTagNameNS

getElementsByTagNameNS: function(node,
uri,
name)

Get a list of elements on a node given the namespace URI and local name.  To return all nodes in a given namespace, use ‘*’ for the name argument.  To return all nodes of a given (local) name, regardless of namespace, use ‘*’ for the uri argument.

Parameters

node{Element} Node on which to search for other nodes.
uri{String} Namespace URI.
name{String} Local name of the tag (without the prefix).

Returns

{NodeList} A node list or array of elements.

getAttributeNodeNS

getAttributeNodeNS: function(node,
uri,
name)

Get an attribute node given the namespace URI and local name.

Parameters

node{Element} Node on which to search for attribute nodes.
uri{String} Namespace URI.
name{String} Local name of the attribute (without the prefix).

Returns

{DOMElement} An attribute node or null if none found.

getAttributeNS

getAttributeNS: function(node,
uri,
name)

Get an attribute value given the namespace URI and local name.

Parameters

node{Element} Node on which to search for an attribute.
uri{String} Namespace URI.
name{String} Local name of the attribute (without the prefix).

Returns

{String} An attribute value or and empty string if none found.

getChildValue

getChildValue: function(node,
def)

Get the value of the first child node if it exists, or return an optional default string.  Returns an empty string if no first child exists and no default value is supplied.

Parameters

node{DOMElement} The element used to look for a first child value.
def{String} Optional string to return in the event that no first child value exists.

Returns

{String} The value of the first child of the given node.

concatChildValues

concatChildValues: function(node,
def)

Concatenate the value of all child nodes if any exist, or return an optional default string.  Returns an empty string if no children exist and no default value is supplied.  Not optimized for large numbers of child nodes.

Parameters

node{DOMElement} The element used to look for child values.
def{String} Optional string to return in the event that no child exist.

Returns

{String} The concatenated value of all child nodes of the given node.

hasAttributeNS

hasAttributeNS: function(node,
uri,
name)

Determine whether a node has a particular attribute matching the given name and namespace.

Parameters

node{Element} Node on which to search for an attribute.
uri{String} Namespace URI.
name{String} Local name of the attribute (without the prefix).

Returns

{Boolean} The node has an attribute matching the name and namespace.

write: function(node)
Serialize a DOM node into a XML string.
createElementNS: function(uri,
name)
Create a new element with namespace.
createTextNode: function(text)
Create a text node.
getElementsByTagNameNS: function(node,
uri,
name)
Get a list of elements on a node given the namespace URI and local name.
getAttributeNodeNS: function(node,
uri,
name)
Get an attribute node given the namespace URI and local name.
getAttributeNS: function(node,
uri,
name)
Get an attribute value given the namespace URI and local name.
getChildValue: function(node,
def)
Get the value of the first child node if it exists, or return an optional default string.
concatChildValues: function(node,
def)
Concatenate the value of all child nodes if any exist, or return an optional default string.
hasAttributeNS: function(node,
uri,
name)
Determine whether a node has a particular attribute matching the given name and namespace.
Construct an XML parser.
Base class for format reading/writing a variety of formats.