|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.pull.StaxBridge
public class StaxBridge
This class implements the Saxon PullProvider API on top of a standard StAX parser (or any other StAX XMLStreamReader implementation)
Field Summary |
---|
Fields inherited from interface net.sf.saxon.pull.PullProvider |
---|
ATOMIC_VALUE, ATTRIBUTE, COMMENT, END_DOCUMENT, END_ELEMENT, END_OF_INPUT, NAMESPACE, PROCESSING_INSTRUCTION, START_DOCUMENT, START_ELEMENT, START_OF_INPUT, TEXT |
Constructor Summary | |
---|---|
StaxBridge()
Create a new instance of the class |
Method Summary | |
---|---|
void |
close()
Close the event reader. |
int |
current()
Get the event most recently returned by next(), or by other calls that change the position, for example getStringValue() and skipToMatchingEnd(). |
AtomicValue |
getAtomicValue()
Get an atomic value. |
AttributeCollection |
getAttributes()
Get the attributes associated with the current element. |
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 |
getFingerprint()
Get the fingerprint of the name of the element. |
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 |
int |
getLocationId()
Get the location of the current event. |
int |
getNameCode()
Get the nameCode identifying the name of the current node. |
NamePool |
getNamePool()
Get the name pool |
NamespaceBinding[] |
getNamespaceDeclarations()
Get the namespace declarations associated with the current element. |
PipelineConfiguration |
getPipelineConfiguration()
Get configuration information. |
String |
getPublicId()
Return the public identifier for the current document event. |
SchemaType |
getSchemaType()
Get the type annotation of the current attribute or element node, or atomic value. |
SourceLocator |
getSourceLocator()
Get the location of the current event. |
CharSequence |
getStringValue()
Get the string value of the current element, text node, processing-instruction, or top-level attribute or namespace node, or atomic value. |
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. |
static void |
main(String[] args)
Simple test program Usage: java StaxBridge in.xml [out.xml] |
int |
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 PullProvider events |
int |
skipToMatchingEnd()
Skip the current subtree. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StaxBridge()
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)
setPipelineConfiguration
in interface PullProvider
pipe
- the pipeline configurationpublic PipelineConfiguration getPipelineConfiguration()
getPipelineConfiguration
in interface PullProvider
public XMLStreamReader getXMLStreamReader()
public NamePool getNamePool()
public int next() throws XPathException
next
in interface PullProvider
PullProvider.END_OF_INPUT
is returned at the end of the sequence.
XPathException
- if a dynamic error occurspublic int current()
current
in interface PullProvider
public AttributeCollection getAttributes() throws XPathException
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().
getAttributes
in interface PullProvider
XPathException
- if a dynamic error occurspublic NamespaceBinding[] getNamespaceDeclarations() throws XPathException
It is permissible for this method to return namespace declarations that are redundant.
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.
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().
*
getNamespaceDeclarations
in interface PullProvider
XPathException
- if a dynamic error occurspublic int skipToMatchingEnd() throws XPathException
skipToMatchingEnd
in interface PullProvider
XPathException
- if a dynamic error occurspublic void close()
PullProvider.END_OF_INPUT
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.
close
in interface PullProvider
public int getNameCode()
PullProvider.START_ELEMENT
, PullProvider.PROCESSING_INSTRUCTION
,
PullProvider.ATTRIBUTE
, or PullProvider.NAMESPACE
events. With some PullProvider implementations,
including this one, it can also be used after PullProvider.END_ELEMENT
.
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.
getNameCode
in interface PullProvider
public int getFingerprint()
PullProvider.START_ELEMENT
, PullProvider.PROCESSING_INSTRUCTION
,
PullProvider.ATTRIBUTE
, or PullProvider.NAMESPACE
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.
getFingerprint
in interface PullProvider
public CharSequence getStringValue() throws XPathException
In other situations the result is undefined and may result in an IllegalStateException.
If the most recent event was a PullProvider.START_ELEMENT
, this method causes the content
of the element to be read. The current event on completion of this method will be the
corresponding PullProvider.END_ELEMENT
. The next call of next() will return the event following
the END_ELEMENT event.
getStringValue
in interface PullProvider
XPathException
- if a dynamic error occurspublic AtomicValue getAtomicValue()
getAtomicValue
in interface PullProvider
public int getLocationId()
LocationProvider
held by the PipelineConfiguration
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.
public SchemaType getSchemaType()
getSchemaType
in interface PullProvider
public SourceLocator getSourceLocator()
getSourceLocator
in interface PullProvider
public 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()
getUnparsedEntities
in interface PullProvider
UnparsedEntity
public static void main(String[] args) throws Exception
args
- command line arguments
Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |