Class PTXMLWrapper

Object
   |
   +--PTXMLWrapper

class PTXMLWrapper

Deprecated wrapper class providing a single API for accessing a sub-set of the XML parser functionality provided by MSXML, the Netscape 6 DOMParser, and the PTXMLParser (use PTXMLDocument instead).
Deprecated This class has been deprecated. Use PTXMLDocument instead. Author Patrick Corcoran

Defined in PTXMLWrapper.js

Requires:

- PTXMLParser

Field Detail

defaultPreferredParsers

<private> Object defaultPreferredParsers

parser

<private> Object parser

parserString

<private> Object parserString

uidIndex

<private> Object uidIndex

xmlTestString

<private> Object xmlTestString

NODE_ATTRIBUTE

<static> <final> Number NODE_ATTRIBUTE

Represents an element attribtute XML node

See Also:

Constant Field Values

NODE_CDATA_SECTION

<static> <final> Number NODE_CDATA_SECTION

Represents a CDATA node

See Also:

Constant Field Values

NODE_COMMENT

<static> <final> Number NODE_COMMENT

Represents a comment node

See Also:

Constant Field Values

NODE_DOCUMENT

<static> <final> Number NODE_DOCUMENT

Represents a document node

See Also:

Constant Field Values

NODE_DOCUMENT_FRAGMENT

<static> <final> Number NODE_DOCUMENT_FRAGMENT

Represents a document fragment node

See Also:

Constant Field Values

NODE_DOCUMENT_TYPE

<static> <final> Number NODE_DOCUMENT_TYPE

Represents a document type node

See Also:

Constant Field Values

NODE_ELEMENT

<static> <final> Number NODE_ELEMENT

Represents an element node

See Also:

Constant Field Values

NODE_ENTITY

<static> <final> Number NODE_ENTITY

Represents a entity reference node

See Also:

Constant Field Values

NODE_ENTITY_REFERENCE

<static> <final> Number NODE_ENTITY_REFERENCE

Represents a entity node

See Also:

Constant Field Values

NODE_NOTATION

<static> <final> Number NODE_NOTATION

Represents a notation node

See Also:

Constant Field Values

NODE_PROCESSING_INSTRUCTION

<static> <final> Number NODE_PROCESSING_INSTRUCTION

Represents a processing instruction node

See Also:

Constant Field Values

NODE_TEXT

<static> <final> Number NODE_TEXT

Represents a text node

See Also:

Constant Field Values

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTXMLWrapper

PTXMLWrapper()

PTXMLWrapper Object constructor

Returns:
New PTXMLWrapper Object.

Deprecated This class has been deprecated. Use PTXMLDocument instead. Author Patrick Corcoran

Requires:
- PTXMLParser

checkMSIEParsers

 <private> Object checkMSIEParsers(ignoreNamespaces,requireXSL)

cloneNode

Object cloneNode(node)

Copies a new element from an existing element in an XML DOM

Parameters:
node - the node to be cloned

Returns:
a reference to the new node

createNewNodeUIDs

Object createNewNodeUIDs(node)

Creates a UIDs for each nodes in a node hierarchy. This method is only for MSIE/NS6+, it will not work in PTXML

Parameters:
node - the starting node to create new node UIDs.

Returns:
the node argument with the addition of a unique id.

createNode

Element createNode(node,name,val)

Creates a new element in the XML

Parameters:
node - node under which the new element will be appended
name - the name of the new element
value - the text value contained in the new element

Returns:
a reference to the new element

deleteNode

void deleteNode(node)

Removes a node from the node hierarchy and memory.

Parameters:
node - the node to be deleted

deleteNodeByUID

 <private> void deleteNodeByUID(xmlObject,uid)

This method is broken right now in MSIE -- DO NOT USE

genXML

String genXML(xmlObject)

Generates the XML contained in an object's DOM hierarchy

Parameters:
xmlObject - an DOM XML object

Returns:
an XML string

getAttribute

Object getAttribute(node,val)

Gets the value of the specified attribute from the specified node

Parameters:
node - the node with the requested attribute
val - the name of the attribute

Returns:
the value of the attribute

getElementsByTagName

Array getElementsByTagName(node,tagName)

Get elements by tag name

Parameters:
node - the starting node to search for elements
tagName - the name of the element's tag

Returns:
an Array of Elements having the specified tag name

getNodeByUID

Object getNodeByUID(uid,node)

Returns the node possessing the specified unique id

Parameters:
uid - the unique id
node - the root node to start searching for the unique id.

Returns:
a node with the unique id specified

getNodeName

String getNodeName(node)

Gets the name of the node, if any.

Parameters:
node - the node

Returns:
the name of the node.

getNodeValue

Object getNodeValue(node)

Gets the value of the contents of a node. This value will depend on the type of node. Text nodes return their text values, while attribute nodes return their attribute values.

Parameters:
node - a valued node

Returns:
the value of the node

getUID

String getUID(node)

Gets the unique id associated with a node

Parameters:
node - the node

Returns:
a unique id

init

void init(pref,ignoreNamespaces,requireXSL)

Initializes the PTXMLWrapper

Parameters:
pref - preferred parser type (MSXML, NS6, PTXML)
ignoreNamespaces - ignore XML namespaces in XML to be parsed
requireXSL - true if the parser requires an XSL document

newXMLFromString

Object newXMLFromString(str)

Returns a parser object loaded with the specified XML string

Parameters:
str - an XML string

Returns:
a parser object appropriate to the browser

recurseAndCreateNewNodeUIDs

 <private> Object recurseAndCreateNewNodeUIDs(node)

This method is only for MSIE/NS6+, it will not work in PTXML

recurseAndFindNodeByUID

 <private> Object recurseAndFindNodeByUID(node,uid)

selectSingleNode

Object selectSingleNode(node,val)

Applies a XPath query value to a node context to retrieve a single Node from a DOM hierarchy. Extends the PTXMLDocument to emulate IE's selectSingleNode.

Parameters:
node - the starting node for the XPath query
val - an XPath query parameter of the form "/node/subnode/subsubnode/"

Returns:
a single node pointed to by the XPath query parameter

setNodeValue

void setNodeValue(node,val)

Sets the value of a node

Parameters:
node - the node
value - the value to set on the node

stripPreXML

<static>  <private> String stripPreXML(str)

This method will remove anything before the xml declaration, since the gateway may try and throw script tags before the xml.

Parameters:
str - the input string

Returns:
a cleaned XML string

unescapeCDATAs

<static>  <private> String unescapeCDATAs(str)

Unescapes CDATA sections

Parameters:
str - the input string

Returns:
a string with unescaped CDATA declarations