Package com.saxonica.xqj.pull
Class PullToStax
- java.lang.Object
-
- com.saxonica.xqj.pull.PullToStax
-
- All Implemented Interfaces:
javax.xml.stream.XMLStreamConstants,javax.xml.stream.XMLStreamReader
public class PullToStax extends java.lang.Object implements javax.xml.stream.XMLStreamReaderThis class bridges PullProvider events to XMLStreamReader (Stax) events. That is, it acts as an XMLStreamReader, fetching the underlying data from a PullProvider.A PullProvider may provide access to any XDM sequence, whereas an XMLStreamReader always reads a document. The conversion of a sequence to a document follows the rules for "normalizing" a sequence in the Serialization specification: for example, atomic values are converted into text nodes, with adjacent atomic values being space-separated.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPullToStax.SourceStreamLocationBridge a SAX SourceLocator to a javax.xml.stream.Location
-
Constructor Summary
Constructors Constructor Description PullToStax(PullProvider provider)Create a PullToStax instance, which wraps a Saxon PullProvider as a Stax XMLStreamReader
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()intgetAttributeCount()java.lang.StringgetAttributeLocalName(int i)javax.xml.namespace.QNamegetAttributeName(int i)java.lang.StringgetAttributeNamespace(int i)java.lang.StringgetAttributePrefix(int i)java.lang.StringgetAttributeType(int i)java.lang.StringgetAttributeValue(int i)java.lang.StringgetAttributeValue(java.lang.String uri, java.lang.String local)java.lang.StringgetCharacterEncodingScheme()java.lang.StringgetElementText()java.lang.StringgetEncoding()intgetEventType()java.lang.StringgetLocalName()javax.xml.stream.LocationgetLocation()javax.xml.namespace.QNamegetName()javax.xml.namespace.NamespaceContextgetNamespaceContext()intgetNamespaceCount()Return the number of namespaces declared on this element.java.lang.StringgetNamespacePrefix(int i)java.lang.StringgetNamespaceURI()java.lang.StringgetNamespaceURI(int i)java.lang.StringgetNamespaceURI(java.lang.String s)java.lang.StringgetPIData()java.lang.StringgetPITarget()java.lang.StringgetPrefix()java.lang.ObjectgetProperty(java.lang.String s)java.lang.StringgetText()char[]getTextCharacters()intgetTextCharacters(int sourceStart, char[] target, int targetStart, int length)intgetTextLength()intgetTextStart()java.lang.StringgetVersion()static javax.xml.stream.XMLStreamReadergetXMLStreamReader(NodeInfo node)Create an XMLStreamReader that reads the contents of a tree rooted at a document or element nodebooleanhasName()booleanhasNext()booleanhasText()booleanisAttributeSpecified(int i)booleanisCharacters()booleanisEndElement()booleanisStandalone()booleanisStartElement()booleanisWhiteSpace()intnext()intnextTag()voidrequire(int event, java.lang.String uri, java.lang.String local)booleanstandaloneSet()
-
-
-
Constructor Detail
-
PullToStax
public PullToStax(PullProvider provider)
Create a PullToStax instance, which wraps a Saxon PullProvider as a Stax XMLStreamReader- Parameters:
provider- the Saxon PullProvider from which the events will be read
-
-
Method Detail
-
getXMLStreamReader
public static javax.xml.stream.XMLStreamReader getXMLStreamReader(NodeInfo node)
Create an XMLStreamReader that reads the contents of a tree rooted at a document or element node- Parameters:
node- the node to be read. This must be a document or element node- Throws:
java.lang.IllegalArgumentException- if the node is not a document or element node
-
getAttributeCount
public int getAttributeCount()
- Specified by:
getAttributeCountin interfacejavax.xml.stream.XMLStreamReader
-
isAttributeSpecified
public boolean isAttributeSpecified(int i)
- Specified by:
isAttributeSpecifiedin interfacejavax.xml.stream.XMLStreamReader
-
getAttributeName
public javax.xml.namespace.QName getAttributeName(int i)
- Specified by:
getAttributeNamein interfacejavax.xml.stream.XMLStreamReader
-
getAttributeLocalName
public java.lang.String getAttributeLocalName(int i)
- Specified by:
getAttributeLocalNamein interfacejavax.xml.stream.XMLStreamReader
-
getAttributeNamespace
public java.lang.String getAttributeNamespace(int i)
- Specified by:
getAttributeNamespacein interfacejavax.xml.stream.XMLStreamReader
-
getAttributePrefix
public java.lang.String getAttributePrefix(int i)
- Specified by:
getAttributePrefixin interfacejavax.xml.stream.XMLStreamReader
-
getAttributeType
public java.lang.String getAttributeType(int i)
- Specified by:
getAttributeTypein interfacejavax.xml.stream.XMLStreamReader
-
getAttributeValue
public java.lang.String getAttributeValue(int i)
- Specified by:
getAttributeValuein interfacejavax.xml.stream.XMLStreamReader
-
getAttributeValue
public java.lang.String getAttributeValue(java.lang.String uri, java.lang.String local)- Specified by:
getAttributeValuein interfacejavax.xml.stream.XMLStreamReader
-
getEventType
public int getEventType()
- Specified by:
getEventTypein interfacejavax.xml.stream.XMLStreamReader
-
getNamespaceCount
public int getNamespaceCount()
Return the number of namespaces declared on this element.- Specified by:
getNamespaceCountin interfacejavax.xml.stream.XMLStreamReader- Returns:
- the number of in-scope namespaces
-
getText
public java.lang.String getText()
- Specified by:
getTextin interfacejavax.xml.stream.XMLStreamReader
-
getTextLength
public int getTextLength()
- Specified by:
getTextLengthin interfacejavax.xml.stream.XMLStreamReader
-
getTextStart
public int getTextStart()
- Specified by:
getTextStartin interfacejavax.xml.stream.XMLStreamReader
-
getTextCharacters
public char[] getTextCharacters()
- Specified by:
getTextCharactersin interfacejavax.xml.stream.XMLStreamReader
-
getTextCharacters
public int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws javax.xml.stream.XMLStreamException- Specified by:
getTextCharactersin interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
next
public int next() throws javax.xml.stream.XMLStreamException- Specified by:
nextin interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
nextTag
public int nextTag() throws javax.xml.stream.XMLStreamException- Specified by:
nextTagin interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
close
public void close() throws javax.xml.stream.XMLStreamException- Specified by:
closein interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
hasName
public boolean hasName()
- Specified by:
hasNamein interfacejavax.xml.stream.XMLStreamReader
-
hasNext
public boolean hasNext() throws javax.xml.stream.XMLStreamException- Specified by:
hasNextin interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
hasText
public boolean hasText()
- Specified by:
hasTextin interfacejavax.xml.stream.XMLStreamReader
-
isCharacters
public boolean isCharacters()
- Specified by:
isCharactersin interfacejavax.xml.stream.XMLStreamReader
-
isEndElement
public boolean isEndElement()
- Specified by:
isEndElementin interfacejavax.xml.stream.XMLStreamReader
-
isStandalone
public boolean isStandalone()
- Specified by:
isStandalonein interfacejavax.xml.stream.XMLStreamReader
-
isStartElement
public boolean isStartElement()
- Specified by:
isStartElementin interfacejavax.xml.stream.XMLStreamReader
-
isWhiteSpace
public boolean isWhiteSpace()
- Specified by:
isWhiteSpacein interfacejavax.xml.stream.XMLStreamReader
-
standaloneSet
public boolean standaloneSet()
- Specified by:
standaloneSetin interfacejavax.xml.stream.XMLStreamReader
-
getCharacterEncodingScheme
public java.lang.String getCharacterEncodingScheme()
- Specified by:
getCharacterEncodingSchemein interfacejavax.xml.stream.XMLStreamReader
-
getElementText
public java.lang.String getElementText() throws javax.xml.stream.XMLStreamException- Specified by:
getElementTextin interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getEncoding
public java.lang.String getEncoding()
- Specified by:
getEncodingin interfacejavax.xml.stream.XMLStreamReader
-
getLocalName
public java.lang.String getLocalName()
- Specified by:
getLocalNamein interfacejavax.xml.stream.XMLStreamReader
-
getNamespaceURI
public java.lang.String getNamespaceURI()
- Specified by:
getNamespaceURIin interfacejavax.xml.stream.XMLStreamReader
-
getPIData
public java.lang.String getPIData()
- Specified by:
getPIDatain interfacejavax.xml.stream.XMLStreamReader
-
getPITarget
public java.lang.String getPITarget()
- Specified by:
getPITargetin interfacejavax.xml.stream.XMLStreamReader
-
getPrefix
public java.lang.String getPrefix()
- Specified by:
getPrefixin interfacejavax.xml.stream.XMLStreamReader
-
getVersion
public java.lang.String getVersion()
- Specified by:
getVersionin interfacejavax.xml.stream.XMLStreamReader
-
getNamespacePrefix
public java.lang.String getNamespacePrefix(int i)
- Specified by:
getNamespacePrefixin interfacejavax.xml.stream.XMLStreamReader
-
getNamespaceURI
public java.lang.String getNamespaceURI(int i)
- Specified by:
getNamespaceURIin interfacejavax.xml.stream.XMLStreamReader
-
getNamespaceContext
public javax.xml.namespace.NamespaceContext getNamespaceContext()
- Specified by:
getNamespaceContextin interfacejavax.xml.stream.XMLStreamReader
-
getName
public javax.xml.namespace.QName getName()
- Specified by:
getNamein interfacejavax.xml.stream.XMLStreamReader
-
getLocation
public javax.xml.stream.Location getLocation()
- Specified by:
getLocationin interfacejavax.xml.stream.XMLStreamReader
-
getProperty
public java.lang.Object getProperty(java.lang.String s) throws java.lang.IllegalArgumentException- Specified by:
getPropertyin interfacejavax.xml.stream.XMLStreamReader- Throws:
java.lang.IllegalArgumentException
-
require
public void require(int event, java.lang.String uri, java.lang.String local) throws javax.xml.stream.XMLStreamException- Specified by:
requirein interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getNamespaceURI
public java.lang.String getNamespaceURI(java.lang.String s)
- Specified by:
getNamespaceURIin interfacejavax.xml.stream.XMLStreamReader
-
-