net.sf.saxon.evpull
Class StaxEventBridge
java.lang.Object
net.sf.saxon.evpull.StaxEventBridge
- EventIterator, Locator, LocationProvider, PullEvent, SaxonLocator, SourceLocator, SourceLocationProvider
public class StaxEventBridge
extends java.lang.Object
This class implements the Saxon EventIterator API on top of a standard StAX parser
(or any other StAX XMLStreamReader implementation)
int | getColumnNumber() - Return the column number where the current document event ends.
|
int | getLineNumber() - Return the line number where the current document event ends.
|
int | getLineNumber(long locationId) - Get the line number within the document or module containing a particular location
|
NamePool | getNamePool() - Get the name pool
|
PipelineConfiguration | getPipelineConfiguration() - Get configuration information.
|
String | getPublicId() - Return the public identifier for the current document event.
|
String | getSystemId() - Return the system identifier for the current document event.
|
String | getSystemId(long locationId) - Get the URI of the document or module containing a particular location
|
List | getUnparsedEntities() - Get a list of unparsed entities.
|
XMLStreamReader | getXMLStreamReader() - Get the XMLStreamReader used by this StaxBridge.
|
boolean | isFlatSequence() - Determine whether the EventIterator returns a flat sequence of events, or whether it can return
nested event iterators
|
static void | main(String[] args) - Simple test program
Usage: java StaxBridge in.xml [out.xml]
|
PullEvent | next() - Get the next event
|
void | setInputStream(String systemId, InputStream inputStream) - Supply an input stream containing XML to be parsed.
|
void | setPipelineConfiguration(PipelineConfiguration pipe) - Set configuration information.
|
void | setXMLStreamReader(XMLStreamReader reader) - Supply an XMLStreamReader: the events reported by this XMLStreamReader will be translated
into EventIterator events
|
StaxEventBridge
public StaxEventBridge()
Create a new instance of the class
getColumnNumber
public int getColumnNumber()
Return the column number where the current document event ends.
This is one-based number of Java
char
values since
the last line end.
Warning: 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.
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.
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.
- The column number, or -1 if none is available.
getLineNumber
public int getLineNumber()
Return the line number where the current document event ends.
Lines are delimited by line ends, which are defined in
the XML specification.
Warning: 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.
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.
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.
- The line number, or -1 if none is available.
getLineNumber
public int getLineNumber(long locationId)
Get the line number within the document or module containing a particular location
- getLineNumber in interface LocationProvider
locationId
- identifier of the location in question (as passed down the Receiver pipeline)
- the line number within the document or module.
getNamePool
public NamePool getNamePool()
Get the name pool
getPipelineConfiguration
public PipelineConfiguration getPipelineConfiguration()
Get configuration information.
- the pipeline configuration
getPublicId
public String getPublicId()
Return the public identifier for the current document event.
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.
- A string containing the public identifier, or
null if none is available.
getSystemId
public String getSystemId()
Return the system identifier for the current document event.
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.
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
file:... URL, and other
kinds of relative URI are also resolved against their bases.
- A string containing the system identifier, or null
if none is available.
getSystemId
public String getSystemId(long locationId)
Get the URI of the document or module containing a particular location
- getSystemId in interface LocationProvider
locationId
- identifier of the location in question (as passed down the Receiver pipeline)
- the URI of the document or module.
getUnparsedEntities
public List getUnparsedEntities()
Get a list of unparsed entities.
- 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
UnparsedEntity
getXMLStreamReader
public XMLStreamReader getXMLStreamReader()
Get the XMLStreamReader used by this StaxBridge. This is available only after
setInputStream() or setXMLStreamReader() has been called
- the instance of XMLStreamReader allocated when setInputStream() was called,
or the instance supplied directly to setXMLStreamReader()
isFlatSequence
public boolean isFlatSequence()
Determine whether the EventIterator returns a flat sequence of events, or whether it can return
nested event iterators
- isFlatSequence in interface EventIterator
- true if the next() method is guaranteed never to return an EventIterator
main
public static void main(String[] args)
throws Exception
Simple test program
Usage: java StaxBridge in.xml [out.xml]
args
- command line arguments
setInputStream
public void setInputStream(String systemId,
InputStream inputStream)
throws XPathException
Supply an input stream containing XML to be parsed. A StAX parser is created using
the JAXP XMLInputFactory.
systemId
- The Base URI of the input documentinputStream
- the stream containing the XML to be parsed
setPipelineConfiguration
public void setPipelineConfiguration(PipelineConfiguration pipe)
Set configuration information. This must only be called before any events
have been read.
pipe
- the pipeline configuration
setXMLStreamReader
public void setXMLStreamReader(XMLStreamReader reader)
Supply an XMLStreamReader: the events reported by this XMLStreamReader will be translated
into EventIterator events
reader
- the supplier of XML events, typically an XML parser