org.apache.axiom.om.impl.common

Class OMStAXWrapper

java.lang.Object

javax.xml.stream.util.StreamReaderDelegate

org.apache.axiom.om.impl.common.OMStAXWrapper

All Implemented Interfaces:

javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader, OMXMLStreamReaderEx, OMAttachmentAccessor, OMXMLStreamReader

class OMStAXWrapper
extends javax.xml.stream.util.StreamReaderDelegate
implements OMXMLStreamReaderEx

XMLStreamReader implementation that generates events from a given Axiom tree. This class does intentionally does not implement XMLStreamReaderContainer because it does not wrap a parser (it wraps an OM graph).

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.commons.logging.Log	log
private SwitchingWrapper	switchingWrapper
private XOPEncodingStreamReader	xopEncoder

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
OMStAXWrapper(OMXMLParserWrapper builder, OMContainer startNode) When constructing the OMStaxWrapper, the creator must produce the builder (an instance of the OMXMLparserWrapper of the input) and the Element Node to start parsing.
OMStAXWrapper(OMXMLParserWrapper builder, OMContainer startNode, boolean cache, boolean preserveNamespaceContext) Constructor OMStAXWrapper.

Method Summary

Modifier and Type	Method and Description
void	enableDataSourceEvents(boolean value) If enabled, treat OMSourcedElements that have a OMDataSource as leaf nodes.
javax.activation.DataHandler	getDataHandler(java.lang.String contentID)
OMDataSource	getDataSource()
boolean	isClosed()
boolean	isInlineMTOM() By default, an OMText item that has an MTOM datahandler will be rendered as a inlined text event.
void	releaseParserOnClose(boolean value)
void	setInlineMTOM(boolean value)

Methods inherited from class javax.xml.stream.util.StreamReaderDelegate

close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getCharacterEncodingScheme, getElementText, getEncoding, getEventType, getLocalName, getLocation, getName, getNamespaceContext, getNamespaceCount, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getParent, getPIData, getPITarget, getPrefix, getProperty, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, getVersion, hasName, hasNext, hasText, isAttributeSpecified, isCharacters, isEndElement, isStandalone, isStartElement, isWhiteSpace, next, nextTag, require, setParent, standaloneSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.stream.XMLStreamReader

close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getCharacterEncodingScheme, getElementText, getEncoding, getEventType, getLocalName, getLocation, getName, getNamespaceContext, getNamespaceCount, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getPIData, getPITarget, getPrefix, getProperty, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, getVersion, hasName, hasNext, hasText, isAttributeSpecified, isCharacters, isEndElement, isStandalone, isStartElement, isWhiteSpace, next, nextTag, require, standaloneSet

Field Detail

log

private static final org.apache.commons.logging.Log log

switchingWrapper

private final SwitchingWrapper switchingWrapper

xopEncoder

private XOPEncodingStreamReader xopEncoder

Constructor Detail

OMStAXWrapper

public OMStAXWrapper(OMXMLParserWrapper builder,
                     OMContainer startNode)

When constructing the OMStaxWrapper, the creator must produce the builder (an instance of the OMXMLparserWrapper of the input) and the Element Node to start parsing. The wrapper will parse(proceed) until the end of the given element. Hence care should be taken to pass the root element if the entire document is needed.

Parameters:

builder -

startNode -

OMStAXWrapper

public OMStAXWrapper(OMXMLParserWrapper builder,
                     OMContainer startNode,
                     boolean cache,
                     boolean preserveNamespaceContext)

Constructor OMStAXWrapper.

Parameters:

builder -

startNode -

cache -

preserveNamespaceContext -

Method Detail

isInlineMTOM

public boolean isInlineMTOM()

Description copied from interface: OMXMLStreamReader

By default, an OMText item that has an MTOM datahandler will be rendered as a inlined text event.

Specified by:

isInlineMTOM in interface OMXMLStreamReader

Returns:

true if inlined as TEXT, false if XOP_INCLUDE is used

setInlineMTOM

public void setInlineMTOM(boolean value)

Specified by:

setInlineMTOM in interface OMXMLStreamReader

Parameters:

value - set to true if inlining of text is desired (default) throw OMException if not the value is not supported.

getDataHandler

public javax.activation.DataHandler getDataHandler(java.lang.String contentID)

Specified by:

getDataHandler in interface OMAttachmentAccessor

Parameters:

contentID - (without the surrounding angle brackets and "cid:" prefix)

Returns:

The DataHandler of the mime part referred by the Content-Id or *null* if the mime part referred by the content-id does not exist

isClosed

public boolean isClosed()

Specified by:

isClosed in interface OMXMLStreamReaderEx

releaseParserOnClose

public void releaseParserOnClose(boolean value)

Specified by:

releaseParserOnClose in interface OMXMLStreamReaderEx

getDataSource

public OMDataSource getDataSource()

Specified by:

getDataSource in interface OMXMLStreamReaderEx

Returns:

OMDataSource if available

enableDataSourceEvents

public void enableDataSourceEvents(boolean value)

Description copied from interface: OMXMLStreamReaderEx

If enabled, treat OMSourcedElements that have a OMDataSource as leaf nodes. The caller should use the getDataSource method to obtain the OMDataSource for these events.

Specified by:

enableDataSourceEvents in interface OMXMLStreamReaderEx

Parameters:

value - boolean