DOMStreamReader (Extended StAX API 1.7.8 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jvnet.staxex.util
Class DOMStreamReader

java.lang.Object
  org.jvnet.staxex.util.DOMStreamReader

All Implemented Interfaces:: javax.xml.namespace.NamespaceContext, javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader

public class DOMStreamReader
extends java.lang.Object
implements javax.xml.stream.XMLStreamReader, javax.xml.namespace.NamespaceContext
extends java.lang.Object
implements javax.xml.stream.XMLStreamReader, javax.xml.namespace.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 org.w3c.dom.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 java.lang.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(org.w3c.dom.Node node)`

Method Summary
`protected int`	`_next()`
`void`	`close()`
`int`	`getAttributeCount()`
`java.lang.String`	`getAttributeLocalName(int index)` Return an attribute's local name.
`javax.xml.namespace.QName`	`getAttributeName(int index)` Return an attribute's qname.
`java.lang.String`	`getAttributeNamespace(int index)`
`java.lang.String`	`getAttributePrefix(int index)`
`java.lang.String`	`getAttributeType(int index)`
`java.lang.String`	`getAttributeValue(int index)`
`java.lang.String`	`getAttributeValue(java.lang.String namespaceURI, java.lang.String localName)`
`java.lang.String`	`getCharacterEncodingScheme()`
`java.lang.String`	`getElementText()`
`java.lang.String`	`getEncoding()`
`int`	`getEventType()`
`java.lang.String`	`getLocalName()` Return an element's local name.
`javax.xml.stream.Location`	`getLocation()`
`javax.xml.namespace.QName`	`getName()` Return an element's qname.
`javax.xml.namespace.NamespaceContext`	`getNamespaceContext()`
`int`	`getNamespaceCount()`
`java.lang.String`	`getNamespacePrefix(int index)`
`java.lang.String`	`getNamespaceURI()`
`java.lang.String`	`getNamespaceURI(int index)`
`java.lang.String`	`getNamespaceURI(java.lang.String prefix)` This method is not particularly fast, but shouldn't be called very often.
`java.lang.String`	`getPIData()`
`java.lang.String`	`getPITarget()`
`java.lang.String`	`getPrefix()`
`java.lang.String`	`getPrefix(java.lang.String nsUri)`
`java.util.Iterator`	`getPrefixes(java.lang.String nsUri)`
`java.lang.Object`	`getProperty(java.lang.String str)`
`java.lang.String`	`getText()`
`char[]`	`getTextCharacters()`
`int`	`getTextCharacters(int sourceStart, char[] target, int targetStart, int targetLength)`
`int`	`getTextLength()`
`int`	`getTextStart()`
`java.lang.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, java.lang.String namespaceURI, java.lang.String localName)`
`void`	`setCurrentNode(org.w3c.dom.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 org.w3c.dom.Node _current

Current DOM node being traversed.

wholeText

protected java.lang.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