Class Sarissa

Object
   |
   +--Sarissa

class Sarissa

Defined in sarissa.js

Field Detail

IS_ENABLED_SELECT_NODES

<static> Object IS_ENABLED_SELECT_NODES

IS_ENABLED_TRANSFORM_NODE

<static> Object IS_ENABLED_TRANSFORM_NODE

PARSED_EMPTY

<static> Object PARSED_EMPTY

PARSED_OK

<static> Object PARSED_OK

PARSED_UNKNOWN_ERROR

<static> Object PARSED_UNKNOWN_ERROR

Sarissa

Sarissa()

Sarissa is a utility class. Provides "static" methods for DOMDocument and XMLHTTP objects, DOM Node serializatrion to XML strings and other goodies.

clearChildNodes

<static> void clearChildNodes(oNode)

Deletes all child nodes of the given node

Parameters:
oNode - the Node to empty

copyChildNodes

<static> void copyChildNodes(nodeFrom, nodeTo, bPreserveExisting)

Copies the childNodes of nodeFrom to nodeTo

Note: The second object's original content is deleted before the copy operation, unless you supply a true third parameter

Parameters:
nodeFrom - the Node to copy the childNodes from
nodeTo - the Node to copy the childNodes to
bPreserveExisting - whether to preserve the original content of nodeTo, default is false

escape

<static> Object escape(sXml)

Escape the given string chacters that correspond to the five predefined XML entities

Parameters:
sXml - the string to escape

getDomDocument

<static> Object getDomDocument(sUri, sName)

Factory method to obtain a new DOM Document object

Parameters:
sUri - the namespace of the root node (if any)
sUri - the local name of the root node (if any)

Returns:
a new DOM Document

getParseErrorText

<static> Object getParseErrorText(oDoc)

Returns a human readable description of the parsing error. Usefull for debugging. Tip: append the returned error string in a <pre> element if you want to render it.

Many thanks to Christian Stocker for the initial patch.

Parameters:
oDoc - The target DOM document

Returns:
The parsing error description of the target Document in human readable form (preformated text)

getText

<static> Object getText(oNode, deep)

moveChildNodes

<static> void moveChildNodes(nodeFrom, nodeTo, bPreserveExisting)

Moves the childNodes of nodeFrom to nodeTo

Note: The second object's original content is deleted before the move operation, unless you supply a true third parameter

Parameters:
nodeFrom - the Node to copy the childNodes from
nodeTo - the Node to copy the childNodes to
bPreserveExisting - whether to preserve the original content of nodeTo, default is

setXpathNamespaces

<static> void setXpathNamespaces(oDoc, sNsSet)

Programmatically control namespace URI/prefix mappings for XPath queries.

This method comes especially handy when used to apply XPath queries on XML documents with a default namespace, as there is no other way of mapping that to a prefix.

Using no namespace prefix in DOM Level 3 XPath queries, implies you are looking for elements in the null namespace. If you need to look for nodes in the default namespace, you need to map a prefix to it first like:

Sarissa.setXpathNamespaces(oDoc, "xmlns:myprefix=&aposhttp://mynsURI&apos");

Note 1 : Use this method only if the source document features a default namespace (without a prefix), otherwise just use IE's setProperty (moz will rezolve non-default namespaces by itself). You will need to map that namespace to a prefix for queries to work.

Note 2 : This method calls IE's setProperty method to set the appropriate namespace-prefix mappings, so you dont have to do that.

Parameters:
oDoc - The target XMLDocument to set the namespace mappings for.
sNsSet - A whilespace-seperated list of namespace declarations as those would appear in an XML document. E.g.: "xmlns:xhtml='http://www.w3.org/1999/xhtml' xmlns:'http://www.w3.org/1999/XSL/Transform'"

Throws:
- An error if the format of the given namespace declarations is bad.

setXslParameter

<static> Object setXslParameter(oXslDoc, sParamQName, sParamValue)

Deprecated (use XSLTProcessor instead): Set xslt parameters.

Note that this method can only work for the main stylesheet and not any included/imported files.

Parameters:
oXslDoc - the target XSLT DOM Document
sParamValue - the value of the XSLT parameter
sParamName - the name of the XSLT parameter

Returns:
whether the parameter was set succefully

Deprecated use the XSLTProcessor instead

stripTags

<static> Object stripTags(s)

strips tags from a markup string

unescape

<static> Object unescape(sXml)

Unescape the given string. This turns the occurences of the predefined XML entities to become the characters they represent correspond to the five predefined XML entities

Parameters:
sXml - the string to unescape

updateContentFromNode

<static> void updateContentFromNode(oNode, oTargetElement, xsltproc, callback)

Update an element's content with the given DOM node. Passing a configured XSLT processor will result in transforming and updating oNode before using it to update oTargetElement. You can also pass a callback function to be executed when the update is finished. The function will be called as functionName(oNode, oTargetElement);

Parameters:
oNode - the URL to make the request to
oTargetElement - the element to update
xsltproc - (optional) the transformer to use on the given DOM node before updating the target element with it
callback - (optional) a Function object to execute once the update is finished successfuly, called as callback(oNode, oTargetElement)

updateContentFromURI

<static> void updateContentFromURI(sFromUrl, oTargetElement, xsltproc, callback, skipCache)

Update an element with response of a GET request on the given URL. Passing a configured XSLT processor will result in transforming and updating oNode before using it to update oTargetElement. You can also pass a callback function to be executed when the update is finished. The function will be called as functionName(oNode, oTargetElement);

Parameters:
sFromUrl - the URL to make the request to
oTargetElement - the element to update
xsltproc - (optional) the transformer to use on the returned content before updating the target element with it
callback - (optional) a Function object to execute once the update is finished successfuly, called as callback(oNode, oTargetElement)
skipCache - (optional) whether to skip any cache

xmlize

<static> Object xmlize(anyObject, objectName, indentSpace)

Serialize any object to an XML string. All properties are serialized using the property name as the XML element name. Array elements are rendered as array-item elements, using their index/key as the value of the key attribute.

Parameters:
anyObject - the object to serialize
objectName - a name for that object

Returns:
the XML serializationj of the given object as a string