org.apache.axiom.util.stax

Class WrappedTextNodeStreamReader

java.lang.Object

org.apache.axiom.util.stax.WrappedTextNodeStreamReader

All Implemented Interfaces:

javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader

public class WrappedTextNodeStreamReader
extends java.lang.Object
implements javax.xml.stream.XMLStreamReader

XMLStreamReader implementation that represents a text node wrapped inside an element. The text data is provided by a Reader.

It will produce the following sequence of XML events:

• START_DOCUMENT
• START_ELEMENT
• (CHARACTER)*
• END_ELEMENT
• END_DOCMENT

The class is implemented as a simple state machine, where the state is identified by the current event type. The initial state is START_DOCUMENT and the following transitions are triggered by next():

• START_DOCUMENT → START_ELEMENT
• START_ELEMENT → END_ELEMENT (if character stream is empty)
• START_ELEMENT → CHARACTERS (if character stream is not empty)
• CHARACTERS → CHARACTERS (if data available in stream)
• CHARACTERS → END_ELEMENT (if end of stream reached)
• END_ELEMENT → END_DOCUMENT

Additionally, getElementText() triggers the following transition:

• START_ELEMENT → END_ELEMENT

Note that since multiple consecutive CHARACTERS events may be returned, this "parser" is not coalescing.

Field Summary

Fields

Modifier and Type	Field and Description
private char[]	charData The character data for the current event.
private int	charDataLength The length of the character data in charData.
private int	chunkSize The maximum number of characters to return for each CHARACTER event.
private int	eventType The type of the current XML event.
private javax.xml.namespace.NamespaceContext	namespaceContext The namespace context applicable in the scope of the wrapper element.
private java.io.Reader	reader The Reader object that represents the text data.
private javax.xml.namespace.QName	wrapperElementName The qualified name of the wrapper element.

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

Constructors

Constructor and Description
WrappedTextNodeStreamReader(javax.xml.namespace.QName wrapperElementName, java.io.Reader reader) Create a new instance with chunk size 4096.
WrappedTextNodeStreamReader(javax.xml.namespace.QName wrapperElementName, java.io.Reader reader, int chunkSize) Create a new instance.

Method Summary

Modifier and Type	Method and Description
private void	checkCharacters()
private void	checkElement()
private void	checkStartElement()
void	close()
int	getAttributeCount()
java.lang.String	getAttributeLocalName(int index)
javax.xml.namespace.QName	getAttributeName(int index)
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()
javax.xml.stream.Location	getLocation()
javax.xml.namespace.QName	getName()
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)
java.lang.String	getPIData()
java.lang.String	getPITarget()
java.lang.String	getPrefix()
java.lang.Object	getProperty(java.lang.String name)
java.lang.String	getText()
char[]	getTextCharacters()
int	getTextCharacters(int sourceStart, char[] target, int targetStart, int length)
int	getTextLength()
int	getTextStart()
java.lang.String	getVersion()
boolean	hasName()
boolean	hasNext()
boolean	hasText()
boolean	isAttributeSpecified(int index)
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)
boolean	standaloneSet()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

wrapperElementName

private final javax.xml.namespace.QName wrapperElementName

The qualified name of the wrapper element.

reader

private final java.io.Reader reader

The Reader object that represents the text data.

chunkSize

private final int chunkSize

The maximum number of characters to return for each CHARACTER event.

eventType

private int eventType

The type of the current XML event.

charData

private char[] charData

The character data for the current event. This is only set if the current event is a CHARACTER event. The size of the array is determined by chunkSize

charDataLength

private int charDataLength

The length of the character data in charData.

namespaceContext

private javax.xml.namespace.NamespaceContext namespaceContext

The namespace context applicable in the scope of the wrapper element. Beside the default mappings for xml and xmlns, it only contains the mapping for the namespace of the wrapper element. This attribute is initialized lazily by getNamespaceContext().

Constructor Detail

WrappedTextNodeStreamReader

public WrappedTextNodeStreamReader(javax.xml.namespace.QName wrapperElementName,
                                   java.io.Reader reader,
                                   int chunkSize)

Create a new instance.

Parameters:

wrapperElementName - the qualified name of the wrapper element

reader - the Reader object holding the character data to be wrapped

chunkSize - the maximum number of characters that are returned for each CHARACTER event

WrappedTextNodeStreamReader

public WrappedTextNodeStreamReader(javax.xml.namespace.QName wrapperElementName,
                                   java.io.Reader reader)

Create a new instance with chunk size 4096.

Parameters:

wrapperElementName - the qualified name of the wrapper element

reader - the Reader object holding the character data to be wrapped

Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws java.lang.IllegalArgumentException

Specified by:

getProperty in interface javax.xml.stream.XMLStreamReader

Throws:

java.lang.IllegalArgumentException

hasNext

public boolean hasNext()
                throws javax.xml.stream.XMLStreamException

Specified by:

hasNext in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

next

public int next()
         throws javax.xml.stream.XMLStreamException

Specified by:

next in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

nextTag

public int nextTag()
            throws javax.xml.stream.XMLStreamException

Specified by:

nextTag in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

getEventType

public int getEventType()

Specified by:

getEventType in interface javax.xml.stream.XMLStreamReader

isStartElement

public boolean isStartElement()

Specified by:

isStartElement in interface javax.xml.stream.XMLStreamReader

isEndElement

public boolean isEndElement()

Specified by:

isEndElement in interface javax.xml.stream.XMLStreamReader

isCharacters

public boolean isCharacters()

Specified by:

isCharacters in interface javax.xml.stream.XMLStreamReader

isWhiteSpace

public boolean isWhiteSpace()

Specified by:

isWhiteSpace in interface javax.xml.stream.XMLStreamReader

hasText

public boolean hasText()

Specified by:

hasText in interface javax.xml.stream.XMLStreamReader

hasName

public boolean hasName()

Specified by:

hasName in interface javax.xml.stream.XMLStreamReader

require

public void require(int type,
                    java.lang.String namespaceURI,
                    java.lang.String localName)
             throws javax.xml.stream.XMLStreamException

Specified by:

require in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

getLocation

public javax.xml.stream.Location getLocation()

Specified by:

getLocation in interface javax.xml.stream.XMLStreamReader

close

public void close()
           throws javax.xml.stream.XMLStreamException

Specified by:

close in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

getEncoding

public java.lang.String getEncoding()

Specified by:

getEncoding in interface javax.xml.stream.XMLStreamReader

getCharacterEncodingScheme

public java.lang.String getCharacterEncodingScheme()

Specified by:

getCharacterEncodingScheme in interface javax.xml.stream.XMLStreamReader

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface javax.xml.stream.XMLStreamReader

standaloneSet

public boolean standaloneSet()

Specified by:

standaloneSet in interface javax.xml.stream.XMLStreamReader

isStandalone

public boolean isStandalone()

Specified by:

isStandalone in interface javax.xml.stream.XMLStreamReader

getNamespaceContext

public javax.xml.namespace.NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface javax.xml.stream.XMLStreamReader

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)

Specified by:

getNamespaceURI in interface javax.xml.stream.XMLStreamReader

checkStartElement

private void checkStartElement()

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String namespaceURI,
                                          java.lang.String localName)

Specified by:

getAttributeValue in interface javax.xml.stream.XMLStreamReader

getAttributeCount

public int getAttributeCount()

Specified by:

getAttributeCount in interface javax.xml.stream.XMLStreamReader

getAttributeName

public javax.xml.namespace.QName getAttributeName(int index)

Specified by:

getAttributeName in interface javax.xml.stream.XMLStreamReader

getAttributeLocalName

public java.lang.String getAttributeLocalName(int index)

Specified by:

getAttributeLocalName in interface javax.xml.stream.XMLStreamReader

getAttributePrefix

public java.lang.String getAttributePrefix(int index)

Specified by:

getAttributePrefix in interface javax.xml.stream.XMLStreamReader

getAttributeNamespace

public java.lang.String getAttributeNamespace(int index)

Specified by:

getAttributeNamespace in interface javax.xml.stream.XMLStreamReader

getAttributeType

public java.lang.String getAttributeType(int index)

Specified by:

getAttributeType in interface javax.xml.stream.XMLStreamReader

getAttributeValue

public java.lang.String getAttributeValue(int index)

Specified by:

getAttributeValue in interface javax.xml.stream.XMLStreamReader

isAttributeSpecified

public boolean isAttributeSpecified(int index)

Specified by:

isAttributeSpecified in interface javax.xml.stream.XMLStreamReader

checkElement

private void checkElement()

getName

public javax.xml.namespace.QName getName()

Specified by:

getName in interface javax.xml.stream.XMLStreamReader

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface javax.xml.stream.XMLStreamReader

getPrefix

public java.lang.String getPrefix()

Specified by:

getPrefix in interface javax.xml.stream.XMLStreamReader

getNamespaceURI

public java.lang.String getNamespaceURI()

Specified by:

getNamespaceURI in interface javax.xml.stream.XMLStreamReader

getNamespaceCount

public int getNamespaceCount()

Specified by:

getNamespaceCount in interface javax.xml.stream.XMLStreamReader

getNamespacePrefix

public java.lang.String getNamespacePrefix(int index)

Specified by:

getNamespacePrefix in interface javax.xml.stream.XMLStreamReader

getNamespaceURI

public java.lang.String getNamespaceURI(int index)

Specified by:

getNamespaceURI in interface javax.xml.stream.XMLStreamReader

getElementText

public java.lang.String getElementText()
                                throws javax.xml.stream.XMLStreamException

Specified by:

getElementText in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

checkCharacters

private void checkCharacters()

getText

public java.lang.String getText()

Specified by:

getText in interface javax.xml.stream.XMLStreamReader

getTextCharacters

public char[] getTextCharacters()

Specified by:

getTextCharacters in interface javax.xml.stream.XMLStreamReader

getTextStart

public int getTextStart()

Specified by:

getTextStart in interface javax.xml.stream.XMLStreamReader

getTextLength

public int getTextLength()

Specified by:

getTextLength in interface javax.xml.stream.XMLStreamReader

getTextCharacters

public int getTextCharacters(int sourceStart,
                             char[] target,
                             int targetStart,
                             int length)
                      throws javax.xml.stream.XMLStreamException

Specified by:

getTextCharacters in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

getPIData

public java.lang.String getPIData()

Specified by:

getPIData in interface javax.xml.stream.XMLStreamReader

getPITarget

public java.lang.String getPITarget()

Specified by:

getPITarget in interface javax.xml.stream.XMLStreamReader