org.apache.axiom.om.impl.llom
Class OMDocumentImpl

java.lang.Object
  org.apache.axiom.om.impl.llom.OMSerializableImpl
      org.apache.axiom.om.impl.llom.OMDocumentImpl

All Implemented Interfaces:

OMContainerEx, OMContainer, OMDocument, OMInformationItem, OMSerializable

Direct Known Subclasses:

SOAPMessageImpl

public class OMDocumentImpl
extends OMSerializableImpl
implements OMDocument, OMContainerEx

Class OMDocumentImpl

Field Summary

protected java.lang.String	charSetEncoding Field charSetEncoding Default : UTF-8
protected OMNode	firstChild Field firstChild
protected java.lang.String	isStandalone
protected OMNode	lastChild Field lastChild
protected java.lang.String	xmlEncoding
protected java.lang.String	xmlVersion Field xmlVersion

Fields inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

builder, done, factory

Fields inherited from interface org.apache.axiom.om.OMDocument

XML_10, XML_11

Constructor Summary

OMDocumentImpl(OMElement documentElement, OMXMLParserWrapper parserWrapper, OMFactory factory)
Create the OMDoucment with the factory and set the given OMElement as the document element

OMDocumentImpl(OMFactory factory)
Create a OMDocument given the OMFactory

OMDocumentImpl(OMXMLParserWrapper parserWrapper, OMFactory factory)
Create the OMDocument with the factory

Method Summary

void	addChild(OMNode child) Adds child to the element.
void	buildNext() Forces the parser to proceed, if parser has not yet finished with the XML input.
OMXMLParserWrapper	getBuilder()
java.lang.String	getCharsetEncoding()
java.util.Iterator	getChildren() Returns a collection of this element.
java.util.Iterator	getChildrenWithLocalName(java.lang.String localName)
java.util.Iterator	getChildrenWithName(javax.xml.namespace.QName elementQName) Searches for children with a given QName and returns an iterator to traverse through the OMNodes.
java.util.Iterator	getChildrenWithNamespaceURI(java.lang.String uri)
java.util.Iterator	getDescendants(boolean includeSelf)
OMElement	getFirstChildWithName(javax.xml.namespace.QName elementQName) Method getFirstChildWithName.
OMNode	getFirstOMChild() Method getFirstOMChild.
OMNode	getFirstOMChildIfAvailable()
OMElement	getOMDocumentElement()
javax.xml.transform.sax.SAXSource	getSAXSource(boolean cache)
java.lang.String	getXMLEncoding()
javax.xml.stream.XMLStreamReader	getXMLStreamReader()
javax.xml.stream.XMLStreamReader	getXMLStreamReader(boolean cache)
javax.xml.stream.XMLStreamReader	getXMLStreamReader(boolean cache, OMXMLStreamReaderConfiguration configuration)
javax.xml.stream.XMLStreamReader	getXMLStreamReaderWithoutCaching()
java.lang.String	getXMLVersion()
void	internalSerialize(javax.xml.stream.XMLStreamWriter writer) Serializes the document with cache.
void	internalSerialize(javax.xml.stream.XMLStreamWriter writer, boolean cache) Serializes the node.
protected void	internalSerialize(javax.xml.stream.XMLStreamWriter writer, boolean cache, boolean includeXMLDeclaration)
void	internalSerializeAndConsume(javax.xml.stream.XMLStreamWriter writer) Serializes the document with the XML declaration.
java.lang.String	isStandalone()
void	setCharsetEncoding(java.lang.String charEncoding)
void	setComplete(boolean state) Method setComplete.
void	setFirstChild(OMNode firstChild) Method setFirstChild.
void	setLastChild(OMNode omNode) Forcefully set the last child
void	setOMDocumentElement(OMElement documentElement)
void	setStandalone(java.lang.String isStandalone)
void	setXMLEncoding(java.lang.String encoding)
void	setXMLVersion(java.lang.String xmlVersion)

Methods inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

build, close, getOMFactory, isComplete, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.axiom.om.OMContainer

serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMSerializable

build, close, isComplete, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMInformationItem

getOMFactory

Methods inherited from interface org.apache.axiom.om.OMContainer

serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMSerializable

build, close, isComplete, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMInformationItem

getOMFactory

Field Detail

firstChild

protected OMNode firstChild

Field firstChild

lastChild

protected OMNode lastChild

Field lastChild

charSetEncoding

protected java.lang.String charSetEncoding

Field charSetEncoding Default : UTF-8

xmlVersion

protected java.lang.String xmlVersion

Field xmlVersion

xmlEncoding

protected java.lang.String xmlEncoding

isStandalone

protected java.lang.String isStandalone

Constructor Detail

OMDocumentImpl

public OMDocumentImpl(OMFactory factory)

Create a OMDocument given the OMFactory

Parameters:

factory - The OMFactory that created this instace

OMDocumentImpl

public OMDocumentImpl(OMXMLParserWrapper parserWrapper,
                      OMFactory factory)

Create the OMDocument with the factory

Parameters:

parserWrapper -

factory -

OMDocumentImpl

public OMDocumentImpl(OMElement documentElement,
                      OMXMLParserWrapper parserWrapper,
                      OMFactory factory)

Create the OMDoucment with the factory and set the given OMElement as the document element

Parameters:

documentElement -

parserWrapper -

factory -

Method Detail

getBuilder

public OMXMLParserWrapper getBuilder()

Specified by:

getBuilder in interface OMContainer

getOMDocumentElement

public OMElement getOMDocumentElement()

Specified by:

getOMDocumentElement in interface OMDocument

setOMDocumentElement

public void setOMDocumentElement(OMElement documentElement)

Specified by:

setOMDocumentElement in interface OMDocument

setComplete

public void setComplete(boolean state)

Method setComplete.

Specified by:

setComplete in interface OMContainerEx

Specified by:

setComplete in class OMSerializableImpl

Parameters:

state -

buildNext

public void buildNext()

Forces the parser to proceed, if parser has not yet finished with the XML input.

Specified by:

buildNext in interface OMContainer

addChild

public void addChild(OMNode child)

Adds child to the element. One can decide whether to append the child or to add to the front of the children list.

Specified by:

addChild in interface OMContainer

Parameters:

child -

getChildren

public java.util.Iterator getChildren()

Returns a collection of this element. Children can be of types OMElement, OMText.

Specified by:

getChildren in interface OMContainer

Returns:

Returns iterator.

getDescendants

public java.util.Iterator getDescendants(boolean includeSelf)

Specified by:

getDescendants in interface OMContainer

getChildrenWithName

public java.util.Iterator getChildrenWithName(javax.xml.namespace.QName elementQName)

Searches for children with a given QName and returns an iterator to traverse through the OMNodes. The QName can contain any combination of prefix, localname and URI.

Specified by:

getChildrenWithName in interface OMContainer

Parameters:

elementQName -

Returns:

Returns Iterator.

Throws:

OMException

getChildrenWithLocalName

public java.util.Iterator getChildrenWithLocalName(java.lang.String localName)

Specified by:

getChildrenWithLocalName in interface OMContainer

getChildrenWithNamespaceURI

public java.util.Iterator getChildrenWithNamespaceURI(java.lang.String uri)

Specified by:

getChildrenWithNamespaceURI in interface OMContainer

getFirstOMChild

public OMNode getFirstOMChild()

Method getFirstOMChild.

Specified by:

getFirstOMChild in interface OMContainer

Returns:

Returns first om child.

getFirstOMChildIfAvailable

public OMNode getFirstOMChildIfAvailable()

Specified by:

getFirstOMChildIfAvailable in interface OMContainerEx

getFirstChildWithName

public OMElement getFirstChildWithName(javax.xml.namespace.QName elementQName)
                                throws OMException

Method getFirstChildWithName.

Specified by:

getFirstChildWithName in interface OMContainer

Parameters:

elementQName -

Returns:

Returns OMElement.

Throws:

OMException

setFirstChild

public void setFirstChild(OMNode firstChild)

Method setFirstChild.

Specified by:

setFirstChild in interface OMContainerEx

Parameters:

firstChild -

setLastChild

public void setLastChild(OMNode omNode)

Forcefully set the last child

Specified by:

setLastChild in interface OMContainerEx

Parameters:

omNode -

getCharsetEncoding

public java.lang.String getCharsetEncoding()

Specified by:

getCharsetEncoding in interface OMDocument

setCharsetEncoding

public void setCharsetEncoding(java.lang.String charEncoding)

Specified by:

setCharsetEncoding in interface OMDocument

isStandalone

public java.lang.String isStandalone()

Specified by:

isStandalone in interface OMDocument

setStandalone

public void setStandalone(java.lang.String isStandalone)

Specified by:

setStandalone in interface OMDocument

getXMLVersion

public java.lang.String getXMLVersion()

Specified by:

getXMLVersion in interface OMDocument

setXMLVersion

public void setXMLVersion(java.lang.String xmlVersion)

Specified by:

setXMLVersion in interface OMDocument

getXMLEncoding

public java.lang.String getXMLEncoding()

Specified by:

getXMLEncoding in interface OMDocument

setXMLEncoding

public void setXMLEncoding(java.lang.String encoding)

Specified by:

setXMLEncoding in interface OMDocument

internalSerialize

public void internalSerialize(javax.xml.stream.XMLStreamWriter writer,
                              boolean cache)
                       throws javax.xml.stream.XMLStreamException

Description copied from class: OMSerializableImpl

Serializes the node.

Specified by:

internalSerialize in class OMSerializableImpl

Throws:

javax.xml.stream.XMLStreamException

internalSerialize

protected void internalSerialize(javax.xml.stream.XMLStreamWriter writer,
                                 boolean cache,
                                 boolean includeXMLDeclaration)
                          throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

internalSerializeAndConsume

public void internalSerializeAndConsume(javax.xml.stream.XMLStreamWriter writer)
                                 throws javax.xml.stream.XMLStreamException

Serializes the document with the XML declaration.

Throws:

javax.xml.stream.XMLStreamException

internalSerialize

public void internalSerialize(javax.xml.stream.XMLStreamWriter writer)
                       throws javax.xml.stream.XMLStreamException

Serializes the document with cache.

Throws:

javax.xml.stream.XMLStreamException

getXMLStreamReader

public javax.xml.stream.XMLStreamReader getXMLStreamReader()

Specified by:

getXMLStreamReader in interface OMContainer

getXMLStreamReaderWithoutCaching

public javax.xml.stream.XMLStreamReader getXMLStreamReaderWithoutCaching()

Specified by:

getXMLStreamReaderWithoutCaching in interface OMContainer

getXMLStreamReader

public javax.xml.stream.XMLStreamReader getXMLStreamReader(boolean cache)

Specified by:

getXMLStreamReader in interface OMContainer

getXMLStreamReader

public javax.xml.stream.XMLStreamReader getXMLStreamReader(boolean cache,
                                                           OMXMLStreamReaderConfiguration configuration)

Specified by:

getXMLStreamReader in interface OMContainer

getSAXSource

public javax.xml.transform.sax.SAXSource getSAXSource(boolean cache)

Specified by:

getSAXSource in interface OMContainer