net.sf.saxon.pull
public class StaxBridge extends Object implements PullProvider, SaxonLocator
Nested Class Summary | |
---|---|
class | StaxBridge.StaxNamespaces |
Field Summary | |
---|---|
int | currentEvent |
int | depth |
Constructor Summary | |
---|---|
StaxBridge() |
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 | getFingerprint()
Get the fingerprint of the name of the element. |
int | getLineNumber()
Return the line number where the current document event ends.
|
int | getLineNumber(int locationId) |
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 |
NamespaceDeclarations | 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.
|
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(int locationId) |
int | getTypeAnnotation()
Get the type annotation of the current attribute or element node, or atomic value.
|
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) |
void | setPipelineConfiguration(PipelineConfiguration pipe)
Set configuration information. |
int | skipToMatchingEnd()
Skip the current subtree. |
Returns: the current event
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().
Returns: an AttributeCollection representing the attributes of the element that has just been notified.
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.
Returns: The column number, or -1 if none is available.
See Also: StaxBridge
Returns: the fingerprint. The fingerprint can be used to obtain the local name and namespace URI from the name pool.
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.
Returns: The line number, or -1 if none is available.
See Also: StaxBridge
Returns: the nameCode. The nameCode can be used to obtain the prefix, local name, and namespace URI from the name pool.
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().
*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.
Returns: A string containing the public identifier, or null if none is available.
See Also: StaxBridge
In other situations the result is undefined and may result in an IllegalStateException.
If the most recent event was a 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 END_ELEMENT. The next call of next() will return the event following the END_ELEMENT event.
Returns: the String Value of the node in question, defined according to the rules in the XPath data model.
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.
Returns: A string containing the system identifier, or null if none is available.
See Also: StaxBridge
Returns: the type annotation. This code is the fingerprint of a type name, which may be resolved to a SchemaType by access to the Configuration.
Returns: the instance of XMLStreamReader allocated when setInputStream() was called
Returns: an integer code indicating the type of event. The code END_OF_INPUT is returned at the end of the sequence.