<!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>
StaxBridge
</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="StaxBridge";
}
}
</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/pull/PullSource.html" title="class in net.sf.saxon.pull"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/pull/UnparsedEntity.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/StaxBridge.html" target="_top"><B>FRAMES</B></A>
<A HREF="StaxBridge.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">
net.sf.saxon.pull</FONT>
<BR>
Class StaxBridge</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.pull.StaxBridge</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><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>, <A HREF="../../../../net/sf/saxon/event/LocationProvider.html" title="interface in net.sf.saxon.event">LocationProvider</A>, <A HREF="../../../../net/sf/saxon/event/SaxonLocator.html" title="interface in net.sf.saxon.event">SaxonLocator</A>, <A HREF="../../../../net/sf/saxon/event/SourceLocationProvider.html" title="interface in net.sf.saxon.event">SourceLocationProvider</A>, <A HREF="../../../../net/sf/saxon/pull/PullProvider.html" title="interface in net.sf.saxon.pull">PullProvider</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true" title="class or interface in org.xml.sax">Locator</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>StaxBridge</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>, <A HREF="../../../../net/sf/saxon/event/SaxonLocator.html" title="interface in net.sf.saxon.event">SaxonLocator</A>, <A HREF="../../../../net/sf/saxon/event/SourceLocationProvider.html" title="interface in net.sf.saxon.event">SourceLocationProvider</A></DL>
</PRE>
<P>
This class implements the Saxon PullProvider API on top of a standard StAX parser
(or any other StAX XMLStreamReader implementation)
<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="../../../../net/sf/saxon/pull/StaxBridge.html#StaxBridge()">StaxBridge</A></B>()</CODE>
<BR>
Create a new instance of the class</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="../../../../net/sf/saxon/pull/StaxBridge.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="../../../../net/sf/saxon/pull/StaxBridge.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="../../../../net/sf/saxon/pull/StaxBridge.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="../../../../net/sf/saxon/pull/StaxBridge.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="../../../../net/sf/saxon/pull/StaxBridge.html#getColumnNumber()">getColumnNumber</A></B>()</CODE>
<BR>
Return the column number where the current document event ends.</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="../../../../net/sf/saxon/pull/StaxBridge.html#getColumnNumber(long)">getColumnNumber</A></B>(long locationId)</CODE>
<BR>
Get the column number within the document, entity, or module containing a particular location</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="../../../../net/sf/saxon/pull/StaxBridge.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="../../../../net/sf/saxon/pull/StaxBridge.html#getLineNumber()">getLineNumber</A></B>()</CODE>
<BR>
Return the line number where the current document event ends.</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="../../../../net/sf/saxon/pull/StaxBridge.html#getLineNumber(long)">getLineNumber</A></B>(long locationId)</CODE>
<BR>
Get the line number within the document, entity or module containing a particular location</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="../../../../net/sf/saxon/pull/StaxBridge.html#getLocationId()">getLocationId</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> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/StaxBridge.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="../../../../net/sf/saxon/pull/StaxBridge.html#getNamePool()">getNamePool</A></B>()</CODE>
<BR>
Get the name pool</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="../../../../net/sf/saxon/pull/StaxBridge.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> <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/StaxBridge.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="../../../../net/sf/saxon/pull/StaxBridge.html#getPublicId()">getPublicId</A></B>()</CODE>
<BR>
Return the public identifier for the current document event.</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="../../../../net/sf/saxon/pull/StaxBridge.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="../../../../net/sf/saxon/pull/StaxBridge.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="../../../../net/sf/saxon/pull/StaxBridge.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/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/pull/StaxBridge.html#getSystemId()">getSystemId</A></B>()</CODE>
<BR>
Return the system identifier for the current document 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/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/pull/StaxBridge.html#getSystemId(long)">getSystemId</A></B>(long locationId)</CODE>
<BR>
Get the URI of the document, entity, or module containing a particular location</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="../../../../net/sf/saxon/pull/StaxBridge.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/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamReader</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/StaxBridge.html#getXMLStreamReader()">getXMLStreamReader</A></B>()</CODE>
<BR>
Get the XMLStreamReader used by this StaxBridge.</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/pull/StaxBridge.html#main(java.lang.String[])">main</A></B>(<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>[] args)</CODE>
<BR>
Simple test program
Usage: java StaxBridge in.xml [out.xml]</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="../../../../net/sf/saxon/pull/StaxBridge.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="../../../../net/sf/saxon/pull/StaxBridge.html#setInputStream(java.lang.String, java.io.InputStream)">setInputStream</A></B>(<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> systemId,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> inputStream)</CODE>
<BR>
Supply an input stream containing XML to be parsed.</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="../../../../net/sf/saxon/pull/StaxBridge.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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pull/StaxBridge.html#setXMLStreamReader(javax.xml.stream.XMLStreamReader)">setXMLStreamReader</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamReader</A> reader)</CODE>
<BR>
Supply an XMLStreamReader: the events reported by this XMLStreamReader will be translated
into PullProvider events</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="../../../../net/sf/saxon/pull/StaxBridge.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="StaxBridge()"><!-- --></A><H3>
StaxBridge</H3>
<PRE>
public <B>StaxBridge</B>()</PRE>
<DL>
<DD>Create a new instance of the class
<P>
</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="setInputStream(java.lang.String, java.io.InputStream)"><!-- --></A><H3>
setInputStream</H3>
<PRE>
public void <B>setInputStream</B>(<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> systemId,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> inputStream)
throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Supply an input stream containing XML to be parsed. A StAX parser is created using
the JAXP XMLInputFactory.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>systemId</CODE> - The Base URI of the input document<DD><CODE>inputStream</CODE> - the stream containing the XML to be parsed
<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 creating the StAX parser</DL>
</DD>
</DL>
<HR>
<A NAME="setXMLStreamReader(javax.xml.stream.XMLStreamReader)"><!-- --></A><H3>
setXMLStreamReader</H3>
<PRE>
public void <B>setXMLStreamReader</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamReader</A> reader)</PRE>
<DL>
<DD>Supply an XMLStreamReader: the events reported by this XMLStreamReader will be translated
into PullProvider events
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reader</CODE> - the supplier of XML events, typically an XML parser</DL>
</DD>
</DL>
<HR>
<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="getXMLStreamReader()"><!-- --></A><H3>
getXMLStreamReader</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamReader</A> <B>getXMLStreamReader</B>()</PRE>
<DL>
<DD>Get the XMLStreamReader used by this StaxBridge. This is available only after
setInputStream() or setXMLStreamReader() has been called
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the instance of XMLStreamReader allocated when setInputStream() was called,
or the instance supplied directly to setXMLStreamReader()</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 name pool
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the name pool</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>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/>
<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="../../../../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="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#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,
including this one, 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#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="getLocationId()"><!-- --></A><H3>
getLocationId</H3>
<PRE>
public int <B>getLocationId</B>()</PRE>
<DL>
<DD>Get the location of the current event. The location is returned as an integer.
This is a value that can be passed to the <A HREF="../../../../net/sf/saxon/event/LocationProvider.html" title="interface in net.sf.saxon.event"><CODE>LocationProvider</CODE></A>
held by the <A HREF="../../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event"><CODE>PipelineConfiguration</CODE></A> to get real location information (line number,
system Id, etc). 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 zero can be returned if no location information is available.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the location ID</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="getPublicId()"><!-- --></A><H3>
getPublicId</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>getPublicId</B>()</PRE>
<DL>
<DD>Return the public identifier for the current document event.
<p/>
<p>The return value is the public identifier of the document
entity or of the external parsed entity in which the markup
triggering the event appears.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/SourceLocator.html?is-external=true#getPublicId()" title="class or interface in javax.xml.transform">getPublicId</A></CODE> in interface <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><DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true#getPublicId()" title="class or interface in org.xml.sax">getPublicId</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true" title="class or interface in org.xml.sax">Locator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A string containing the public identifier, or
null if none is available.<DT><B>See Also:</B><DD><A HREF="../../../../net/sf/saxon/pull/StaxBridge.html#getSystemId()"><CODE>getSystemId()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getSystemId()"><!-- --></A><H3>
getSystemId</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>getSystemId</B>()</PRE>
<DL>
<DD>Return the system identifier for the current document event.
<p/>
<p>The return value is the system identifier of the document
entity or of the external parsed entity in which the markup
triggering the event appears.</p>
<p/>
<p>If the system identifier is a URL, the parser must resolve it
fully before passing it to the application. For example, a file
name must always be provided as a <em>file:...</em> URL, and other
kinds of relative URI are also resolved against their bases.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/SourceLocator.html?is-external=true#getSystemId()" title="class or interface in javax.xml.transform">getSystemId</A></CODE> in interface <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><DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true#getSystemId()" title="class or interface in org.xml.sax">getSystemId</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true" title="class or interface in org.xml.sax">Locator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A string containing the system identifier, or null
if none is available.<DT><B>See Also:</B><DD><A HREF="../../../../net/sf/saxon/pull/StaxBridge.html#getPublicId()"><CODE>getPublicId()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getLineNumber()"><!-- --></A><H3>
getLineNumber</H3>
<PRE>
public int <B>getLineNumber</B>()</PRE>
<DL>
<DD>Return the line number where the current document event ends.
Lines are delimited by line ends, which are defined in
the XML specification.
<p/>
<p><strong>Warning:</strong> The return value from the method
is intended only as an approximation for the sake of diagnostics;
it is not intended to provide sufficient information
to edit the character content of the original XML document.
In some cases, these "line" numbers match what would be displayed
as columns, and in others they may not match the source text
due to internal entity expansion. </p>
<p/>
<p>The return value is an approximation of the line number
in the document entity or external parsed entity where the
markup triggering the event appears.</p>
<p/>
<p>If possible, the SAX driver should provide the line position
of the first character after the text associated with the document
event. The first line is line 1.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/SourceLocator.html?is-external=true#getLineNumber()" title="class or interface in javax.xml.transform">getLineNumber</A></CODE> in interface <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><DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true#getLineNumber()" title="class or interface in org.xml.sax">getLineNumber</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true" title="class or interface in org.xml.sax">Locator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The line number, or -1 if none is available.<DT><B>See Also:</B><DD><A HREF="../../../../net/sf/saxon/pull/StaxBridge.html#getColumnNumber()"><CODE>getColumnNumber()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getColumnNumber()"><!-- --></A><H3>
getColumnNumber</H3>
<PRE>
public int <B>getColumnNumber</B>()</PRE>
<DL>
<DD>Return the column number where the current document event ends.
This is one-based number of Java <code>char</code> values since
the last line end.
<p/>
<p><strong>Warning:</strong> The return value from the method
is intended only as an approximation for the sake of diagnostics;
it is not intended to provide sufficient information
to edit the character content of the original XML document.
For example, when lines contain combining character sequences, wide
characters, surrogate pairs, or bi-directional text, the value may
not correspond to the column in a text editor's display. </p>
<p/>
<p>The return value is an approximation of the column number
in the document entity or external parsed entity where the
markup triggering the event appears.</p>
<p/>
<p>If possible, the SAX driver should provide the line position
of the first character after the text associated with the document
event. The first column in each line is column 1.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/SourceLocator.html?is-external=true#getColumnNumber()" title="class or interface in javax.xml.transform">getColumnNumber</A></CODE> in interface <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><DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true#getColumnNumber()" title="class or interface in org.xml.sax">getColumnNumber</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true" title="class or interface in org.xml.sax">Locator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The column number, or -1 if none is available.<DT><B>See Also:</B><DD><A HREF="../../../../net/sf/saxon/pull/StaxBridge.html#getLineNumber()"><CODE>getLineNumber()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getSystemId(long)"><!-- --></A><H3>
getSystemId</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>getSystemId</B>(long locationId)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../net/sf/saxon/event/LocationProvider.html#getSystemId(long)">LocationProvider</A></CODE></B></DD>
<DD>Get the URI of the document, entity, or module containing a particular location
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/event/LocationProvider.html#getSystemId(long)">getSystemId</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/event/LocationProvider.html" title="interface in net.sf.saxon.event">LocationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locationId</CODE> - identifier of the location in question (as passed down the Receiver pipeline)
<DT><B>Returns:</B><DD>the URI of the document, XML entity or module. For a SourceLocationProvider this will
be the URI of the document or entity (the URI that would be the base URI if there were no
xml:base attributes). In other cases it may identify the query or stylesheet module currently
being executed.</DL>
</DD>
</DL>
<HR>
<A NAME="getLineNumber(long)"><!-- --></A><H3>
getLineNumber</H3>
<PRE>
public int <B>getLineNumber</B>(long locationId)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../net/sf/saxon/event/LocationProvider.html#getLineNumber(long)">LocationProvider</A></CODE></B></DD>
<DD>Get the line number within the document, entity or module containing a particular location
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/event/LocationProvider.html#getLineNumber(long)">getLineNumber</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/event/LocationProvider.html" title="interface in net.sf.saxon.event">LocationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locationId</CODE> - identifier of the location in question (as passed down the Receiver pipeline)
<DT><B>Returns:</B><DD>the line number within the document, entity or module, or -1 if no information is available.</DL>
</DD>
</DL>
<HR>
<A NAME="getColumnNumber(long)"><!-- --></A><H3>
getColumnNumber</H3>
<PRE>
public int <B>getColumnNumber</B>(long locationId)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../net/sf/saxon/event/LocationProvider.html#getColumnNumber(long)">LocationProvider</A></CODE></B></DD>
<DD>Get the column number within the document, entity, or module containing a particular location
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/event/LocationProvider.html#getColumnNumber(long)">getColumnNumber</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/event/LocationProvider.html" title="interface in net.sf.saxon.event">LocationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locationId</CODE> - identifier of the location in question (as passed down the Receiver pipeline)
<DT><B>Returns:</B><DD>the column number within the document, entity, or module, or -1 if this is not available</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. 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>
<HR>
<A NAME="main(java.lang.String[])"><!-- --></A><H3>
main</H3>
<PRE>
public static void <B>main</B>(<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>[] args)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
<DD>Simple test program
Usage: java StaxBridge in.xml [out.xml]
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>args</CODE> - command line arguments
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></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/pull/PullSource.html" title="class in net.sf.saxon.pull"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/pull/UnparsedEntity.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/StaxBridge.html" target="_top"><B>FRAMES</B></A>
<A HREF="StaxBridge.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>
