|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.saxon.dotnet.DotNetPullProvider
public class DotNetPullProvider
This class implements the Saxon PullProvider interface as a wrapper around a .NET XMLReader.
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 | |
---|---|
DotNetPullProvider(XmlReader parser)
|
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 character position 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(long locationId)
Get the line number within the document or module containing a particular location |
int |
getNameCode()
Get the nameCode identifying the name of the current node. |
NamespaceDeclarations |
getNamespaceDeclarations()
Get the namespace declarations associated with the current element. |
PipelineConfiguration |
getPipelineConfiguration()
Get configuration information. |
java.lang.String |
getPublicId()
Return the public identifier for the current document event. |
javax.xml.transform.SourceLocator |
getSourceLocator()
Get the location of the current event. |
java.lang.CharSequence |
getStringValue()
Get the string value of the current element, text node, processing-instruction, or top-level attribute or namespace node, or atomic value. |
java.lang.String |
getSystemId()
Return the system identifier for the current document event. |
java.lang.String |
getSystemId(long locationId)
Get the URI of the document or module containing a particular location |
int |
getTypeAnnotation()
Get the type annotation of the current attribute or element node, or atomic value. |
java.util.List |
getUnparsedEntities()
Get a list of unparsed entities. |
int |
next()
Get the next event |
void |
setBaseURI(java.lang.String base)
Set the base URI to be used. |
void |
setPipelineConfiguration(PipelineConfiguration pipe)
Set configuration information. |
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 DotNetPullProvider(XmlReader parser)
Method Detail |
---|
public void setBaseURI(java.lang.String base)
public 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 current()
current
in interface PullProvider
public AtomicValue getAtomicValue()
getAtomicValue
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
public int getFingerprint()
PullProvider.START_ELEMENT
, PullProvider.END_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 int getNameCode()
PullProvider.START_ELEMENT
, PullProvider.PROCESSING_INSTRUCTION
,
PullProvider.ATTRIBUTE
, or PullProvider.NAMESPACE
events. With some PullProvider implementations,
it can also be used after PullProvider.END_ELEMENT
, but this is not guaranteed: a client who
requires the information at that point (for example, to do serialization) should insert an
ElementNameTracker
into the pipeline.
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 NamespaceDeclarations 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
public PipelineConfiguration getPipelineConfiguration()
getPipelineConfiguration
in interface PullProvider
public javax.xml.transform.SourceLocator getSourceLocator()
getSourceLocator
in interface PullProvider
public java.lang.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
public int getTypeAnnotation()
getTypeAnnotation
in interface PullProvider
SchemaType
by access to the Configuration.public int next() throws XPathException
next
in interface PullProvider
PullProvider.END_OF_INPUT
is returned at the end of the sequence.
XPathException
public void setPipelineConfiguration(PipelineConfiguration pipe)
setPipelineConfiguration
in interface PullProvider
pipe
- the pipeline configurationpublic int skipToMatchingEnd() throws XPathException
skipToMatchingEnd
in interface PullProvider
java.lang.IllegalStateException
- if the method is called at any time other than
immediately after a START_DOCUMENT or START_ELEMENT event.
XPathException
public int getColumnNumber()
Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
The return value is an approximation of the column number in the document entity or external parsed entity where the markup that triggered the event appears.
getColumnNumber
in interface javax.xml.transform.SourceLocator
getColumnNumber
in interface org.xml.sax.Locator
getLineNumber()
public int getLineNumber()
Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
The return value is an approximation of the line number in the document entity or external parsed entity where the markup that triggered the event appears.
getLineNumber
in interface javax.xml.transform.SourceLocator
getLineNumber
in interface org.xml.sax.Locator
getColumnNumber()
public java.lang.String getPublicId()
The return value is the public identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.
getPublicId
in interface javax.xml.transform.SourceLocator
getPublicId
in interface org.xml.sax.Locator
getSystemId()
public java.lang.String getSystemId()
The return value is the system identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.
If the system identifier is a URL, the parser must resolve it fully before passing it to the application.
getSystemId
in interface javax.xml.transform.SourceLocator
getSystemId
in interface org.xml.sax.Locator
getPublicId()
public int getLineNumber(long locationId)
LocationProvider
getLineNumber
in interface LocationProvider
locationId
- identifier of the location in question (as passed down the Receiver pipeline)
public java.lang.String getSystemId(long locationId)
LocationProvider
getSystemId
in interface LocationProvider
locationId
- identifier of the location in question (as passed down the Receiver pipeline)
public java.util.List getUnparsedEntities()
getUnparsedEntities
in interface PullProvider
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |