<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!--NewPage--> | |
<HTML> | |
<HEAD> | |
<!-- Generated by javadoc (build 1.5.0_18) on Sun Apr 01 21:18:38 PDT 2012 --> | |
<TITLE> | |
DOMHelper | |
</TITLE> | |
<META NAME="keywords" CONTENT="org.apache.xml.utils.DOMHelper class"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
parent.document.title="DOMHelper"; | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<A NAME="navbar_top"><!-- --></A> | |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_top_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DOMHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../org/apache/xml/utils/DOMBuilder.html" title="class in org.apache.xml.utils"><B>PREV CLASS</B></A> | |
<A HREF="../../../../org/apache/xml/utils/DOMOrder.html" title="interface in org.apache.xml.utils"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../index.html?org/apache/xml/utils/DOMHelper.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="DOMHelper.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_top"></A> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<HR> | |
<!-- ======== START OF CLASS DATA ======== --> | |
<H2> | |
<FONT SIZE="-1"> | |
org.apache.xml.utils</FONT> | |
<BR> | |
Class DOMHelper</H2> | |
<PRE> | |
java.lang.Object | |
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xml.utils.DOMHelper</B> | |
</PRE> | |
<DL> | |
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/xml/utils/DOM2Helper.html" title="class in org.apache.xml.utils">DOM2Helper</A></DD> | |
</DL> | |
<HR> | |
<B>Deprecated.</B> <I>Since the introduction of the DTM, this class will be removed. | |
This class provides a front-end to DOM implementations, providing | |
a number of utility functions that either aren't yet standardized | |
by the DOM spec or that are defined in optional DOM modules and | |
hence may not be present in all DOMs.</I> | |
<P> | |
<DL> | |
<DT><PRE>public class <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.52"><B>DOMHelper</B></A><DT>extends java.lang.Object</DL> | |
</PRE> | |
<P> | |
<HR> | |
<P> | |
<!-- =========== FIELD SUMMARY =========== --> | |
<A NAME="field_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Field Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected java.util.Vector</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#m_candidateNoAncestorXMLNS">m_candidateNoAncestorXMLNS</A></B></CODE> | |
<BR> | |
<B>Deprecated.</B> Vector of node (odd indexes) and NSInfos (even indexes) that tell if | |
the given node is a candidate for ancestor namespace processing.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected org.w3c.dom.Document</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#m_DOMFactory">m_DOMFactory</A></B></CODE> | |
<BR> | |
<B>Deprecated.</B> The factory object used for creating nodes | |
in the result tree.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected static <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#m_NSInfoNullNoAncestorXMLNS">m_NSInfoNullNoAncestorXMLNS</A></B></CODE> | |
<BR> | |
<B>Deprecated.</B> Object to put into the m_NSInfos table that tells that a node has been | |
processed, and has no xmlns namespace decls.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected static <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#m_NSInfoNullWithoutXMLNS">m_NSInfoNullWithoutXMLNS</A></B></CODE> | |
<BR> | |
<B>Deprecated.</B> Object to put into the m_NSInfos table that tells that a node has been | |
processed, and has no xmlns namespace decls.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected static <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#m_NSInfoNullWithXMLNS">m_NSInfoNullWithXMLNS</A></B></CODE> | |
<BR> | |
<B>Deprecated.</B> Object to put into the m_NSInfos table that tells that a node has been | |
processed, and has xmlns namespace decls.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>(package private) java.util.Hashtable</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#m_NSInfos">m_NSInfos</A></B></CODE> | |
<BR> | |
<B>Deprecated.</B> An experiment for the moment.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected static <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#m_NSInfoUnProcNoAncestorXMLNS">m_NSInfoUnProcNoAncestorXMLNS</A></B></CODE> | |
<BR> | |
<B>Deprecated.</B> Object to put into the m_NSInfos table that tells that a node has not been | |
processed, and has no xmlns namespace decls, and has no ancestor decls.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected static <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#m_NSInfoUnProcWithoutXMLNS">m_NSInfoUnProcWithoutXMLNS</A></B></CODE> | |
<BR> | |
<B>Deprecated.</B> Object to put into the m_NSInfos table that tells that a node has not been | |
processed, but has no xmlns namespace decls.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected static <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#m_NSInfoUnProcWithXMLNS">m_NSInfoUnProcWithXMLNS</A></B></CODE> | |
<BR> | |
<B>Deprecated.</B> Object to put into the m_NSInfos table that tells that a node has not been | |
processed, but has xmlns namespace decls.</TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
<A NAME="constructor_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Constructor Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#DOMHelper()">DOMHelper</A></B>()</CODE> | |
<BR> | |
<B>Deprecated.</B> </TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ========== METHOD SUMMARY =========== --> | |
<A NAME="method_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Method Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static org.w3c.dom.Document</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#createDocument()">createDocument</A></B>()</CODE> | |
<BR> | |
<B>Deprecated.</B> DOM Level 1 did not have a standard mechanism for creating a new | |
Document object.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static org.w3c.dom.Document</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#createDocument(boolean)">createDocument</A></B>(boolean isSecureProcessing)</CODE> | |
<BR> | |
<B>Deprecated.</B> DOM Level 1 did not have a standard mechanism for creating a new | |
Document object.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> org.w3c.dom.Document</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getDOMFactory()">getDOMFactory</A></B>()</CODE> | |
<BR> | |
<B>Deprecated.</B> Retrieve the factory object required to create DOM nodes | |
in the result tree.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> org.w3c.dom.Element</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getElementByID(java.lang.String, org.w3c.dom.Document)">getElementByID</A></B>(java.lang.String id, | |
org.w3c.dom.Document doc)</CODE> | |
<BR> | |
<B>Deprecated.</B> Given an ID, return the element.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getExpandedAttributeName(org.w3c.dom.Attr)">getExpandedAttributeName</A></B>(org.w3c.dom.Attr attr)</CODE> | |
<BR> | |
<B>Deprecated.</B> Returns the attribute name with the namespace prefix (if any) replaced | |
by the Namespace URI it was bound to.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getExpandedElementName(org.w3c.dom.Element)">getExpandedElementName</A></B>(org.w3c.dom.Element elem)</CODE> | |
<BR> | |
<B>Deprecated.</B> Returns the element name with the namespace prefix (if any) replaced | |
by the Namespace URI it was bound to.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> short</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getLevel(org.w3c.dom.Node)">getLevel</A></B>(org.w3c.dom.Node n)</CODE> | |
<BR> | |
<B>Deprecated.</B> Get the depth level of this node in the tree (equals 1 for | |
a parentless node).</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getLocalNameOfNode(org.w3c.dom.Node)">getLocalNameOfNode</A></B>(org.w3c.dom.Node n)</CODE> | |
<BR> | |
<B>Deprecated.</B> Returns the local name of the given node.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getNamespaceForPrefix(java.lang.String, org.w3c.dom.Element)">getNamespaceForPrefix</A></B>(java.lang.String prefix, | |
org.w3c.dom.Element namespaceContext)</CODE> | |
<BR> | |
<B>Deprecated.</B> Given an XML Namespace prefix and a context in which the prefix | |
is to be evaluated, return the Namespace Name this prefix was | |
bound to.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getNamespaceOfNode(org.w3c.dom.Node)">getNamespaceOfNode</A></B>(org.w3c.dom.Node n)</CODE> | |
<BR> | |
<B>Deprecated.</B> Returns the namespace of the given node.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getNodeData(org.w3c.dom.Node)">getNodeData</A></B>(org.w3c.dom.Node node)</CODE> | |
<BR> | |
<B>Deprecated.</B> Get the textual contents of the node.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getNodeData(org.w3c.dom.Node, org.apache.xml.utils.FastStringBuffer)">getNodeData</A></B>(org.w3c.dom.Node node, | |
<A HREF="../../../../org/apache/xml/utils/FastStringBuffer.html" title="class in org.apache.xml.utils">FastStringBuffer</A> buf)</CODE> | |
<BR> | |
<B>Deprecated.</B> Retrieve the text content of a DOM subtree, appending it into a | |
user-supplied FastStringBuffer object.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static org.w3c.dom.Node</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getParentOfNode(org.w3c.dom.Node)">getParentOfNode</A></B>(org.w3c.dom.Node node)</CODE> | |
<BR> | |
<B>Deprecated.</B> Obtain the XPath-model parent of a DOM node -- ownerElement for Attrs, | |
parent for other nodes.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> org.w3c.dom.Node</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getRoot(org.w3c.dom.Node)">getRoot</A></B>(org.w3c.dom.Node node)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I></I> </TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> org.w3c.dom.Node</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getRootNode(org.w3c.dom.Node)">getRootNode</A></B>(org.w3c.dom.Node n)</CODE> | |
<BR> | |
<B>Deprecated.</B> Get the root node of the document tree, regardless of | |
whether or not the node passed in is a document node.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getUniqueID(org.w3c.dom.Node)">getUniqueID</A></B>(org.w3c.dom.Node node)</CODE> | |
<BR> | |
<B>Deprecated.</B> Supports the XPath function GenerateID by returning a unique | |
identifier string for any given DOM Node.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getUnparsedEntityURI(java.lang.String, org.w3c.dom.Document)">getUnparsedEntityURI</A></B>(java.lang.String name, | |
org.w3c.dom.Document doc)</CODE> | |
<BR> | |
<B>Deprecated.</B> The getUnparsedEntityURI function returns the URI of the unparsed | |
entity with the specified name in the same document as the context | |
node (see [3.3 Unparsed Entities]).</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#isIgnorableWhitespace(org.w3c.dom.Text)">isIgnorableWhitespace</A></B>(org.w3c.dom.Text node)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I></I> </TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#isNamespaceNode(org.w3c.dom.Node)">isNamespaceNode</A></B>(org.w3c.dom.Node n)</CODE> | |
<BR> | |
<B>Deprecated.</B> Test whether the given node is a namespace decl node.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#isNodeAfter(org.w3c.dom.Node, org.w3c.dom.Node)">isNodeAfter</A></B>(org.w3c.dom.Node node1, | |
org.w3c.dom.Node node2)</CODE> | |
<BR> | |
<B>Deprecated.</B> Figure out whether node2 should be considered as being later | |
in the document than node1, in Document Order as defined | |
by the XPath model.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private static boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#isNodeAfterSibling(org.w3c.dom.Node, org.w3c.dom.Node, org.w3c.dom.Node)">isNodeAfterSibling</A></B>(org.w3c.dom.Node parent, | |
org.w3c.dom.Node child1, | |
org.w3c.dom.Node child2)</CODE> | |
<BR> | |
<B>Deprecated.</B> Figure out if child2 is after child1 in document order.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#isNodeTheSame(org.w3c.dom.Node, org.w3c.dom.Node)">isNodeTheSame</A></B>(org.w3c.dom.Node node1, | |
org.w3c.dom.Node node2)</CODE> | |
<BR> | |
<B>Deprecated.</B> Use DTMNodeProxy to determine whether two nodes are the same.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private static org.w3c.dom.Node</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#locateAttrParent(org.w3c.dom.Element, org.w3c.dom.Node)">locateAttrParent</A></B>(org.w3c.dom.Element elem, | |
org.w3c.dom.Node attr)</CODE> | |
<BR> | |
<B>Deprecated.</B> Support for getParentOfNode; walks a DOM tree until it finds | |
the Element which owns the Attr.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#setDOMFactory(org.w3c.dom.Document)">setDOMFactory</A></B>(org.w3c.dom.Document domFactory)</CODE> | |
<BR> | |
<B>Deprecated.</B> Store the factory object required to create DOM nodes | |
in the result tree.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#shouldStripSourceNode(org.w3c.dom.Node)">shouldStripSourceNode</A></B>(org.w3c.dom.Node textNode)</CODE> | |
<BR> | |
<B>Deprecated.</B> Tells, through the combination of the default-space attribute | |
on xsl:stylesheet, xsl:strip-space, xsl:preserve-space, and the | |
xml:space attribute, whether or not extra whitespace should be stripped | |
from the node.</TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> | |
</TR> | |
</TABLE> | |
| |
<P> | |
<!-- ============ FIELD DETAIL =========== --> | |
<A NAME="field_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Field Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="m_NSInfos"><!-- --></A><H3> | |
m_NSInfos</H3> | |
<PRE> | |
java.util.Hashtable <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.566"><B>m_NSInfos</B></A></PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>An experiment for the moment. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="m_NSInfoUnProcWithXMLNS"><!-- --></A><H3> | |
m_NSInfoUnProcWithXMLNS</H3> | |
<PRE> | |
protected static final <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A> <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.570"><B>m_NSInfoUnProcWithXMLNS</B></A></PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Object to put into the m_NSInfos table that tells that a node has not been | |
processed, but has xmlns namespace decls. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="m_NSInfoUnProcWithoutXMLNS"><!-- --></A><H3> | |
m_NSInfoUnProcWithoutXMLNS</H3> | |
<PRE> | |
protected static final <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A> <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.575"><B>m_NSInfoUnProcWithoutXMLNS</B></A></PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Object to put into the m_NSInfos table that tells that a node has not been | |
processed, but has no xmlns namespace decls. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="m_NSInfoUnProcNoAncestorXMLNS"><!-- --></A><H3> | |
m_NSInfoUnProcNoAncestorXMLNS</H3> | |
<PRE> | |
protected static final <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A> <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.580"><B>m_NSInfoUnProcNoAncestorXMLNS</B></A></PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Object to put into the m_NSInfos table that tells that a node has not been | |
processed, and has no xmlns namespace decls, and has no ancestor decls. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="m_NSInfoNullWithXMLNS"><!-- --></A><H3> | |
m_NSInfoNullWithXMLNS</H3> | |
<PRE> | |
protected static final <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A> <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.585"><B>m_NSInfoNullWithXMLNS</B></A></PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Object to put into the m_NSInfos table that tells that a node has been | |
processed, and has xmlns namespace decls. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="m_NSInfoNullWithoutXMLNS"><!-- --></A><H3> | |
m_NSInfoNullWithoutXMLNS</H3> | |
<PRE> | |
protected static final <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A> <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.590"><B>m_NSInfoNullWithoutXMLNS</B></A></PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Object to put into the m_NSInfos table that tells that a node has been | |
processed, and has no xmlns namespace decls. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="m_NSInfoNullNoAncestorXMLNS"><!-- --></A><H3> | |
m_NSInfoNullNoAncestorXMLNS</H3> | |
<PRE> | |
protected static final <A HREF="../../../../org/apache/xml/utils/NSInfo.html" title="class in org.apache.xml.utils">NSInfo</A> <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.595"><B>m_NSInfoNullNoAncestorXMLNS</B></A></PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Object to put into the m_NSInfos table that tells that a node has been | |
processed, and has no xmlns namespace decls. and has no ancestor decls. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="m_candidateNoAncestorXMLNS"><!-- --></A><H3> | |
m_candidateNoAncestorXMLNS</H3> | |
<PRE> | |
protected java.util.Vector <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.600"><B>m_candidateNoAncestorXMLNS</B></A></PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Vector of node (odd indexes) and NSInfos (even indexes) that tell if | |
the given node is a candidate for ancestor namespace processing. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="m_DOMFactory"><!-- --></A><H3> | |
m_DOMFactory</H3> | |
<PRE> | |
protected org.w3c.dom.Document <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.1223"><B>m_DOMFactory</B></A></PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>The factory object used for creating nodes | |
in the result tree. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<!-- ========= CONSTRUCTOR DETAIL ======== --> | |
<A NAME="constructor_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Constructor Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="DOMHelper()"><!-- --></A><H3> | |
DOMHelper</H3> | |
<PRE> | |
public <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.52"><B>DOMHelper</B></A>()</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> </DL> | |
<!-- ============ METHOD DETAIL ========== --> | |
<A NAME="method_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Method Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="createDocument(boolean)"><!-- --></A><H3> | |
createDocument</H3> | |
<PRE> | |
public static org.w3c.dom.Document <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.77"><B>createDocument</B></A>(boolean isSecureProcessing)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>DOM Level 1 did not have a standard mechanism for creating a new | |
Document object. This function provides a DOM-implementation-independent | |
abstraction for that for that concept. It's typically used when | |
outputting a new DOM as the result of an operation. | |
<p> | |
TODO: This isn't directly compatable with DOM Level 2. | |
The Level 2 createDocument call also creates the root | |
element, and thus requires that you know what that element will be | |
before creating the Document. We should think about whether we want | |
to change this code, and the callers, so we can use the DOM's own | |
method. (It's also possible that DOM Level 3 may relax this | |
sequence, but you may give up some intelligence in the DOM by | |
doing so; the intent was that knowing the document type and root | |
element might let the DOM automatically switch to a specialized | |
subclass for particular kinds of documents.) | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>isSecureProcessing</CODE> - state of the secure processing feature. | |
<DT><B>Returns:</B><DD>The newly created DOM Document object, with no children, or | |
null if we can't find a DOM implementation that permits creating | |
new empty Documents.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="createDocument()"><!-- --></A><H3> | |
createDocument</H3> | |
<PRE> | |
public static org.w3c.dom.Document <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.124"><B>createDocument</B></A>()</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>DOM Level 1 did not have a standard mechanism for creating a new | |
Document object. This function provides a DOM-implementation-independent | |
abstraction for that for that concept. It's typically used when | |
outputting a new DOM as the result of an operation. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>The newly created DOM Document object, with no children, or | |
null if we can't find a DOM implementation that permits creating | |
new empty Documents.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="shouldStripSourceNode(org.w3c.dom.Node)"><!-- --></A><H3> | |
shouldStripSourceNode</H3> | |
<PRE> | |
public boolean <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.141"><B>shouldStripSourceNode</B></A>(org.w3c.dom.Node textNode) | |
throws javax.xml.transform.TransformerException</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Tells, through the combination of the default-space attribute | |
on xsl:stylesheet, xsl:strip-space, xsl:preserve-space, and the | |
xml:space attribute, whether or not extra whitespace should be stripped | |
from the node. Literal elements from template elements should | |
<em>not</em> be tested with this function. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>textNode</CODE> - A text node from the source tree. | |
<DT><B>Returns:</B><DD>true if the text node should be stripped of extra whitespace. | |
<DT><B>Throws:</B> | |
<DD><CODE>javax.xml.transform.TransformerException</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getUniqueID(org.w3c.dom.Node)"><!-- --></A><H3> | |
getUniqueID</H3> | |
<PRE> | |
public java.lang.String <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.174"><B>getUniqueID</B></A>(org.w3c.dom.Node node)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Supports the XPath function GenerateID by returning a unique | |
identifier string for any given DOM Node. | |
<p> | |
Warning: The base implementation uses the Node object's hashCode(), | |
which is NOT guaranteed to be unique. If that method hasn't been | |
overridden in this DOM ipmlementation, most Java implementions will | |
derive it from the object's address and should be OK... but if | |
your DOM uses a different definition of hashCode (eg hashing the | |
contents of the subtree), or if your DOM may have multiple objects | |
that represent a single Node in the data structure (eg via proxying), | |
you may need to find another way to assign a unique identifier. | |
<p> | |
Also, be aware that if nodes are destroyed and recreated, there is | |
an open issue regarding whether an ID may be reused. Currently | |
we're assuming that the input document is stable for the duration | |
of the XPath/XSLT operation, so this shouldn't arise in this context. | |
<p> | |
(DOM Level 3 is investigating providing a unique node "key", but | |
that won't help Level 1 and Level 2 implementations.) | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>node</CODE> - whose identifier you want to obtain | |
<DT><B>Returns:</B><DD>a string which should be different for every Node object.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isNodeAfter(org.w3c.dom.Node, org.w3c.dom.Node)"><!-- --></A><H3> | |
isNodeAfter</H3> | |
<PRE> | |
public static boolean <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.197"><B>isNodeAfter</B></A>(org.w3c.dom.Node node1, | |
org.w3c.dom.Node node2)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Figure out whether node2 should be considered as being later | |
in the document than node1, in Document Order as defined | |
by the XPath model. This may not agree with the ordering defined | |
by other XML applications. | |
<p> | |
There are some cases where ordering isn't defined, and neither are | |
the results of this function -- though we'll generally return true. | |
TODO: Make sure this does the right thing with attribute nodes!!! | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>node1</CODE> - DOM Node to perform position comparison on.<DD><CODE>node2</CODE> - DOM Node to perform position comparison on . | |
<DT><B>Returns:</B><DD>false if node2 comes before node1, otherwise return true. | |
You can think of this as | |
<code>(node1.documentOrderPosition <= node2.documentOrderPosition)</code>.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isNodeTheSame(org.w3c.dom.Node, org.w3c.dom.Node)"><!-- --></A><H3> | |
isNodeTheSame</H3> | |
<PRE> | |
public static boolean <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.332"><B>isNodeTheSame</B></A>(org.w3c.dom.Node node1, | |
org.w3c.dom.Node node2)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Use DTMNodeProxy to determine whether two nodes are the same. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>node1</CODE> - The first DOM node to compare.<DD><CODE>node2</CODE> - The second DOM node to compare. | |
<DT><B>Returns:</B><DD>true if the two nodes are the same.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isNodeAfterSibling(org.w3c.dom.Node, org.w3c.dom.Node, org.w3c.dom.Node)"><!-- --></A><H3> | |
isNodeAfterSibling</H3> | |
<PRE> | |
private static boolean <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.354"><B>isNodeAfterSibling</B></A>(org.w3c.dom.Node parent, | |
org.w3c.dom.Node child1, | |
org.w3c.dom.Node child2)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Figure out if child2 is after child1 in document order. | |
<p> | |
Warning: Some aspects of "document order" are not well defined. | |
For example, the order of attributes is considered | |
meaningless in XML, and the order reported by our model will | |
be consistant for a given invocation but may not | |
match that of either the source file or the serialized output. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>parent</CODE> - Must be the parent of both child1 and child2.<DD><CODE>child1</CODE> - Must be the child of parent and not equal to child2.<DD><CODE>child2</CODE> - Must be the child of parent and not equal to child1. | |
<DT><B>Returns:</B><DD>true if child 2 is after child1 in document order.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getLevel(org.w3c.dom.Node)"><!-- --></A><H3> | |
getLevel</H3> | |
<PRE> | |
public short <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.473"><B>getLevel</B></A>(org.w3c.dom.Node n)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Get the depth level of this node in the tree (equals 1 for | |
a parentless node). | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>n</CODE> - Node to be examined. | |
<DT><B>Returns:</B><DD>the number of ancestors, plus one</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getNamespaceForPrefix(java.lang.String, org.w3c.dom.Element)"><!-- --></A><H3> | |
getNamespaceForPrefix</H3> | |
<PRE> | |
public java.lang.String <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.505"><B>getNamespaceForPrefix</B></A>(java.lang.String prefix, | |
org.w3c.dom.Element namespaceContext)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Given an XML Namespace prefix and a context in which the prefix | |
is to be evaluated, return the Namespace Name this prefix was | |
bound to. Note that DOM Level 3 is expected to provide a version of | |
this which deals with the DOM's "early binding" behavior. | |
Default handling: | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - String containing namespace prefix to be resolved, | |
without the ':' which separates it from the localname when used | |
in a Node Name. The empty sting signifies the default namespace | |
at this point in the document.<DD><CODE>namespaceContext</CODE> - Element which provides context for resolution. | |
(We could extend this to work for other nodes by first seeking their | |
nearest Element ancestor.) | |
<DT><B>Returns:</B><DD>a String containing the Namespace URI which this prefix | |
represents in the specified context.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getNamespaceOfNode(org.w3c.dom.Node)"><!-- --></A><H3> | |
getNamespaceOfNode</H3> | |
<PRE> | |
public java.lang.String <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.614"><B>getNamespaceOfNode</B></A>(org.w3c.dom.Node n)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Returns the namespace of the given node. Differs from simply getting | |
the node's prefix and using getNamespaceForPrefix in that it attempts | |
to cache some of the data in NSINFO objects, to avoid repeated lookup. | |
TODO: Should we consider moving that logic into getNamespaceForPrefix? | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>n</CODE> - Node to be examined. | |
<DT><B>Returns:</B><DD>String containing the Namespace Name (uri) for this node. | |
Note that this is undefined for any nodes other than Elements and | |
Attributes.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getLocalNameOfNode(org.w3c.dom.Node)"><!-- --></A><H3> | |
getLocalNameOfNode</H3> | |
<PRE> | |
public java.lang.String <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.821"><B>getLocalNameOfNode</B></A>(org.w3c.dom.Node n)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Returns the local name of the given node. If the node's name begins | |
with a namespace prefix, this is the part after the colon; otherwise | |
it's the full node name. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>n</CODE> - the node to be examined. | |
<DT><B>Returns:</B><DD>String containing the Local Name</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getExpandedElementName(org.w3c.dom.Element)"><!-- --></A><H3> | |
getExpandedElementName</H3> | |
<PRE> | |
public java.lang.String <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.842"><B>getExpandedElementName</B></A>(org.w3c.dom.Element elem)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Returns the element name with the namespace prefix (if any) replaced | |
by the Namespace URI it was bound to. This is not a standard | |
representation of a node name, but it allows convenient | |
single-string comparison of the "universal" names of two nodes. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>elem</CODE> - Element to be examined. | |
<DT><B>Returns:</B><DD>String in the form "namespaceURI:localname" if the node | |
belongs to a namespace, or simply "localname" if it doesn't.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getExpandedAttributeName(org.w3c.dom.Attr)"><CODE>getExpandedAttributeName(org.w3c.dom.Attr)</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getExpandedAttributeName(org.w3c.dom.Attr)"><!-- --></A><H3> | |
getExpandedAttributeName</H3> | |
<PRE> | |
public java.lang.String <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.864"><B>getExpandedAttributeName</B></A>(org.w3c.dom.Attr attr)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Returns the attribute name with the namespace prefix (if any) replaced | |
by the Namespace URI it was bound to. This is not a standard | |
representation of a node name, but it allows convenient | |
single-string comparison of the "universal" names of two nodes. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>attr</CODE> - Attr to be examined | |
<DT><B>Returns:</B><DD>String in the form "namespaceURI:localname" if the node | |
belongs to a namespace, or simply "localname" if it doesn't.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getExpandedElementName(org.w3c.dom.Element)"><CODE>getExpandedElementName(org.w3c.dom.Element)</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isIgnorableWhitespace(org.w3c.dom.Text)"><!-- --></A><H3> | |
isIgnorableWhitespace</H3> | |
<PRE> | |
public boolean <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.893"><B>isIgnorableWhitespace</B></A>(org.w3c.dom.Text node)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I></I> | |
<P> | |
<DD>Tell if the node is ignorable whitespace. Note that this can | |
be determined only in the context of a DTD or other Schema, | |
and that DOM Level 2 has nostandardized DOM API which can | |
return that information. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>node</CODE> - Node to be examined | |
<DT><B>Returns:</B><DD>CURRENTLY HARDCODED TO FALSE, but should return true if | |
and only if the node is of type Text, contains only whitespace, | |
and does not appear as part of the #PCDATA content of an element. | |
(Note that determining this last may require allowing for | |
Entity References.)</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getRoot(org.w3c.dom.Node)"><!-- --></A><H3> | |
getRoot</H3> | |
<PRE> | |
public org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.915"><B>getRoot</B></A>(org.w3c.dom.Node node)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I></I> | |
<P> | |
<DD>Get the first unparented node in the ancestor chain. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>node</CODE> - Starting node, to specify which chain to chase | |
<DT><B>Returns:</B><DD>the topmost ancestor.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getRootNode(org.w3c.dom.Node)"><!-- --></A><H3> | |
getRootNode</H3> | |
<PRE> | |
public org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.947"><B>getRootNode</B></A>(org.w3c.dom.Node n)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Get the root node of the document tree, regardless of | |
whether or not the node passed in is a document node. | |
<p> | |
TODO: This doesn't handle DocumentFragments or "orphaned" subtrees | |
-- it's currently returning ownerDocument even when the tree is | |
not actually part of the main Document tree. We should either | |
rewrite the description to say that it finds the Document node, | |
or change the code to walk up the ancestor chain. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>n</CODE> - Node to be examined | |
<DT><B>Returns:</B><DD>the Document node. Note that this is not the correct answer | |
if n was (or was a child of) a DocumentFragment or an orphaned node, | |
as can arise if the DOM has been edited rather than being generated | |
by a parser.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isNamespaceNode(org.w3c.dom.Node)"><!-- --></A><H3> | |
isNamespaceNode</H3> | |
<PRE> | |
public boolean <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.964"><B>isNamespaceNode</B></A>(org.w3c.dom.Node n)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Test whether the given node is a namespace decl node. In DOM Level 2 | |
this can be done in a namespace-aware manner, but in Level 1 DOMs | |
it has to be done by testing the node name. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>n</CODE> - Node to be examined. | |
<DT><B>Returns:</B><DD>boolean -- true iff the node is an Attr whose name is | |
"xmlns" or has the "xmlns:" prefix.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getParentOfNode(org.w3c.dom.Node)"><!-- --></A><H3> | |
getParentOfNode</H3> | |
<PRE> | |
public static org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.1003"><B>getParentOfNode</B></A>(org.w3c.dom.Node node) | |
throws java.lang.RuntimeException</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Obtain the XPath-model parent of a DOM node -- ownerElement for Attrs, | |
parent for other nodes. | |
<p> | |
Background: The DOM believes that you must be your Parent's | |
Child, and thus Attrs don't have parents. XPath said that Attrs | |
do have their owning Element as their parent. This function | |
bridges the difference, either by using the DOM Level 2 ownerElement | |
function or by using a "silly and expensive function" in Level 1 | |
DOMs. | |
<p> | |
(There's some discussion of future DOMs generalizing ownerElement | |
into ownerNode and making it work on all types of nodes. This | |
still wouldn't help the users of Level 1 or Level 2 DOMs) | |
<p> | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>node</CODE> - Node whose XPath parent we want to obtain | |
<DT><B>Returns:</B><DD>the parent of the node, or the ownerElement if it's an | |
Attr node, or null if the node is an orphan. | |
<DT><B>Throws:</B> | |
<DD><CODE>java.lang.RuntimeException</CODE> - if the Document has no root element. | |
This can't arise if the Document was created | |
via the DOM Level 2 factory methods, but is possible if other | |
mechanisms were used to obtain it</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getElementByID(java.lang.String, org.w3c.dom.Document)"><!-- --></A><H3> | |
getElementByID</H3> | |
<PRE> | |
public org.w3c.dom.Element <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.1081"><B>getElementByID</B></A>(java.lang.String id, | |
org.w3c.dom.Document doc)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Given an ID, return the element. This can work only if the document | |
is interpreted in the context of a DTD or Schema, since otherwise | |
we don't know which attributes are or aren't IDs. | |
<p> | |
Note that DOM Level 1 had no ability to retrieve this information. | |
DOM Level 2 introduced it but does not promise that it will be | |
supported in all DOMs; those which can't support it will always | |
return null. | |
<p> | |
TODO: getElementByID is currently unimplemented. Support DOM Level 2? | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The unique identifier to be searched for.<DD><CODE>doc</CODE> - The document to search within. | |
<DT><B>Returns:</B><DD>CURRENTLY HARDCODED TO NULL, but it should be: | |
The node which has this unique identifier, or null if there | |
is no such node or this DOM can't reliably recognize it.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getUnparsedEntityURI(java.lang.String, org.w3c.dom.Document)"><!-- --></A><H3> | |
getUnparsedEntityURI</H3> | |
<PRE> | |
public java.lang.String <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.1121"><B>getUnparsedEntityURI</B></A>(java.lang.String name, | |
org.w3c.dom.Document doc)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>The getUnparsedEntityURI function returns the URI of the unparsed | |
entity with the specified name in the same document as the context | |
node (see [3.3 Unparsed Entities]). It returns the empty string if | |
there is no such entity. | |
<p> | |
XML processors may choose to use the System Identifier (if one | |
is provided) to resolve the entity, rather than the URI in the | |
Public Identifier. The details are dependent on the processor, and | |
we would have to support some form of plug-in resolver to handle | |
this properly. Currently, we simply return the System Identifier if | |
present, and hope that it a usable URI or that our caller can | |
map it to one. | |
TODO: Resolve Public Identifiers... or consider changing function name. | |
<p> | |
If we find a relative URI | |
reference, XML expects it to be resolved in terms of the base URI | |
of the document. The DOM doesn't do that for us, and it isn't | |
entirely clear whether that should be done here; currently that's | |
pushed up to a higher levelof our application. (Note that DOM Level | |
1 didn't store the document's base URI.) | |
TODO: Consider resolving Relative URIs. | |
<p> | |
(The DOM's statement that "An XML processor may choose to | |
completely expand entities before the structure model is passed | |
to the DOM" refers only to parsed entities, not unparsed, and hence | |
doesn't affect this function.) | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - A string containing the Entity Name of the unparsed | |
entity.<DD><CODE>doc</CODE> - Document node for the document to be searched. | |
<DT><B>Returns:</B><DD>String containing the URI of the Unparsed Entity, or an | |
empty string if no such entity exists.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="locateAttrParent(org.w3c.dom.Element, org.w3c.dom.Node)"><!-- --></A><H3> | |
locateAttrParent</H3> | |
<PRE> | |
private static org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.1187"><B>locateAttrParent</B></A>(org.w3c.dom.Element elem, | |
org.w3c.dom.Node attr)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Support for getParentOfNode; walks a DOM tree until it finds | |
the Element which owns the Attr. This is hugely expensive, and | |
if at all possible you should use the DOM Level 2 Attr.ownerElement() | |
method instead. | |
<p> | |
The DOM Level 1 developers expected that folks would keep track | |
of the last Element they'd seen and could recover the info from | |
that source. Obviously that doesn't work very well if the only | |
information you've been presented with is the Attr. The DOM Level 2 | |
getOwnerElement() method fixes that, but only for Level 2 and | |
later DOMs. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>elem</CODE> - Element whose subtree is to be searched for this Attr<DD><CODE>attr</CODE> - Attr whose owner is to be located. | |
<DT><B>Returns:</B><DD>the first Element whose attribute list includes the provided | |
attr. In modern DOMs, this will also be the only such Element. (Early | |
DOMs had some hope that Attrs might be sharable, but this idea has | |
been abandoned.)</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setDOMFactory(org.w3c.dom.Document)"><!-- --></A><H3> | |
setDOMFactory</H3> | |
<PRE> | |
public void <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.1233"><B>setDOMFactory</B></A>(org.w3c.dom.Document domFactory)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Store the factory object required to create DOM nodes | |
in the result tree. In fact, that's just the result tree's | |
Document node... | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>domFactory</CODE> - The DOM Document Node within whose context | |
the result tree will be built.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getDOMFactory()"><!-- --></A><H3> | |
getDOMFactory</H3> | |
<PRE> | |
public org.w3c.dom.Document <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.1244"><B>getDOMFactory</B></A>()</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Retrieve the factory object required to create DOM nodes | |
in the result tree. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>The result tree's DOM Document Node.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getNodeData(org.w3c.dom.Node)"><!-- --></A><H3> | |
getNodeData</H3> | |
<PRE> | |
public static java.lang.String <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.1266"><B>getNodeData</B></A>(org.w3c.dom.Node node)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Get the textual contents of the node. See | |
getNodeData(Node,FastStringBuffer) for discussion of how | |
whitespace nodes are handled. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>node</CODE> - DOM Node to be examined | |
<DT><B>Returns:</B><DD>String containing a concatenation of all the | |
textual content within that node.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/utils/DOMHelper.html#getNodeData(org.w3c.dom.Node, org.apache.xml.utils.FastStringBuffer)"><CODE>getNodeData(Node,FastStringBuffer)</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getNodeData(org.w3c.dom.Node, org.apache.xml.utils.FastStringBuffer)"><!-- --></A><H3> | |
getNodeData</H3> | |
<PRE> | |
public static void <A HREF="../../../../src-html/org/apache/xml/utils/DOMHelper.html#line.1303"><B>getNodeData</B></A>(org.w3c.dom.Node node, | |
<A HREF="../../../../org/apache/xml/utils/FastStringBuffer.html" title="class in org.apache.xml.utils">FastStringBuffer</A> buf)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DD>Retrieve the text content of a DOM subtree, appending it into a | |
user-supplied FastStringBuffer object. Note that attributes are | |
not considered part of the content of an element. | |
<p> | |
There are open questions regarding whitespace stripping. | |
Currently we make no special effort in that regard, since the standard | |
DOM doesn't yet provide DTD-based information to distinguish | |
whitespace-in-element-context from genuine #PCDATA. Note that we | |
should probably also consider xml:space if/when we address this. | |
DOM Level 3 may solve the problem for us. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>node</CODE> - Node whose subtree is to be walked, gathering the | |
contents of all Text or CDATASection nodes.<DD><CODE>buf</CODE> - FastStringBuffer into which the contents of the text | |
nodes are to be concatenated.</DL> | |
</DD> | |
</DL> | |
<!-- ========= END OF CLASS DATA ========= --> | |
<HR> | |
<!-- ======= START OF BOTTOM NAVBAR ====== --> | |
<A NAME="navbar_bottom"><!-- --></A> | |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_bottom_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DOMHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../org/apache/xml/utils/DOMBuilder.html" title="class in org.apache.xml.utils"><B>PREV CLASS</B></A> | |
<A HREF="../../../../org/apache/xml/utils/DOMOrder.html" title="interface in org.apache.xml.utils"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../index.html?org/apache/xml/utils/DOMHelper.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="DOMHelper.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_bottom"></A> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<HR> | |
</BODY> | |
</HTML> |