Sophie

Sophie

distrib > Mageia > 7 > x86_64 > by-pkgid > b3bdfe6d859a3d6920ff2c44b38e9a6f > files > 2381

saxon-manual-9.4.0.9-2.mga7.noarch.rpm

<!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:25 GMT 2011 -->
<TITLE>
PullProvider
</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="PullProvider";
    }
}
</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../net/sf/saxon/pull/PullFilter.html" title="class in net.sf.saxon.pull"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../net/sf/saxon/pull/PullPushCopier.html" title="class in net.sf.saxon.pull"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?net/sf/saxon/pull/PullProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PullProvider.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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.pull</FONT>
<BR>
Interface PullProvider</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/saxonica/pull/DocumentEventIgnorer.html" title="class in com.saxonica.pull">DocumentEventIgnorer</A>, <A HREF="../../../../com/saxonica/pull/ElementNameTracker.html" title="class in com.saxonica.pull">ElementNameTracker</A>, <A HREF="../../../../net/sf/saxon/pull/PullFilter.html" title="class in net.sf.saxon.pull">PullFilter</A>, <A HREF="../../../../com/saxonica/pull/PullFromIterator.html" title="class in com.saxonica.pull">PullFromIterator</A>, <A HREF="../../../../com/saxonica/pull/PullNamespaceReducer.html" title="class in com.saxonica.pull">PullNamespaceReducer</A>, <A HREF="../../../../net/sf/saxon/pull/PullPushTee.html" title="class in net.sf.saxon.pull">PullPushTee</A>, <A HREF="../../../../com/saxonica/pull/PullTracer.html" title="class in com.saxonica.pull">PullTracer</A>, <A HREF="../../../../net/sf/saxon/pull/StaxBridge.html" title="class in net.sf.saxon.pull">StaxBridge</A>, <A HREF="../../../../com/saxonica/pull/TinyTreeWalker.html" title="class in com.saxonica.pull">TinyTreeWalker</A>, <A HREF="../../../../com/saxonica/pull/TreeWalker.html" title="class in com.saxonica.pull">TreeWalker</A>, <A HREF="../../../../com/saxonica/pull/VirtualTreeWalker.html" title="class in com.saxonica.pull">VirtualTreeWalker</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>PullProvider</B></DL>
</PRE>

<P>
PullProvider is Saxon's pull-based interface for reading XML documents and XDM sequences.
 A PullProvider can deliver any sequence of nodes or atomic values. An atomic value
 in the sequence is delivered as a single event; a node is delivered as a sequence
 of events equivalent to a recursive walk of the XML tree. Within this sequence,
 the start and end of a document, or of an element, are delivered as separate
 events; other nodes are delivered as individual events.
<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>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#ATOMIC_VALUE">ATOMIC_VALUE</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ATOMIC_VALUE is notified when the PullProvider is reading a sequence of items,
 and one of the items is an atomic value rather than a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#ATTRIBUTE">ATTRIBUTE</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The ATTRIBUTE event is notified only for an attribute node that appears in its own right
 as a top-level item in the sequence being read.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#COMMENT">COMMENT</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A COMMENT event is notified for a comment node, which may be either a top-level
 comment or one nested within an element or document node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#END_DOCUMENT">END_DOCUMENT</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;END_DOCUMENT is notified at the end of processing a document node, that is,
 after all the descendants of the document node have been notified.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#END_ELEMENT">END_ELEMENT</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;END_ELEMENT is notified at the end of an element node, that is, after all the children
 and descendants of the element have either been processed or skipped.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#END_OF_INPUT">END_OF_INPUT</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The END_OF_INPUT event is returned to indicate the end of the sequence being read.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#NAMESPACE">NAMESPACE</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The NAMESPACE event is notified only for a namespace node that appears in its own right
 as a top-level item in the sequence being read.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#PROCESSING_INSTRUCTION">PROCESSING_INSTRUCTION</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A PROCESSING_INSTRUCTION event is notified for a processing instruction node,
 which may be either a top-level comment or one nested within an element or document node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#START_DOCUMENT">START_DOCUMENT</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;START_DOCUMENT is notified when a document node is encountered.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#START_ELEMENT">START_ELEMENT</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;START_ELEMENT is notified when an element node is encountered.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#START_OF_INPUT">START_OF_INPUT</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;START_OF_INPUT is the initial state when the PullProvider is instantiated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#TEXT">TEXT</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A TEXT event is notified for a text node.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#close()">close</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the event reader.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#current()">current</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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="../../../../net/sf/saxon/pull/PullProvider.html#getAtomicValue()">getAtomicValue</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get an atomic value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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="../../../../net/sf/saxon/pull/PullProvider.html#getAttributes()">getAttributes</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#getFingerprint()">getFingerprint</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#getNameCode()">getNameCode</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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="../../../../net/sf/saxon/pull/PullProvider.html#getNamespaceDeclarations()">getNamespaceDeclarations</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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="../../../../net/sf/saxon/pull/PullProvider.html#getPipelineConfiguration()">getPipelineConfiguration</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get configuration information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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="../../../../net/sf/saxon/pull/PullProvider.html#getSchemaType()">getSchemaType</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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="../../../../net/sf/saxon/pull/PullProvider.html#getSourceLocator()">getSourceLocator</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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="../../../../net/sf/saxon/pull/PullProvider.html#getStringValue()">getStringValue</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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="../../../../net/sf/saxon/pull/PullProvider.html#getUnparsedEntities()">getUnparsedEntities</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of unparsed entities.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#next()">next</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the next event</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.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>&nbsp;pipe)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set configuration information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/PullProvider.html#skipToMatchingEnd()">skipToMatchingEnd</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Skip the current subtree.</TD>
</TR>
</TABLE>
&nbsp;
<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="START_OF_INPUT"><!-- --></A><H3>
START_OF_INPUT</H3>
<PRE>
static final int <B>START_OF_INPUT</B></PRE>
<DL>
<DD>START_OF_INPUT is the initial state when the PullProvider is instantiated.
 This event is never notified by the next() method, but it is returned
 from a call of current() prior to the first call on next().
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.START_OF_INPUT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ATOMIC_VALUE"><!-- --></A><H3>
ATOMIC_VALUE</H3>
<PRE>
static final int <B>ATOMIC_VALUE</B></PRE>
<DL>
<DD>ATOMIC_VALUE is notified when the PullProvider is reading a sequence of items,
 and one of the items is an atomic value rather than a node. This will always
 be a top-level event (it will never be nested in Start/End Document or
 Start/End Element).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.ATOMIC_VALUE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="START_DOCUMENT"><!-- --></A><H3>
START_DOCUMENT</H3>
<PRE>
static final int <B>START_DOCUMENT</B></PRE>
<DL>
<DD>START_DOCUMENT is notified when a document node is encountered. This will
 always be a top-level event (it will never be nested in Start/End Document or
 Start/End Element). Note however that multiple document nodes can occur in
 a sequence, and the start and end of each one will be notified.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.START_DOCUMENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="END_DOCUMENT"><!-- --></A><H3>
END_DOCUMENT</H3>
<PRE>
static final int <B>END_DOCUMENT</B></PRE>
<DL>
<DD>END_DOCUMENT is notified at the end of processing a document node, that is,
 after all the descendants of the document node have been notified. The event
 will always be preceded by the corresponding START_DOCUMENT event.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.END_DOCUMENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="START_ELEMENT"><!-- --></A><H3>
START_ELEMENT</H3>
<PRE>
static final int <B>START_ELEMENT</B></PRE>
<DL>
<DD>START_ELEMENT is notified when an element node is encountered. This may either
 be a top-level element (an element node that participates in the sequence being
 read in its own right) or a nested element (reported because it is a descendant
 of an element or document node that participates in the sequence.)

 <p>Following the notification of START_ELEMENT, the client may obtain information
 about the element node, such as its name and type annotation. The client may also
 call getAttributes() to obtain information about the attributes of the element
 node, and/or getNamespaceDeclarations() to get information about the namespace
 declarations. The client may then do one of the following:</p>

 <ul>
 <li>Call skipToMatchingEnd() to move straight to the corresponding END_ELEMENT event (which
 will then be the current event)</li>
 <li>Call next(), repeatedly, to be notified of events relating to the children and
 descendants of this element node</li>
 <li>Call getStringValue() to obtain the string value of the element node, after which
 the next event notified will be the corresponding END_ELEMENT event</li>
 <li>Call getTypedValue() to obtain the typed value of the element node, after which
 the next event notified will be the corresponding END_ELEMENT event</li>
 </ul>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.START_ELEMENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="END_ELEMENT"><!-- --></A><H3>
END_ELEMENT</H3>
<PRE>
static final int <B>END_ELEMENT</B></PRE>
<DL>
<DD>END_ELEMENT is notified at the end of an element node, that is, after all the children
 and descendants of the element have either been processed or skipped. It may relate to
 a top-level element, or to a nested element. For an empty element (one with no children)
 the END_ELEMENT event will immediately follow the corresponding START_ELEMENT event.
 No information (such as the element name) is available after an END_ELEMENT event: if the
 client requires such information, it must remember it, typically on a Stack.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.END_ELEMENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ATTRIBUTE"><!-- --></A><H3>
ATTRIBUTE</H3>
<PRE>
static final int <B>ATTRIBUTE</B></PRE>
<DL>
<DD>The ATTRIBUTE event is notified only for an attribute node that appears in its own right
 as a top-level item in the sequence being read. ATTRIBUTE events are not notified for
 the attributes of an element that has been notified: such attributes must be read using the
 <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#getAttributes()"><CODE>getAttributes()</CODE></A> method.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.ATTRIBUTE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="NAMESPACE"><!-- --></A><H3>
NAMESPACE</H3>
<PRE>
static final int <B>NAMESPACE</B></PRE>
<DL>
<DD>The NAMESPACE event is notified only for a namespace node that appears in its own right
 as a top-level item in the sequence being read. NAMESPACE events are not notified for
 the namespaces of an element that has been notified: such attributes must be read using the
 <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#getNamespaceDeclarations()"><CODE>getNamespaceDeclarations()</CODE></A> method.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.NAMESPACE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="TEXT"><!-- --></A><H3>
TEXT</H3>
<PRE>
static final int <B>TEXT</B></PRE>
<DL>
<DD>A TEXT event is notified for a text node. This may either be a top-level text
 node, or a text node nested within an element or document node. At the top level,
 text nodes may be zero-length and may be consecutive in the sequence being read.
 Nested within an element or document node, text nodes will never be zero-length,
 and adjacent text nodes will have been coalesced into one. (This might not always
 be true when reading third-party data models such as a DOM.) Whitespace-only
 text nodes will be notified unless something has been done (e.g. xsl:strip-space)
 to remove them.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.TEXT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="COMMENT"><!-- --></A><H3>
COMMENT</H3>
<PRE>
static final int <B>COMMENT</B></PRE>
<DL>
<DD>A COMMENT event is notified for a comment node, which may be either a top-level
 comment or one nested within an element or document node.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.COMMENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="PROCESSING_INSTRUCTION"><!-- --></A><H3>
PROCESSING_INSTRUCTION</H3>
<PRE>
static final int <B>PROCESSING_INSTRUCTION</B></PRE>
<DL>
<DD>A PROCESSING_INSTRUCTION event is notified for a processing instruction node,
 which may be either a top-level comment or one nested within an element or document node.
 As defined in the XPath data model, the "target" of a processing instruction is represented
 as the node name (which only has a local part, no prefix or URI), and the "data" of the
 processing instruction is represented as the string-value of the node.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.PROCESSING_INSTRUCTION">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="END_OF_INPUT"><!-- --></A><H3>
END_OF_INPUT</H3>
<PRE>
static final int <B>END_OF_INPUT</B></PRE>
<DL>
<DD>The END_OF_INPUT event is returned to indicate the end of the sequence being read.
 After this event, the result of any further calls on the next() method is undefined.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.pull.PullProvider.END_OF_INPUT">Constant Field Values</A></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>
void <B>setPipelineConfiguration</B>(<A HREF="../../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A>&nbsp;pipe)</PRE>
<DL>
<DD>Set configuration information. This must only be called before any events
 have been read.
<P>
<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>
<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>Returns:</B><DD>the pipeline configuration</DL>
</DD>
</DL>
<HR>

<A NAME="next()"><!-- --></A><H3>
next</H3>
<PRE>
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>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>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>
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>Returns:</B><DD>the current event</DL>
</DD>
</DL>
<HR>

<A NAME="getAttributes()"><!-- --></A><H3>
getAttributes</H3>
<PRE>
<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>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 skipToMatchingEnd(), getStringValue(), or getTypedValue().</p>
<P>
<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>
<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>It is permissible for this method to return namespace declarations that are redundant.</p>

 <p>The NamespaceDeclarations object is guaranteed to remain unchanged until the next START_ELEMENT
 event, but may then be overwritten. The object should not be modified by the client.</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 skipToMatchingEnd(), getStringValue(), or getTypedValue().</p>
<P>
<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>
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>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>
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>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>
</DL>
</DD>
</DL>
<HR>

<A NAME="getNameCode()"><!-- --></A><H3>
getNameCode</H3>
<PRE>
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>START_ELEMENT</CODE></A>, <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#PROCESSING_INSTRUCTION"><CODE>PROCESSING_INSTRUCTION</CODE></A>,
 <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#ATTRIBUTE"><CODE>ATTRIBUTE</CODE></A>, or <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#NAMESPACE"><CODE>NAMESPACE</CODE></A> events. With some PullProvider implementations,
 it can also be used after <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#END_ELEMENT"><CODE>END_ELEMENT</CODE></A>, but this is not guaranteed: a client who
 requires the information at that point (for example, to do serialization) should insert an
 <A HREF="../../../../com/saxonica/pull/ElementNameTracker.html" title="class in com.saxonica.pull"><CODE>ElementNameTracker</CODE></A> into the pipeline.
 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>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>
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>START_ELEMENT</CODE></A>, <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#END_ELEMENT"><CODE>END_ELEMENT</CODE></A>, <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#PROCESSING_INSTRUCTION"><CODE>PROCESSING_INSTRUCTION</CODE></A>,
 <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#ATTRIBUTE"><CODE>ATTRIBUTE</CODE></A>, or <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#NAMESPACE"><CODE>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>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>
<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>In other situations the result is undefined and may result in an IllegalStateException.</p>

 <p>If the most recent event was a <A HREF="../../../../net/sf/saxon/pull/PullProvider.html#START_ELEMENT"><CODE>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>END_ELEMENT</CODE></A>. The next call of next() will return the event following
 the END_ELEMENT event.</p>
<P>
<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="getSchemaType()"><!-- --></A><H3>
getSchemaType</H3>
<PRE>
<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>Returns:</B><DD>the type annotation.<DT><B>Since:</B></DT>
  <DD>9.4; replace the method getTypeAnnotation() which returned the integer fingerprint of the type</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAtomicValue()"><!-- --></A><H3>
getAtomicValue</H3>
<PRE>
<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>Returns:</B><DD>the atomic value</DL>
</DD>
</DL>
<HR>

<A NAME="getSourceLocator()"><!-- --></A><H3>
getSourceLocator</H3>
<PRE>
<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>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="getUnparsedEntities()"><!-- --></A><H3>
getUnparsedEntities</H3>
<PRE>
<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>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. Each item in the list will
         be an instance of <A HREF="../../../../net/sf/saxon/pull/UnparsedEntity.html" title="class in net.sf.saxon.pull"><CODE>UnparsedEntity</CODE></A></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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../net/sf/saxon/pull/PullFilter.html" title="class in net.sf.saxon.pull"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../net/sf/saxon/pull/PullPushCopier.html" title="class in net.sf.saxon.pull"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?net/sf/saxon/pull/PullProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PullProvider.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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>