org.jvnet.staxex.util
Class DOMStreamReader

java.lang.Object
  extended by org.jvnet.staxex.util.DOMStreamReader
All Implemented Interfaces:
NamespaceContext, XMLStreamConstants, XMLStreamReader
Direct Known Subclasses:
LazyEnvelopeStaxReader, SaajStaxReaderEx

public class DOMStreamReader
extends Object
implements XMLStreamReader, NamespaceContext

Create an XMLStreamReader on top of a DOM tree.

Since various libraries as well as users often create "incorrect" DOM node, this class spends a lot of efforts making sure that broken DOM trees are nevertheless interpreted correctly.

For example, if a DOM level 1 tree is passed, each method will attempt to return the correct value by using Node.getNodeName().

Similarly, if DOM is missing explicit namespace declarations, this class attempts to emulate necessary declarations.

Author:
Santiago.PericasGeertsen@sun.com, Kohsuke Kawaguchi

Nested Class Summary
protected static class DOMStreamReader.Scope
          Namespace declarations on one element.
 
Field Summary
protected  Node _current
          Current DOM node being traversed.
protected  int _state
          State of this reader.
protected  int depth
          Depth of the current element.
protected  DOMStreamReader.Scope[] scopes
          DOMStreamReader.Scope buffer.
protected  String wholeText
          If the reader points at the text node, its whole value.
 
Fields inherited from interface javax.xml.stream.XMLStreamConstants
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT
 
Constructor Summary
DOMStreamReader()
           
DOMStreamReader(Node node)
           
 
Method Summary
protected  int _next()
           
 void close()
           
 int getAttributeCount()
           
 String getAttributeLocalName(int index)
          Return an attribute's local name.
 QName getAttributeName(int index)
          Return an attribute's qname.
 String getAttributeNamespace(int index)
           
 String getAttributePrefix(int index)
           
 String getAttributeType(int index)
           
 String getAttributeValue(int index)
           
 String getAttributeValue(String namespaceURI, String localName)
           
 String getCharacterEncodingScheme()
           
 String getElementText()
           
 String getEncoding()
           
 int getEventType()
           
 String getLocalName()
          Return an element's local name.
 Location getLocation()
           
 QName getName()
          Return an element's qname.
 NamespaceContext getNamespaceContext()
           
 int getNamespaceCount()
           
 String getNamespacePrefix(int index)
           
 String getNamespaceURI()
           
 String getNamespaceURI(int index)
           
 String getNamespaceURI(String prefix)
          This method is not particularly fast, but shouldn't be called very often.
 String getPIData()
           
 String getPITarget()
           
 String getPrefix()
           
 String getPrefix(String nsUri)
           
 Iterator getPrefixes(String nsUri)
           
 Object getProperty(String str)
           
 String getText()
           
 char[] getTextCharacters()
           
 int getTextCharacters(int sourceStart, char[] target, int targetStart, int targetLength)
           
 int getTextLength()
           
 int getTextStart()
           
 String getVersion()
           
 boolean hasName()
           
 boolean hasNext()
           
 boolean hasText()
           
 boolean isAttributeSpecified(int param)
           
 boolean isCharacters()
           
 boolean isEndElement()
           
 boolean isStandalone()
           
 boolean isStartElement()
           
 boolean isWhiteSpace()
           
 int next()
           
 int nextTag()
           
 void require(int type, String namespaceURI, String localName)
           
 void setCurrentNode(Node node)
           
protected  void splitAttributes()
          Called when the current node is Element to look at attribute list (which contains both ns decl and attributes in DOM) and split them to attributes-proper and namespace decls.
 boolean standaloneSet()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_current

protected Node _current
Current DOM node being traversed.


wholeText

protected String wholeText
If the reader points at the text node, its whole value.

This is simply a cache of Text.getWholeText() of _current, but when a large binary data sent as base64 text, this could get very much non-trivial.


scopes

protected DOMStreamReader.Scope[] scopes
DOMStreamReader.Scope buffer.


depth

protected int depth
Depth of the current element. The first element gets depth==0. Also used as the index to scopes.


_state

protected int _state
State of this reader. Any of the valid states defined in StAX' XMLStreamConstants class.

Constructor Detail

DOMStreamReader

public DOMStreamReader()

DOMStreamReader

public DOMStreamReader(Node node)
Method Detail

setCurrentNode

public void setCurrentNode(Node node)

close

public void close()
           throws XMLStreamException
Specified by:
close in interface XMLStreamReader
Throws:
XMLStreamException

splitAttributes

protected void splitAttributes()
Called when the current node is Element to look at attribute list (which contains both ns decl and attributes in DOM) and split them to attributes-proper and namespace decls.


getAttributeCount

public int getAttributeCount()
Specified by:
getAttributeCount in interface XMLStreamReader

getAttributeLocalName

public String getAttributeLocalName(int index)
Return an attribute's local name. Handle the case of DOM level 1 nodes.

Specified by:
getAttributeLocalName in interface XMLStreamReader

getAttributeName

public QName getAttributeName(int index)
Return an attribute's qname. Handle the case of DOM level 1 nodes.

Specified by:
getAttributeName in interface XMLStreamReader

getAttributeNamespace

public String getAttributeNamespace(int index)
Specified by:
getAttributeNamespace in interface XMLStreamReader

getAttributePrefix

public String getAttributePrefix(int index)
Specified by:
getAttributePrefix in interface XMLStreamReader

getAttributeType

public String getAttributeType(int index)
Specified by:
getAttributeType in interface XMLStreamReader

getAttributeValue

public String getAttributeValue(int index)
Specified by:
getAttributeValue in interface XMLStreamReader

getAttributeValue

public String getAttributeValue(String namespaceURI,
                                String localName)
Specified by:
getAttributeValue in interface XMLStreamReader

getCharacterEncodingScheme

public String getCharacterEncodingScheme()
Specified by:
getCharacterEncodingScheme in interface XMLStreamReader

getElementText

public String getElementText()
                      throws XMLStreamException
Specified by:
getElementText in interface XMLStreamReader
Throws:
XMLStreamException

getEncoding

public String getEncoding()
Specified by:
getEncoding in interface XMLStreamReader

getEventType

public int getEventType()
Specified by:
getEventType in interface XMLStreamReader

getLocalName

public String getLocalName()
Return an element's local name. Handle the case of DOM level 1 nodes.

Specified by:
getLocalName in interface XMLStreamReader

getLocation

public Location getLocation()
Specified by:
getLocation in interface XMLStreamReader

getName

public QName getName()
Return an element's qname. Handle the case of DOM level 1 nodes.

Specified by:
getName in interface XMLStreamReader

getNamespaceContext

public NamespaceContext getNamespaceContext()
Specified by:
getNamespaceContext in interface XMLStreamReader

getNamespaceCount

public int getNamespaceCount()
Specified by:
getNamespaceCount in interface XMLStreamReader

getNamespacePrefix

public String getNamespacePrefix(int index)
Specified by:
getNamespacePrefix in interface XMLStreamReader

getNamespaceURI

public String getNamespaceURI(int index)
Specified by:
getNamespaceURI in interface XMLStreamReader

getNamespaceURI

public String getNamespaceURI()
Specified by:
getNamespaceURI in interface XMLStreamReader

getNamespaceURI

public String getNamespaceURI(String prefix)
This method is not particularly fast, but shouldn't be called very often. If we start to use it more, we should keep track of the NS declarations using a NamespaceContext implementation instead.

Specified by:
getNamespaceURI in interface NamespaceContext
Specified by:
getNamespaceURI in interface XMLStreamReader

getPrefix

public String getPrefix(String nsUri)
Specified by:
getPrefix in interface NamespaceContext

getPrefixes

public Iterator getPrefixes(String nsUri)
Specified by:
getPrefixes in interface NamespaceContext

getPIData

public String getPIData()
Specified by:
getPIData in interface XMLStreamReader

getPITarget

public String getPITarget()
Specified by:
getPITarget in interface XMLStreamReader

getPrefix

public String getPrefix()
Specified by:
getPrefix in interface XMLStreamReader

getProperty

public Object getProperty(String str)
                   throws IllegalArgumentException
Specified by:
getProperty in interface XMLStreamReader
Throws:
IllegalArgumentException

getText

public String getText()
Specified by:
getText in interface XMLStreamReader

getTextCharacters

public char[] getTextCharacters()
Specified by:
getTextCharacters in interface XMLStreamReader

getTextCharacters

public int getTextCharacters(int sourceStart,
                             char[] target,
                             int targetStart,
                             int targetLength)
                      throws XMLStreamException
Specified by:
getTextCharacters in interface XMLStreamReader
Throws:
XMLStreamException

getTextLength

public int getTextLength()
Specified by:
getTextLength in interface XMLStreamReader

getTextStart

public int getTextStart()
Specified by:
getTextStart in interface XMLStreamReader

getVersion

public String getVersion()
Specified by:
getVersion in interface XMLStreamReader

hasName

public boolean hasName()
Specified by:
hasName in interface XMLStreamReader

hasNext

public boolean hasNext()
                throws XMLStreamException
Specified by:
hasNext in interface XMLStreamReader
Throws:
XMLStreamException

hasText

public boolean hasText()
Specified by:
hasText in interface XMLStreamReader

isAttributeSpecified

public boolean isAttributeSpecified(int param)
Specified by:
isAttributeSpecified in interface XMLStreamReader

isCharacters

public boolean isCharacters()
Specified by:
isCharacters in interface XMLStreamReader

isEndElement

public boolean isEndElement()
Specified by:
isEndElement in interface XMLStreamReader

isStandalone

public boolean isStandalone()
Specified by:
isStandalone in interface XMLStreamReader

isStartElement

public boolean isStartElement()
Specified by:
isStartElement in interface XMLStreamReader

isWhiteSpace

public boolean isWhiteSpace()
Specified by:
isWhiteSpace in interface XMLStreamReader

next

public int next()
         throws XMLStreamException
Specified by:
next in interface XMLStreamReader
Throws:
XMLStreamException

_next

protected int _next()
             throws XMLStreamException
Throws:
XMLStreamException

nextTag

public int nextTag()
            throws XMLStreamException
Specified by:
nextTag in interface XMLStreamReader
Throws:
XMLStreamException

require

public void require(int type,
                    String namespaceURI,
                    String localName)
             throws XMLStreamException
Specified by:
require in interface XMLStreamReader
Throws:
XMLStreamException

standaloneSet

public boolean standaloneSet()
Specified by:
standaloneSet in interface XMLStreamReader


Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.