<!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:47:46 GMT 2011 --> <TITLE> VirtualTreeWalker </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="VirtualTreeWalker"; } } </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="../../../com/saxonica/pull/UnconstructedParent.html" title="class in com.saxonica.pull"><B>PREV CLASS</B></A> NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/saxonica/pull/VirtualTreeWalker.html" target="_top"><B>FRAMES</B></A> <A HREF="VirtualTreeWalker.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <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"> com.saxonica.pull</FONT> <BR> Class VirtualTreeWalker</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>com.saxonica.pull.VirtualTreeWalker</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></DD> </DL> <HR> <DL> <DT><PRE>public class <B>VirtualTreeWalker</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><DT>implements <A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></DL> </PRE> <P> A virtual tree walker provides a sequence of pull events describing the structure and content of a tree that is conceptually being constructed by expressions in a query or stylesheet; in fact the tree is not necessarily constructed in memory, and exists only as this stream of pull events. <p> The tree is physically constructed if operations are requested that depend on the identity of the nodes in the tree, or that navigate within the tree. Operations such as copying or atomizing the tree can be done directly, without building it in memory. (Note however that if such operations are done more than once, the underlying instructions may be evaluated repeatedly.) <P> <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> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.pull.PullProvider"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from interface net.sf.saxon.pull.<A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#ATOMIC_VALUE">ATOMIC_VALUE</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#ATTRIBUTE">ATTRIBUTE</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#COMMENT">COMMENT</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#END_DOCUMENT">END_DOCUMENT</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#END_ELEMENT">END_ELEMENT</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#END_OF_INPUT">END_OF_INPUT</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#NAMESPACE">NAMESPACE</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#PROCESSING_INSTRUCTION">PROCESSING_INSTRUCTION</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#START_DOCUMENT">START_DOCUMENT</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#START_ELEMENT">START_ELEMENT</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#START_OF_INPUT">START_OF_INPUT</A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#TEXT">TEXT</A></CODE></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="../../../com/saxonica/pull/VirtualTreeWalker.html#VirtualTreeWalker(net.sf.saxon.expr.instruct.ParentNodeConstructor, net.sf.saxon.expr.XPathContext)">VirtualTreeWalker</A></B>(<A HREF="../../../net/sf/saxon/expr/instruct/ParentNodeConstructor.html" title="class in net.sf.saxon.expr.instruct">ParentNodeConstructor</A> instruction, <A HREF="../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE> <BR> Create a VirtualTreeWalker to navigate the tree constructed by evaluating a given instruction in a given dyamic context</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> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#close()">close</A></B>()</CODE> <BR> Close the event reader.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#current()">current</A></B>()</CODE> <BR> Get the event most recently returned by next(), or by other calls that change the position, for example getStringValue() and skipToMatchingEnd().</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getAtomicValue()">getAtomicValue</A></B>()</CODE> <BR> Get an atomic value.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../net/sf/saxon/om/AttributeCollection.html" title="interface in net.sf.saxon.om">AttributeCollection</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getAttributes()">getAttributes</A></B>()</CODE> <BR> Get the attributes associated with the current element.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getFingerprint()">getFingerprint</A></B>()</CODE> <BR> Get the fingerprint of the name of the element.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getNameCode()">getNameCode</A></B>()</CODE> <BR> Get the nameCode identifying the name of the current node.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getNamePool()">getNamePool</A></B>()</CODE> <BR> Get the namepool</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../net/sf/saxon/om/NamespaceBinding.html" title="class in net.sf.saxon.om">NamespaceBinding</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getNamespaceBinding(int)">getNamespaceBinding</A></B>(int index)</CODE> <BR> Get the n'th declaration in the list in the form of a namespace code.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../net/sf/saxon/om/NamespaceBinding.html" title="class in net.sf.saxon.om">NamespaceBinding</A>[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getNamespaceDeclarations()">getNamespaceDeclarations</A></B>()</CODE> <BR> Get the namespace declarations associated with the current element.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getNumberOfNamespaces()">getNumberOfNamespaces</A></B>()</CODE> <BR> Get the number of declarations (and undeclarations) in this list.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getPipelineConfiguration()">getPipelineConfiguration</A></B>()</CODE> <BR> Get configuration information.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <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="../../../com/saxonica/pull/VirtualTreeWalker.html#getPrefix(int)">getPrefix</A></B>(int index)</CODE> <BR> Get the prefix of the n'th declaration (or undeclaration) in the list, counting from zero.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../net/sf/saxon/type/SchemaType.html" title="interface in net.sf.saxon.type">SchemaType</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getSchemaType()">getSchemaType</A></B>()</CODE> <BR> Get the type annotation of the current attribute or element node, or atomic value.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/SourceLocator.html?is-external=true" title="class or interface in javax.xml.transform">SourceLocator</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getSourceLocator()">getSourceLocator</A></B>()</CODE> <BR> Get the location of the current event.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getStringValue()">getStringValue</A></B>()</CODE> <BR> Get the string value of the current element, text node, processing-instruction, or top-level attribute or namespace node, or atomic value.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <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></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#getUnparsedEntities()">getUnparsedEntities</A></B>()</CODE> <BR> Get a list of unparsed entities.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <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="../../../com/saxonica/pull/VirtualTreeWalker.html#getURI(int)">getURI</A></B>(int index)</CODE> <BR> Get the namespace URI of the n'th declaration (or undeclaration) in the list, counting from zero.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#next()">next</A></B>()</CODE> <BR> Get the next event</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="../../../com/saxonica/pull/VirtualTreeWalker.html#setElementName(net.sf.saxon.om.FingerprintedQName)">setElementName</A></B>(<A HREF="../../../net/sf/saxon/om/FingerprintedQName.html" title="class in net.sf.saxon.om">FingerprintedQName</A> elementName)</CODE> <BR> </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="../../../com/saxonica/pull/VirtualTreeWalker.html#setNameCode(int)">setNameCode</A></B>(int nameCode)</CODE> <BR> Set the initial nameCode</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="../../../com/saxonica/pull/VirtualTreeWalker.html#setPipelineConfiguration(net.sf.saxon.event.PipelineConfiguration)">setPipelineConfiguration</A></B>(<A HREF="../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A> pipe)</CODE> <BR> Set configuration information.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/saxonica/pull/VirtualTreeWalker.html#skipToMatchingEnd()">skipToMatchingEnd</A></B>()</CODE> <BR> Skip the current subtree.</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> <!-- ========= 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="VirtualTreeWalker(net.sf.saxon.expr.instruct.ParentNodeConstructor, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3> VirtualTreeWalker</H3> <PRE> public <B>VirtualTreeWalker</B>(<A HREF="../../../net/sf/saxon/expr/instruct/ParentNodeConstructor.html" title="class in net.sf.saxon.expr.instruct">ParentNodeConstructor</A> instruction, <A HREF="../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</PRE> <DL> <DD>Create a VirtualTreeWalker to navigate the tree constructed by evaluating a given instruction in a given dyamic context <P> <DL> <DT><B>Parameters:</B><DD><CODE>instruction</CODE> - the instruction (this will always be an instruction that creates element or document nodes)<DD><CODE>context</CODE> - the dynamic evaluation context</DL> </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="setPipelineConfiguration(net.sf.saxon.event.PipelineConfiguration)"><!-- --></A><H3> setPipelineConfiguration</H3> <PRE> public void <B>setPipelineConfiguration</B>(<A HREF="../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A> pipe)</PRE> <DL> <DD>Set configuration information. This must only be called before any events have been read. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#setPipelineConfiguration(net.sf.saxon.event.PipelineConfiguration)">setPipelineConfiguration</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>pipe</CODE> - the pipeline configuration</DL> </DD> </DL> <HR> <A NAME="getPipelineConfiguration()"><!-- --></A><H3> getPipelineConfiguration</H3> <PRE> public <A HREF="../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A> <B>getPipelineConfiguration</B>()</PRE> <DL> <DD>Get configuration information. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#getPipelineConfiguration()">getPipelineConfiguration</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the pipeline configuration</DL> </DD> </DL> <HR> <A NAME="getNamePool()"><!-- --></A><H3> getNamePool</H3> <PRE> public <A HREF="../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> <B>getNamePool</B>()</PRE> <DL> <DD>Get the namepool <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the NamePool</DL> </DD> </DL> <HR> <A NAME="next()"><!-- --></A><H3> next</H3> <PRE> public int <B>next</B>() throws <A HREF="../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Get the next event <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#next()">next</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>an integer code indicating the type of event. The code <A HREF="../../../net/sf/saxon/pull/PullProvider.html#END_OF_INPUT"><CODE>PullProvider.END_OF_INPUT</CODE></A> is returned at the end of the sequence. <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 a dynamic error occurs</DL> </DD> </DL> <HR> <A NAME="current()"><!-- --></A><H3> current</H3> <PRE> public int <B>current</B>()</PRE> <DL> <DD>Get the event most recently returned by next(), or by other calls that change the position, for example getStringValue() and skipToMatchingEnd(). This method does not change the position of the PullProvider. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#current()">current</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the current event</DL> </DD> </DL> <HR> <A NAME="getAttributes()"><!-- --></A><H3> getAttributes</H3> <PRE> public <A HREF="../../../net/sf/saxon/om/AttributeCollection.html" title="interface in net.sf.saxon.om">AttributeCollection</A> <B>getAttributes</B>() throws <A HREF="../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Get the attributes associated with the current element. This method must be called only after a START_ELEMENT event has been notified. The contents of the returned AttributeCollection are guaranteed to remain unchanged until the next START_ELEMENT event, but may be modified thereafter. The object should not be modified by the client. <p/> <p>Attributes may be read before or after reading the namespaces of an element, but must not be read after the first child node has been read, or after calling one of the methods skipToEnd(), getStringValue(), or getTypedValue().</p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#getAttributes()">getAttributes</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>an AttributeCollection representing the attributes of the element that has just been notified. <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 a dynamic error occurs</DL> </DD> </DL> <HR> <A NAME="getNamespaceDeclarations()"><!-- --></A><H3> getNamespaceDeclarations</H3> <PRE> public <A HREF="../../../net/sf/saxon/om/NamespaceBinding.html" title="class in net.sf.saxon.om">NamespaceBinding</A>[] <B>getNamespaceDeclarations</B>() throws <A HREF="../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Get the namespace declarations associated with the current element. This method must be called only after a START_ELEMENT event has been notified. In the case of a top-level START_ELEMENT event (that is, an element that either has no parent node, or whose parent is not included in the sequence being read), the NamespaceDeclarations object returned will contain a namespace declaration for each namespace that is in-scope for this element node. In the case of a non-top-level element, the NamespaceDeclarations will contain a set of namespace declarations and undeclarations, representing the differences between this element and its parent. <p/> <p>It is permissible for this method to return namespace declarations that are redundant.</p> <p/> <p>Namespaces may be read before or after reading the attributes of an element, but must not be read after the first child node has been read, or after calling one of the methods skipToEnd(), getStringValue(), or getTypedValue().</p>* <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#getNamespaceDeclarations()">getNamespaceDeclarations</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the namespace declarations associated with the current START_ELEMENT event. <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 a dynamic error occurs</DL> </DD> </DL> <HR> <A NAME="skipToMatchingEnd()"><!-- --></A><H3> skipToMatchingEnd</H3> <PRE> public int <B>skipToMatchingEnd</B>() throws <A HREF="../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Skip the current subtree. This method may be called only immediately after a START_DOCUMENT or START_ELEMENT event. This call returns the matching END_DOCUMENT or END_ELEMENT event; the next call on next() will return the event following the END_DOCUMENT or END_ELEMENT. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#skipToMatchingEnd()">skipToMatchingEnd</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the matching END_DOCUMENT or END_ELEMENT event <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the method is called at any time other than immediately after a START_DOCUMENT or START_ELEMENT event. <DD><CODE><A HREF="../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if a dynamic error occurs</DL> </DD> </DL> <HR> <A NAME="close()"><!-- --></A><H3> close</H3> <PRE> public void <B>close</B>()</PRE> <DL> <DD>Close the event reader. This indicates that no further events are required. It is not necessary to close an event reader after <A HREF="../../../net/sf/saxon/pull/PullProvider.html#END_OF_INPUT"><CODE>PullProvider.END_OF_INPUT</CODE></A> has been reported, but it is recommended to close it if reading terminates prematurely. Once an event reader has been closed, the effect of further calls on next() is undefined. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setNameCode(int)"><!-- --></A><H3> setNameCode</H3> <PRE> public void <B>setNameCode</B>(int nameCode)</PRE> <DL> <DD>Set the initial nameCode <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>nameCode</CODE> - the nameCode of the node at the root of the tree being walked</DL> </DD> </DL> <HR> <A NAME="setElementName(net.sf.saxon.om.FingerprintedQName)"><!-- --></A><H3> setElementName</H3> <PRE> public void <B>setElementName</B>(<A HREF="../../../net/sf/saxon/om/FingerprintedQName.html" title="class in net.sf.saxon.om">FingerprintedQName</A> elementName)</PRE> <DL> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getNameCode()"><!-- --></A><H3> getNameCode</H3> <PRE> public int <B>getNameCode</B>()</PRE> <DL> <DD>Get the nameCode identifying the name of the current node. This method can be used after the <A HREF="../../../net/sf/saxon/pull/PullProvider.html#START_ELEMENT"><CODE>PullProvider.START_ELEMENT</CODE></A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#END_ELEMENT"><CODE>PullProvider.END_ELEMENT</CODE></A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#PROCESSING_INSTRUCTION"><CODE>PullProvider.PROCESSING_INSTRUCTION</CODE></A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#ATTRIBUTE"><CODE>PullProvider.ATTRIBUTE</CODE></A>, or <A HREF="../../../net/sf/saxon/pull/PullProvider.html#NAMESPACE"><CODE>PullProvider.NAMESPACE</CODE></A> events. With some PullProvider implementations, <b>but not this one</b>, it can also be used after <A HREF="../../../net/sf/saxon/pull/PullProvider.html#END_ELEMENT"><CODE>PullProvider.END_ELEMENT</CODE></A>. If called at other times, the result is undefined and may result in an IllegalStateException. If called when the current node is an unnamed namespace node (a node representing the default namespace) the returned value is -1. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#getNameCode()">getNameCode</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the nameCode. The nameCode can be used to obtain the prefix, local name, and namespace URI from the name pool.</DL> </DD> </DL> <HR> <A NAME="getFingerprint()"><!-- --></A><H3> getFingerprint</H3> <PRE> public int <B>getFingerprint</B>()</PRE> <DL> <DD>Get the fingerprint of the name of the element. This is similar to the nameCode, except that it does not contain any information about the prefix: so two elements with the same fingerprint have the same name, excluding prefix. This method can be used after the <A HREF="../../../net/sf/saxon/pull/PullProvider.html#START_ELEMENT"><CODE>PullProvider.START_ELEMENT</CODE></A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#END_ELEMENT"><CODE>PullProvider.END_ELEMENT</CODE></A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#PROCESSING_INSTRUCTION"><CODE>PullProvider.PROCESSING_INSTRUCTION</CODE></A>, <A HREF="../../../net/sf/saxon/pull/PullProvider.html#ATTRIBUTE"><CODE>PullProvider.ATTRIBUTE</CODE></A>, or <A HREF="../../../net/sf/saxon/pull/PullProvider.html#NAMESPACE"><CODE>PullProvider.NAMESPACE</CODE></A> events. If called at other times, the result is undefined and may result in an IllegalStateException. If called when the current node is an unnamed namespace node (a node representing the default namespace) the returned value is -1. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#getFingerprint()">getFingerprint</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the fingerprint. The fingerprint can be used to obtain the local name and namespace URI from the name pool.</DL> </DD> </DL> <HR> <A NAME="getStringValue()"><!-- --></A><H3> getStringValue</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>getStringValue</B>() throws <A HREF="../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Get the string value of the current element, text node, processing-instruction, or top-level attribute or namespace node, or atomic value. <p/> <p>In other situations the result is undefined and may result in an IllegalStateException.</p> <p/> <p>If the most recent event was a <A HREF="../../../net/sf/saxon/pull/PullProvider.html#START_ELEMENT"><CODE>PullProvider.START_ELEMENT</CODE></A>, this method causes the content of the element to be read. The current event on completion of this method will be the corresponding <A HREF="../../../net/sf/saxon/pull/PullProvider.html#END_ELEMENT"><CODE>PullProvider.END_ELEMENT</CODE></A>. The next call of next() will return the event following the END_ELEMENT event.</p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#getStringValue()">getStringValue</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the String Value of the node in question, defined according to the rules in the XPath data model. <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 a dynamic error occurs</DL> </DD> </DL> <HR> <A NAME="getAtomicValue()"><!-- --></A><H3> getAtomicValue</H3> <PRE> public <A HREF="../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A> <B>getAtomicValue</B>()</PRE> <DL> <DD>Get an atomic value. This call may be used only when the last event reported was ATOMIC_VALUE. This indicates that the PullProvider is reading a sequence that contains a free-standing atomic value; it is never used when reading the content of a node. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#getAtomicValue()">getAtomicValue</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the atomic value</DL> </DD> </DL> <HR> <A NAME="getSchemaType()"><!-- --></A><H3> getSchemaType</H3> <PRE> public <A HREF="../../../net/sf/saxon/type/SchemaType.html" title="interface in net.sf.saxon.type">SchemaType</A> <B>getSchemaType</B>()</PRE> <DL> <DD>Get the type annotation of the current attribute or element node, or atomic value. The result of this method is undefined unless the most recent event was START_ELEMENT, ATTRIBUTE, or ATOMIC_VALUE. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#getSchemaType()">getSchemaType</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the type annotation.</DL> </DD> </DL> <HR> <A NAME="getSourceLocator()"><!-- --></A><H3> getSourceLocator</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/SourceLocator.html?is-external=true" title="class or interface in javax.xml.transform">SourceLocator</A> <B>getSourceLocator</B>()</PRE> <DL> <DD>Get the location of the current event. For an event stream representing a real document, the location information should identify the location in the lexical XML source. For a constructed document, it should identify the location in the query or stylesheet that caused the node to be created. A value of null can be returned if no location information is available. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#getSourceLocator()">getSourceLocator</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the SourceLocator giving the location of the current event, or null if no location information is available</DL> </DD> </DL> <HR> <A NAME="getNumberOfNamespaces()"><!-- --></A><H3> getNumberOfNamespaces</H3> <PRE> public int <B>getNumberOfNamespaces</B>()</PRE> <DL> <DD>Get the number of declarations (and undeclarations) in this list. <P> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getPrefix(int)"><!-- --></A><H3> getPrefix</H3> <PRE> public <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>getPrefix</B>(int index)</PRE> <DL> <DD>Get the prefix of the n'th declaration (or undeclaration) in the list, counting from zero. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index identifying which declaration is required. <DT><B>Returns:</B><DD>the namespace prefix. For a declaration or undeclaration of the default namespace, this is the zero-length string. <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if the index is out of range.</DL> </DD> </DL> <HR> <A NAME="getURI(int)"><!-- --></A><H3> getURI</H3> <PRE> public <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>getURI</B>(int index)</PRE> <DL> <DD>Get the namespace URI of the n'th declaration (or undeclaration) in the list, counting from zero. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index identifying which declaration is required. <DT><B>Returns:</B><DD>the namespace URI. For a namespace undeclaration, this is the zero-length string. <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if the index is out of range.</DL> </DD> </DL> <HR> <A NAME="getNamespaceBinding(int)"><!-- --></A><H3> getNamespaceBinding</H3> <PRE> public <A HREF="../../../net/sf/saxon/om/NamespaceBinding.html" title="class in net.sf.saxon.om">NamespaceBinding</A> <B>getNamespaceBinding</B>(int index)</PRE> <DL> <DD>Get the n'th declaration in the list in the form of a namespace code. Namespace codes can be translated into a prefix and URI by means of methods in the NamePool <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index identifying which declaration is required. <DT><B>Returns:</B><DD>the namespace code. This is an integer whose upper half indicates the prefix (0 represents the default namespace), and whose lower half indicates the URI (0 represents an undeclaration). <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if the index is out of range.</DL> </DD> </DL> <HR> <A NAME="getUnparsedEntities()"><!-- --></A><H3> getUnparsedEntities</H3> <PRE> public <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> <B>getUnparsedEntities</B>()</PRE> <DL> <DD>Get a list of unparsed entities. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html#getUnparsedEntities()">getUnparsedEntities</A></CODE> in interface <CODE><A HREF="../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a list of unparsed entities, or null if the information is not available, or an empty list if there are no unparsed entities.</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="../../../com/saxonica/pull/UnconstructedParent.html" title="class in com.saxonica.pull"><B>PREV CLASS</B></A> NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/saxonica/pull/VirtualTreeWalker.html" target="_top"><B>FRAMES</B></A> <A HREF="VirtualTreeWalker.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <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> Copyright (c) 2004-2011 Saxonica Limited. All rights reserved. </BODY> </HTML>