|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.evpull.StaxToEventBridge
public class StaxToEventBridge
This class implements the Saxon EventIterator API on top of a standard StAX parser (or any other StAX XMLStreamReader implementation)
Constructor Summary | |
---|---|
StaxToEventBridge()
Create a new instance of the class |
Method Summary | |
---|---|
int |
getColumnNumber()
Return the column number where the current document event ends. |
int |
getColumnNumber(long locationId)
Get the column number within the document, entity, or module containing a particular location |
int |
getLineNumber()
Return the line number where the current document event ends. |
int |
getLineNumber(long locationId)
Get the line number within the document, entity 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, entity, 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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StaxToEventBridge()
Method Detail |
---|
public void setInputStream(String systemId, InputStream inputStream) throws XPathException
systemId
- The Base URI of the input documentinputStream
- the stream containing the XML to be parsed
XPathException
- if an error occurs creating the StAX parserpublic void setXMLStreamReader(XMLStreamReader reader)
reader
- the supplier of XML events, typically an XML parserpublic void setPipelineConfiguration(PipelineConfiguration pipe)
pipe
- the pipeline configurationpublic PipelineConfiguration getPipelineConfiguration()
public XMLStreamReader getXMLStreamReader()
public NamePool getNamePool()
public PullEvent next() throws XPathException
next
in interface EventIterator
XPathException
- if a dynamic evaluation error occurspublic String getPublicId()
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.
getPublicId
in interface SourceLocator
getPublicId
in interface Locator
getSystemId()
public String getSystemId()
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.
getSystemId
in interface SourceLocator
getSystemId
in interface Locator
getPublicId()
public int getLineNumber()
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.
getLineNumber
in interface SourceLocator
getLineNumber
in interface Locator
getColumnNumber()
public int getColumnNumber()
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.
getColumnNumber
in interface SourceLocator
getColumnNumber
in interface Locator
getLineNumber()
public String getSystemId(long locationId)
LocationProvider
getSystemId
in interface LocationProvider
locationId
- identifier of the location in question (as passed down the Receiver pipeline)
public int getLineNumber(long locationId)
LocationProvider
getLineNumber
in interface LocationProvider
locationId
- identifier of the location in question (as passed down the Receiver pipeline)
public int getColumnNumber(long locationId)
LocationProvider
getColumnNumber
in interface LocationProvider
locationId
- identifier of the location in question (as passed down the Receiver pipeline)
public List getUnparsedEntities()
UnparsedEntity
public static void main(String[] args) throws Exception
args
- command line arguments
Exception
public boolean isFlatSequence()
isFlatSequence
in interface EventIterator
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |