<!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.6.0_18) on Fri Dec 09 20:48:40 GMT 2011 -->
<TITLE>
Navigator
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Navigator";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= 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="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="../../../../../net/sf/saxon/tree/util/NamespaceResolverWithDefault.html" title="class in net.sf.saxon.tree.util"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/tree/util/Navigator.AncestorEnumeration.html" title="class in net.sf.saxon.tree.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/saxon/tree/util/Navigator.html" target="_top"><B>FRAMES</B></A>
<A HREF="Navigator.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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <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">
net.sf.saxon.tree.util</FONT>
<BR>
Class Navigator</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.tree.util.Navigator</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>Navigator</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
The Navigator class provides helper classes for navigating a tree, irrespective
of its implementation
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Michael H. Kay</DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.AncestorEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.AncestorEnumeration</A></B></CODE>
<BR>
General-purpose implementation of the ancestor and ancestor-or-self axes</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.AxisFilter.html" title="class in net.sf.saxon.tree.util">Navigator.AxisFilter</A></B></CODE>
<BR>
AxisFilter is an iterator that applies a NodeTest filter to
the nodes returned by an underlying AxisIterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.BaseEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.BaseEnumeration</A></B></CODE>
<BR>
BaseEnumeration is an abstract implementation of an AxisIterator, it
simplifies the implementation of the underlying AxisIterator by requiring
it to provide only two methods: advance(), and getAnother().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.DescendantEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.DescendantEnumeration</A></B></CODE>
<BR>
General-purpose implementation of the descendant and descendant-or-self axes,
in terms of the child axis.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.EmptyTextFilter.html" title="class in net.sf.saxon.tree.util">Navigator.EmptyTextFilter</A></B></CODE>
<BR>
EmptyTextFilter is an iterator that applies removes any zero-length text
nodes returned by an underlying AxisIterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.FollowingEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.FollowingEnumeration</A></B></CODE>
<BR>
General purpose implementation of the following axis, in terms of the
ancestor, child, and following-sibling axes</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.PrecedingEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.PrecedingEnumeration</A></B></CODE>
<BR>
Helper method to iterate over the preceding axis, or Saxon's internal
preceding-or-ancestor axis, by making use of the ancestor, descendant, and
preceding-sibling axes.</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 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#alphaKey(int)">alphaKey</A></B>(int value)</CODE>
<BR>
Construct an alphabetic key from an positive integer; the key collates in the same sequence
as the integer</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="../../../../../net/sf/saxon/tree/util/Navigator.html#appendSequentialKey(net.sf.saxon.tree.wrapper.SiblingCountingNode, net.sf.saxon.tree.util.FastStringBuffer, boolean)">appendSequentialKey</A></B>(<A HREF="../../../../../net/sf/saxon/tree/wrapper/SiblingCountingNode.html" title="interface in net.sf.saxon.tree.wrapper">SiblingCountingNode</A> node,
<A HREF="../../../../../net/sf/saxon/tree/util/FastStringBuffer.html" title="class in net.sf.saxon.tree.util">FastStringBuffer</A> sb,
boolean addDocNr)</CODE>
<BR>
Get a character string that uniquely identifies this node and that collates nodes
into document order</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#compareOrder(net.sf.saxon.tree.wrapper.SiblingCountingNode, net.sf.saxon.tree.wrapper.SiblingCountingNode)">compareOrder</A></B>(<A HREF="../../../../../net/sf/saxon/tree/wrapper/SiblingCountingNode.html" title="interface in net.sf.saxon.tree.wrapper">SiblingCountingNode</A> first,
<A HREF="../../../../../net/sf/saxon/tree/wrapper/SiblingCountingNode.html" title="interface in net.sf.saxon.tree.wrapper">SiblingCountingNode</A> second)</CODE>
<BR>
Generic (model-independent) method to determine the relative position of two
node in document order.</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="../../../../../net/sf/saxon/tree/util/Navigator.html#copy(net.sf.saxon.om.NodeInfo, net.sf.saxon.event.Receiver, int, int)">copy</A></B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event">Receiver</A> out,
int copyOptions,
int locationId)</CODE>
<BR>
Generic (model-independent) implementation of deep copy algorithm for nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="interface in net.sf.saxon.tree.iter">AxisIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#filteredSingleton(net.sf.saxon.om.NodeInfo, net.sf.saxon.pattern.NodeTest)">filteredSingleton</A></B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A> nodeTest)</CODE>
<BR>
Create an iterator over a singleton node, if it exists and matches a nodetest;
otherwise return an empty iterator</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#getAttributeValue(net.sf.saxon.om.NodeInfo, java.lang.String, java.lang.String)">getAttributeValue</A></B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> element,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uri,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> localName)</CODE>
<BR>
Get the string value of an attribute of a given element, given the URI and
local part of the attribute name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#getBaseURI(net.sf.saxon.om.NodeInfo)">getBaseURI</A></B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node)</CODE>
<BR>
Helper method to get the base URI of an element or processing instruction node</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#getNumberAny(net.sf.saxon.expr.Expression, net.sf.saxon.om.NodeInfo, net.sf.saxon.pattern.Pattern, net.sf.saxon.pattern.Pattern, net.sf.saxon.expr.XPathContext, boolean)">getNumberAny</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> inst,
<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> count,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> from,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context,
boolean hasVariablesInPatterns)</CODE>
<BR>
Get node number (level="any").</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#getNumberMulti(net.sf.saxon.om.NodeInfo, net.sf.saxon.pattern.Pattern, net.sf.saxon.pattern.Pattern, net.sf.saxon.expr.XPathContext)">getNumberMulti</A></B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> count,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> from,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Get node number (level="multiple").</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#getNumberSimple(net.sf.saxon.om.NodeInfo, net.sf.saxon.expr.XPathContext)">getNumberSimple</A></B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Get simple node number.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#getNumberSingle(net.sf.saxon.om.NodeInfo, net.sf.saxon.pattern.Pattern, net.sf.saxon.pattern.Pattern, net.sf.saxon.expr.XPathContext)">getNumberSingle</A></B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> count,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> from,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Get node number (level="single").</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#getOutermostElement(net.sf.saxon.om.DocumentInfo)">getOutermostElement</A></B>(<A HREF="../../../../../net/sf/saxon/om/DocumentInfo.html" title="interface in net.sf.saxon.om">DocumentInfo</A> doc)</CODE>
<BR>
Helper method to get the outermost element of a document, given the document node</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#getPath(net.sf.saxon.om.NodeInfo)">getPath</A></B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node)</CODE>
<BR>
Get an absolute XPath expression that identifies a given node within its document</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#getPath(net.sf.saxon.om.NodeInfo, net.sf.saxon.expr.XPathContext)">getPath</A></B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Get an absolute XPath expression that identifies a given node within its document</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="../../../../../net/sf/saxon/tree/util/Navigator.html#isAncestorOrSelf(net.sf.saxon.om.NodeInfo, net.sf.saxon.om.NodeInfo)">isAncestorOrSelf</A></B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> a,
<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> d)</CODE>
<BR>
Test if one node is an ancestor-or-self of another</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/util/Navigator.html#makeNodeTest(net.sf.saxon.om.NamePool, int, java.lang.String, java.lang.String)">makeNodeTest</A></B>(<A HREF="../../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> pool,
int nodeKind,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uri,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> localName)</CODE>
<BR>
Helper method to construct a NodeTest for use with the <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html#iterateAxis(byte)"><CODE>NodeInfo.iterateAxis(byte)</CODE></A> method</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.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ 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="getAttributeValue(net.sf.saxon.om.NodeInfo, java.lang.String, java.lang.String)"><!-- --></A><H3>
getAttributeValue</H3>
<PRE>
public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getAttributeValue</B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> element,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uri,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> localName)</PRE>
<DL>
<DD>Get the string value of an attribute of a given element, given the URI and
local part of the attribute name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - the element on which the required attribute appears<DD><CODE>uri</CODE> - The namespace URI of the attribute name.
The "no namespace" case is represented as an empty string.<DD><CODE>localName</CODE> - The local part of the attribute name.
<DT><B>Returns:</B><DD>the attribute value, or null if the attribute is not present<DT><B>Since:</B></DT>
<DD>9.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getOutermostElement(net.sf.saxon.om.DocumentInfo)"><!-- --></A><H3>
getOutermostElement</H3>
<PRE>
public static <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> <B>getOutermostElement</B>(<A HREF="../../../../../net/sf/saxon/om/DocumentInfo.html" title="interface in net.sf.saxon.om">DocumentInfo</A> doc)</PRE>
<DL>
<DD>Helper method to get the outermost element of a document, given the document node
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>doc</CODE> - the document node at the root of the document
<DT><B>Returns:</B><DD>the first element child of the document node, if there is one, else null. This
is often referred to as the "root element" or "document element". No error is reported
if the document node has multiple element children, which can happen in a document
constructed using XSLT or XQuery.<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="makeNodeTest(net.sf.saxon.om.NamePool, int, java.lang.String, java.lang.String)"><!-- --></A><H3>
makeNodeTest</H3>
<PRE>
public static <A HREF="../../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A> <B>makeNodeTest</B>(<A HREF="../../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> pool,
int nodeKind,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uri,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> localName)</PRE>
<DL>
<DD>Helper method to construct a NodeTest for use with the <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html#iterateAxis(byte)"><CODE>NodeInfo.iterateAxis(byte)</CODE></A> method
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pool</CODE> - the NamePool. The relevant NamePool can be obtained by calling the method
<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html#getNamePool()"><CODE>NodeInfo.getNamePool()</CODE></A>.<DD><CODE>nodeKind</CODE> - The kind of node required, for example <A HREF="../../../../../net/sf/saxon/type/Type.html#ELEMENT"><CODE>Type.ELEMENT</CODE></A> or <A HREF="../../../../../net/sf/saxon/type/Type.html#ATTRIBUTE"><CODE>Type.ATTRIBUTE</CODE></A>.
To select nodes of any kind, use <A HREF="../../../../../net/sf/saxon/type/Type.html#NODE"><CODE>Type.NODE</CODE></A>.<DD><CODE>uri</CODE> - The namespace URI of the nodes to be selected. Supply null to selects nodes from any
namespace or none. Supply "" to select nodes that are not in a namespace.<DD><CODE>localName</CODE> - The local name of the nodes to be selected. Supply null to select nodes irrespective
of their local name.
<DT><B>Returns:</B><DD>a NodeTest that matches the requested nodes<DT><B>Since:</B></DT>
<DD>9.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getBaseURI(net.sf.saxon.om.NodeInfo)"><!-- --></A><H3>
getBaseURI</H3>
<PRE>
public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getBaseURI</B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node)</PRE>
<DL>
<DD>Helper method to get the base URI of an element or processing instruction node
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node whose base URI is required
<DT><B>Returns:</B><DD>the base URI of the node<DT><B>Since:</B></DT>
<DD>8.7</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPath(net.sf.saxon.om.NodeInfo)"><!-- --></A><H3>
getPath</H3>
<PRE>
public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getPath</B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node)</PRE>
<DL>
<DD>Get an absolute XPath expression that identifies a given node within its document
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node whose path is required. If null is supplied,
an empty string is returned - this fact is used in making a recursive call
for a parentless node.
<DT><B>Returns:</B><DD>a path expression that can be used to retrieve the node</DL>
</DD>
</DL>
<HR>
<A NAME="getPath(net.sf.saxon.om.NodeInfo, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
getPath</H3>
<PRE>
public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getPath</B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</PRE>
<DL>
<DD>Get an absolute XPath expression that identifies a given node within its document
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node whose path is required. If null is supplied,
an empty string is returned - this fact is used in making a recursive call
for a parentless node.<DD><CODE>context</CODE> - the XPath dynamic evaluation context. May be null if no context is known
<DT><B>Returns:</B><DD>a path expression that can be used to retrieve the node</DL>
</DD>
</DL>
<HR>
<A NAME="getNumberSimple(net.sf.saxon.om.NodeInfo, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
getNumberSimple</H3>
<PRE>
public static int <B>getNumberSimple</B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</PRE>
<DL>
<DD>Get simple node number. This is defined as one plus the number of previous siblings of the
same node type and name. It is not accessible directly in XSL.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - The node whose number is required<DD><CODE>context</CODE> - Used for remembering previous result, for
performance. May be null.
<DT><B>Returns:</B><DD>the node number, as defined above</DL>
</DD>
</DL>
<HR>
<A NAME="getNumberSingle(net.sf.saxon.om.NodeInfo, net.sf.saxon.pattern.Pattern, net.sf.saxon.pattern.Pattern, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
getNumberSingle</H3>
<PRE>
public static int <B>getNumberSingle</B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> count,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> from,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Get node number (level="single"). If the current node matches the supplied pattern, the returned
number is one plus the number of previous siblings that match the pattern. Otherwise,
return the element number of the nearest ancestor that matches the supplied pattern.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the current node, the one whose node number is required<DD><CODE>count</CODE> - Pattern that identifies which nodes should be
counted. Default (null) is the element name if the current node is
an element, or "node()" otherwise.<DD><CODE>from</CODE> - Pattern that specifies where counting starts from.
Default (null) is the root node. (This parameter does not seem
useful but is included for the sake of XSLT conformance.)<DD><CODE>context</CODE> - the dynamic context of the transformation, used if
the patterns reference context values (e.g. variables)
<DT><B>Returns:</B><DD>the node number established as follows: go to the nearest
ancestor-or-self that matches the 'count' pattern and that is a
descendant of the nearest ancestor that matches the 'from' pattern.
Return one plus the nunber of preceding siblings of that ancestor
that match the 'count' pattern. If there is no such ancestor,
return 0.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - when any error occurs in processing</DL>
</DD>
</DL>
<HR>
<A NAME="getNumberAny(net.sf.saxon.expr.Expression, net.sf.saxon.om.NodeInfo, net.sf.saxon.pattern.Pattern, net.sf.saxon.pattern.Pattern, net.sf.saxon.expr.XPathContext, boolean)"><!-- --></A><H3>
getNumberAny</H3>
<PRE>
public static int <B>getNumberAny</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> inst,
<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> count,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> from,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context,
boolean hasVariablesInPatterns)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Get node number (level="any").
Return one plus the number of previous nodes in the
document that match the supplied pattern
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>inst</CODE> - Identifies the xsl:number expression; this is relevant
when the function is memoised to support repeated use of the same
instruction to number multiple nodes<DD><CODE>node</CODE> - The node being numbered<DD><CODE>count</CODE> - Pattern that identifies which nodes should be
counted. Default (null) is the element name if the current node is
an element, or "node()" otherwise.<DD><CODE>from</CODE> - Pattern that specifies where counting starts from.
Default (null) is the root node. Only nodes at or after the first (most
recent) node that matches the 'from' pattern are counted.<DD><CODE>context</CODE> - The dynamic context for the transformation<DD><CODE>hasVariablesInPatterns</CODE> - if the count or from patterns
contain variables, then it's not safe to get the answer by adding
one to the number of the most recent node that matches
<DT><B>Returns:</B><DD>one plus the number of nodes that precede the current node,
that match the count pattern, and that follow the first node that
matches the from pattern if specified.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if any dynamic error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getNumberMulti(net.sf.saxon.om.NodeInfo, net.sf.saxon.pattern.Pattern, net.sf.saxon.pattern.Pattern, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
getNumberMulti</H3>
<PRE>
public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A>> <B>getNumberMulti</B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> count,
<A HREF="../../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> from,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Get node number (level="multiple").
Return a vector giving the hierarchic position of this node. See the XSLT spec for details.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - The node to be numbered<DD><CODE>count</CODE> - Pattern that identifies which nodes (ancestors and
their previous siblings) should be counted. Default (null) is the
element name if the current node is an element, or "node()"
otherwise.<DD><CODE>from</CODE> - Pattern that specifies where counting starts from.
Default (null) is the root node. Only nodes below the first (most
recent) node that matches the 'from' pattern are counted.<DD><CODE>context</CODE> - The dynamic context for the transformation
<DT><B>Returns:</B><DD>a vector containing for each ancestor-or-self that matches the
count pattern and that is below the nearest node that matches the
from pattern, an Integer which is one greater than the number of
previous siblings that match the count pattern.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if an error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="copy(net.sf.saxon.om.NodeInfo, net.sf.saxon.event.Receiver, int, int)"><!-- --></A><H3>
copy</H3>
<PRE>
public static void <B>copy</B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event">Receiver</A> out,
int copyOptions,
int locationId)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Generic (model-independent) implementation of deep copy algorithm for nodes.
This is available for use by any node implementations that choose to use it.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - The node to be copied<DD><CODE>out</CODE> - The receiver to which events will be sent<DD><CODE>copyOptions</CODE> - Options for copying namespaces, type annotations, etc,
as defined in <A HREF="../../../../../net/sf/saxon/om/CopyOptions.html" title="class in net.sf.saxon.om"><CODE>CopyOptions</CODE></A><DD><CODE>locationId</CODE> - The location of the instruction invoking the copy
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - on any failure reported by the Receiver</DL>
</DD>
</DL>
<HR>
<A NAME="compareOrder(net.sf.saxon.tree.wrapper.SiblingCountingNode, net.sf.saxon.tree.wrapper.SiblingCountingNode)"><!-- --></A><H3>
compareOrder</H3>
<PRE>
public static int <B>compareOrder</B>(<A HREF="../../../../../net/sf/saxon/tree/wrapper/SiblingCountingNode.html" title="interface in net.sf.saxon.tree.wrapper">SiblingCountingNode</A> first,
<A HREF="../../../../../net/sf/saxon/tree/wrapper/SiblingCountingNode.html" title="interface in net.sf.saxon.tree.wrapper">SiblingCountingNode</A> second)</PRE>
<DL>
<DD>Generic (model-independent) method to determine the relative position of two
node in document order. The nodes must be in the same tree.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>first</CODE> - The first node<DD><CODE>second</CODE> - The second node, whose position is to be compared with the first node
<DT><B>Returns:</B><DD>-1 if this node precedes the other node, +1 if it follows the other
node, or 0 if they are the same node. (In this case, isSameNode() will always
return true, and the two nodes will produce the same result for generateId())</DL>
</DD>
</DL>
<HR>
<A NAME="appendSequentialKey(net.sf.saxon.tree.wrapper.SiblingCountingNode, net.sf.saxon.tree.util.FastStringBuffer, boolean)"><!-- --></A><H3>
appendSequentialKey</H3>
<PRE>
public static void <B>appendSequentialKey</B>(<A HREF="../../../../../net/sf/saxon/tree/wrapper/SiblingCountingNode.html" title="interface in net.sf.saxon.tree.wrapper">SiblingCountingNode</A> node,
<A HREF="../../../../../net/sf/saxon/tree/util/FastStringBuffer.html" title="class in net.sf.saxon.tree.util">FastStringBuffer</A> sb,
boolean addDocNr)</PRE>
<DL>
<DD>Get a character string that uniquely identifies this node and that collates nodes
into document order
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node whose unique identifier is reuqired<DD><CODE>sb</CODE> - a buffer to which the unique identifier will be appended<DD><CODE>addDocNr</CODE> - true if a unique document number is to be included in the information</DL>
</DD>
</DL>
<HR>
<A NAME="alphaKey(int)"><!-- --></A><H3>
alphaKey</H3>
<PRE>
public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>alphaKey</B>(int value)</PRE>
<DL>
<DD>Construct an alphabetic key from an positive integer; the key collates in the same sequence
as the integer
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - The positive integer key value (negative values are treated as zero).
<DT><B>Returns:</B><DD>the alphabetic key value</DL>
</DD>
</DL>
<HR>
<A NAME="isAncestorOrSelf(net.sf.saxon.om.NodeInfo, net.sf.saxon.om.NodeInfo)"><!-- --></A><H3>
isAncestorOrSelf</H3>
<PRE>
public static boolean <B>isAncestorOrSelf</B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> a,
<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> d)</PRE>
<DL>
<DD>Test if one node is an ancestor-or-self of another
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>a</CODE> - the putative ancestor-or-self node<DD><CODE>d</CODE> - the putative descendant node
<DT><B>Returns:</B><DD>true if a is an ancestor-or-self of d</DL>
</DD>
</DL>
<HR>
<A NAME="filteredSingleton(net.sf.saxon.om.NodeInfo, net.sf.saxon.pattern.NodeTest)"><!-- --></A><H3>
filteredSingleton</H3>
<PRE>
public static <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="interface in net.sf.saxon.tree.iter">AxisIterator</A> <B>filteredSingleton</B>(<A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node,
<A HREF="../../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A> nodeTest)</PRE>
<DL>
<DD>Create an iterator over a singleton node, if it exists and matches a nodetest;
otherwise return an empty iterator
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the singleton node, or null if the node does not exist<DD><CODE>nodeTest</CODE> - the test to be applied
<DT><B>Returns:</B><DD>an iterator over the node if it exists and matches the test.</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="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="../../../../../net/sf/saxon/tree/util/NamespaceResolverWithDefault.html" title="class in net.sf.saxon.tree.util"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/tree/util/Navigator.AncestorEnumeration.html" title="class in net.sf.saxon.tree.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/saxon/tree/util/Navigator.html" target="_top"><B>FRAMES</B></A>
<A HREF="Navigator.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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
