org.apache.axiom.om.impl.dom

Class DocumentImpl

java.lang.Object

org.apache.axiom.om.impl.dom.NodeImpl

org.apache.axiom.om.impl.dom.ParentNode

org.apache.axiom.om.impl.dom.RootNode

org.apache.axiom.om.impl.dom.DocumentImpl

All Implemented Interfaces:

IContainer, IParentNode, OMContainerEx, OMContainer, OMDocument, OMInformationItem, OMSerializable, Document, Node, NodeList

Direct Known Subclasses:

SOAPMessageImpl

public class DocumentImpl
extends RootNode
implements Document, OMDocument, IContainer

Field Summary

Fields

Modifier and Type	Field and Description
protected OMXMLParserWrapper	builder
protected Hashtable	identifiers
protected int	state

Fields inherited from class org.apache.axiom.om.impl.dom.ParentNode

firstChild, lastChild

Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl

factory, FIRSTCHILD, flags, HAS_PARENT, SPECIFIED

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

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

XML_10, XML_11

Fields inherited from interface org.apache.axiom.om.impl.common.IParentNode

COMPLETE, DISCARDED, INCOMPLETE

Constructor Summary

Constructors

Constructor and Description
DocumentImpl(OMFactory factory)
DocumentImpl(OMXMLParserWrapper parserWrapper, OMFactory factory)

Method Summary

Modifier and Type	Method and Description
protected void	addIdAttr(Attr attr)
Node	adoptNode(Node node)
void	build() Builds itself.
protected void	checkQName(String prefix, String local) Borrowed from the Xerces impl.
Attr	createAttribute(String name)
Attr	createAttributeNS(String namespaceURI, String qualifiedName)
CDATASection	createCDATASection(String data)
protected DocumentImpl	createClone(OMCloneOptions options)
Comment	createComment(String data)
DocumentFragment	createDocumentFragment()
Element	createElement(String tagName)
Element	createElementNS(String ns, String qualifiedName)
EntityReference	createEntityReference(String name)
ProcessingInstruction	createProcessingInstruction(String target, String data)
Text	createTextNode(String value)
void	discarded()
OMXMLParserWrapper	getBuilder() Returns the builder object.
String	getCharsetEncoding() Get the character set encoding scheme.
DocumentType	getDoctype()
Element	getDocumentElement() Returns the document element.
String	getDocumentURI()
DOMConfiguration	getDomConfig()
Element	getElementById(String elementId)
NodeList	getElementsByTagName(String tagname)
NodeList	getElementsByTagNameNS(String namespaceURI, String localName)
DOMImplementation	getImplementation()
String	getInputEncoding()
Node	getNextSibling()
String	getNodeName()
short	getNodeType()
OMElement	getOMDocumentElement() Get the document element.
Document	getOwnerDocument()
int	getState()
boolean	getStrictErrorChecking()
String	getTextContent()
String	getXmlEncoding()
String	getXMLEncoding() Get the charset encoding of this document as specified in the XML declaration.
boolean	getXmlStandalone()
String	getXmlVersion()
String	getXMLVersion() Returns the XML version.
Node	importNode(Node importedNode, boolean deep)
void	internalSerialize(XMLStreamWriter writer, boolean cache)
protected void	internalSerialize(XMLStreamWriter writer, boolean cache, boolean includeXMLDeclaration)
boolean	isComplete() Indicates whether parser has parsed this information item completely or not.
String	isStandalone() XML standalone value.
String	lookupNamespaceURI(String specifiedPrefix)
void	normalizeDocument()
void	removeChildren() Remove all children from this container.
protected void	removeIdAttr(Attr attr)
Node	renameNode(Node node, String namespaceURI, String qualifiedName)
void	serialize(OutputStream output, OMOutputFormat format) Serialize the node with caching enabled.
void	serializeAndConsume(OutputStream output, OMOutputFormat format) Serialize the node without caching.
void	setCharsetEncoding(String charsetEncoding) Sets the character set encoding scheme to be used.
void	setComplete(boolean complete)
void	setDocumentURI(String documentURI)
void	setOMDocumentElement(OMElement documentElement) Set the document element of the XML document.
void	setStandalone(String isStandalone)
void	setStrictErrorChecking(boolean strictErrorChecking)
void	setTextContent(String textContent)
void	setXMLEncoding(String encoding) Set the charset encoding for the XML declaration of this document.
void	setXmlStandalone(boolean standalone)
void	setXmlVersion(String version)
void	setXMLVersion(String version) Sets the XML version.

Methods inherited from class org.apache.axiom.om.impl.dom.ParentNode

addChild, addChild, appendChild, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChild, getFirstChildWithName, getFirstOMChild, getFirstOMChildIfAvailable, getLastChild, getLastKnownOMChild, getLength, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasChildNodes, insertBefore, item, removeChild, replaceChild, setFirstChild, setLastChild

Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl

buildWithAttachments, clone, cloneNode, close, compareDocumentPosition, detach, getAttributes, getBaseURI, getFeature, getLocalName, getNamespaceURI, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getParent, getParentNode, getPrefix, getPreviousOMSibling, getPreviousSibling, getUserData, hasAttributes, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setNextOMSibling, setNodeValue, setParent, setParent, setPrefix, setPreviousOMSibling, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNodeValue, getParentNode, getPrefix, getPreviousSibling, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setUserData

Methods inherited from interface org.apache.axiom.om.impl.common.IContainer

getLastKnownOMChild, setFirstChild, setLastChild

Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx

addChild

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

addChild, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume

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

close, serialize, serialize, serializeAndConsume

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

clone, getOMFactory

Methods inherited from interface org.apache.axiom.om.impl.common.IParentNode

getFirstOMChildIfAvailable

Field Detail

builder

protected OMXMLParserWrapper builder

state

protected int state

identifiers

protected Hashtable identifiers

Constructor Detail

DocumentImpl

public DocumentImpl(OMXMLParserWrapper parserWrapper,
                    OMFactory factory)

DocumentImpl

public DocumentImpl(OMFactory factory)

Method Detail

getOwnerDocument

public Document getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

Overrides:

getOwnerDocument in class NodeImpl

internalSerialize

public void internalSerialize(XMLStreamWriter writer,
                              boolean cache)
                       throws XMLStreamException

Specified by:

internalSerialize in class NodeImpl

Throws:

XMLStreamException

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface Node

createAttribute

public Attr createAttribute(String name)
                     throws DOMException

Specified by:

createAttribute in interface Document

Throws:

DOMException

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
                              String qualifiedName)
                       throws DOMException

Specified by:

createAttributeNS in interface Document

Throws:

DOMException

createCDATASection

public CDATASection createCDATASection(String data)
                                throws DOMException

Specified by:

createCDATASection in interface Document

Throws:

DOMException

createComment

public Comment createComment(String data)

Specified by:

createComment in interface Document

createDocumentFragment

public DocumentFragment createDocumentFragment()

Specified by:

createDocumentFragment in interface Document

createElement

public Element createElement(String tagName)
                      throws DOMException

Specified by:

createElement in interface Document

Throws:

DOMException

createElementNS

public Element createElementNS(String ns,
                               String qualifiedName)
                        throws DOMException

Specified by:

createElementNS in interface Document

Throws:

DOMException

createEntityReference

public EntityReference createEntityReference(String name)
                                      throws DOMException

Specified by:

createEntityReference in interface Document

Throws:

DOMException

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(String target,
                                                         String data)
                                                  throws DOMException

Specified by:

createProcessingInstruction in interface Document

Throws:

DOMException

createTextNode

public Text createTextNode(String value)

Specified by:

createTextNode in interface Document

getDoctype

public DocumentType getDoctype()

Specified by:

getDoctype in interface Document

getElementById

public Element getElementById(String elementId)

Specified by:

getElementById in interface Document

getElementsByTagName

public NodeList getElementsByTagName(String tagname)

Specified by:

getElementsByTagName in interface Document

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)

Specified by:

getElementsByTagNameNS in interface Document

getImplementation

public DOMImplementation getImplementation()

Specified by:

getImplementation in interface Document

importNode

public Node importNode(Node importedNode,
                       boolean deep)
                throws DOMException

Specified by:

importNode in interface Document

Throws:

DOMException

getCharsetEncoding

public String getCharsetEncoding()

Description copied from interface: OMDocument

Get the character set encoding scheme. This is the encoding that was used used for this document at the time of the parsing. This is null when it is not known, such as when the document was created in memory or from a character stream.

Specified by:

getCharsetEncoding in interface OMDocument

Returns:

the charset encoding for this document, or null if the encoding is not known

getXMLVersion

public String getXMLVersion()

Description copied from interface: OMDocument

Returns the XML version.

Specified by:

getXMLVersion in interface OMDocument

Returns:

Returns String.

isStandalone

public String isStandalone()

Description copied from interface: OMDocument

XML standalone value. This will be yes, no or null (if not available)

Specified by:

isStandalone in interface OMDocument

Returns:

Returns boolean.

setCharsetEncoding

public void setCharsetEncoding(String charsetEncoding)

Description copied from interface: OMDocument

Sets the character set encoding scheme to be used.

Specified by:

setCharsetEncoding in interface OMDocument

setOMDocumentElement

public void setOMDocumentElement(OMElement documentElement)

Description copied from interface: OMDocument

Set the document element of the XML document. If the document has no document element, then the new document element will be appended as the last child. If the document already has a document element, then it will be replaced by the new one and the position of the other children relative to the document element is preserved.

Specified by:

setOMDocumentElement in interface OMDocument

Parameters:

documentElement - the new document element; must not be null

setStandalone

public void setStandalone(String isStandalone)

Specified by:

setStandalone in interface OMDocument

serializeAndConsume

public void serializeAndConsume(OutputStream output,
                                OMOutputFormat format)
                         throws XMLStreamException

Description copied from interface: OMContainer

Serialize the node without caching.

The format of the output is controlled by the provided OMOutputFormat object. In particular, OMOutputFormat.setDoOptimize(boolean) can be used to instruct this method to produce an XOP/MTOM encoded MIME message.

Specified by:

serializeAndConsume in interface OMContainer

Overrides:

serializeAndConsume in class NodeImpl

Parameters:

output - the byte stream to write the serialized infoset to

format - the output format to use

Throws:

XMLStreamException

serialize

public void serialize(OutputStream output,
                      OMOutputFormat format)
               throws XMLStreamException

Description copied from interface: OMContainer

Serialize the node with caching enabled.

The format of the output is controlled by the provided OMOutputFormat object. In particular, OMOutputFormat.setDoOptimize(boolean) can be used to instruct this method to produce an XOP/MTOM encoded MIME message.

Specified by:

serialize in interface OMContainer

Overrides:

serialize in class NodeImpl

Parameters:

output - the byte stream to write the serialized infoset to

format - the output format to use

Throws:

XMLStreamException

setXMLVersion

public void setXMLVersion(String version)

Description copied from interface: OMDocument

Sets the XML version.

Specified by:

setXMLVersion in interface OMDocument

See Also:

OMDocument.XML_10, OMDocument.XML_11

getXMLEncoding

public String getXMLEncoding()

Description copied from interface: OMDocument

Get the charset encoding of this document as specified in the XML declaration.

Specified by:

getXMLEncoding in interface OMDocument

Returns:

the charset encoding specified in the XML declaration, or null if the document didn't have an XML declaration or if the encoding attribute was not specified in the XML declaration

setXMLEncoding

public void setXMLEncoding(String encoding)

Description copied from interface: OMDocument

Set the charset encoding for the XML declaration of this document.

Specified by:

setXMLEncoding in interface OMDocument

Parameters:

encoding - the value of the encoding attribute of the XML declaration

getOMDocumentElement

public OMElement getOMDocumentElement()

Description copied from interface: OMDocument

Get the document element.

Specified by:

getOMDocumentElement in interface OMDocument

Returns:

the document element, or null if the document doesn't have any children of type OMElement

getDocumentElement

public Element getDocumentElement()

Returns the document element.

Specified by:

getDocumentElement in interface Document

See Also:

Document.getDocumentElement()

checkQName

protected final void checkQName(String prefix,
                                String local)

Borrowed from the Xerces impl. Checks if the given qualified name is legal with respect to the version of XML to which this document must conform.

Parameters:

prefix - prefix of qualified name

local - local part of qualified name

addIdAttr

protected void addIdAttr(Attr attr)

removeIdAttr

protected void removeIdAttr(Attr attr)

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Overrides:

getTextContent in class ParentNode

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Overrides:

setTextContent in class ParentNode

Throws:

DOMException

adoptNode

public Node adoptNode(Node node)
               throws DOMException

Specified by:

adoptNode in interface Document

Throws:

DOMException

getDocumentURI

public String getDocumentURI()

Specified by:

getDocumentURI in interface Document

getDomConfig

public DOMConfiguration getDomConfig()

Specified by:

getDomConfig in interface Document

getInputEncoding

public String getInputEncoding()

Specified by:

getInputEncoding in interface Document

getStrictErrorChecking

public boolean getStrictErrorChecking()

Specified by:

getStrictErrorChecking in interface Document

getXmlEncoding

public String getXmlEncoding()

Specified by:

getXmlEncoding in interface Document

getXmlStandalone

public boolean getXmlStandalone()

Specified by:

getXmlStandalone in interface Document

getXmlVersion

public String getXmlVersion()

Specified by:

getXmlVersion in interface Document

normalizeDocument

public void normalizeDocument()

Specified by:

normalizeDocument in interface Document

renameNode

public Node renameNode(Node node,
                       String namespaceURI,
                       String qualifiedName)
                throws DOMException

Specified by:

renameNode in interface Document

Throws:

DOMException

setDocumentURI

public void setDocumentURI(String documentURI)

Specified by:

setDocumentURI in interface Document

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)

Specified by:

setStrictErrorChecking in interface Document

setXmlStandalone

public void setXmlStandalone(boolean standalone)
                      throws DOMException

Specified by:

setXmlStandalone in interface Document

Throws:

DOMException

setXmlVersion

public void setXmlVersion(String version)
                   throws DOMException

Specified by:

setXmlVersion in interface Document

Throws:

DOMException

internalSerialize

protected void internalSerialize(XMLStreamWriter writer,
                                 boolean cache,
                                 boolean includeXMLDeclaration)
                          throws XMLStreamException

Throws:

XMLStreamException

createClone

protected DocumentImpl createClone(OMCloneOptions options)

getBuilder

public final OMXMLParserWrapper getBuilder()

Description copied from interface: OMContainer

Returns the builder object.

Specified by:

getBuilder in interface IParentNode

Specified by:

getBuilder in interface OMContainer

Specified by:

getBuilder in class NodeImpl

Returns:

Returns the builder object used to construct the underlying XML infoset on the fly.

getState

public final int getState()

Specified by:

getState in interface IParentNode

isComplete

public final boolean isComplete()

Description copied from interface: OMSerializable

Indicates whether parser has parsed this information item completely or not. If some info are not available in the item, one has to check this attribute to make sure that, this item has been parsed completely or not.

Specified by:

isComplete in interface IParentNode

Specified by:

isComplete in interface OMSerializable

Specified by:

isComplete in class NodeImpl

Returns:

Returns boolean.

setComplete

public final void setComplete(boolean complete)

Specified by:

setComplete in interface OMContainerEx

Specified by:

setComplete in class NodeImpl

discarded

public final void discarded()

Specified by:

discarded in interface OMContainerEx

build

public final void build()

Description copied from interface: OMSerializable

Builds itself.

Specified by:

build in interface OMSerializable

getNextSibling

public final Node getNextSibling()

Specified by:

getNextSibling in interface Node

removeChildren

public final void removeChildren()

Description copied from interface: OMContainer

Remove all children from this container. This method has the same effect as the following code:

 for (Iterator it = container.getChildren(); it.hasNext(); ) {
     it.next();
     it.remove();
 }

However, the implementation may do this in an optimized way. In particular, if the node is incomplete, it may choose not to instantiate child node that would become unreachable anyway.

Specified by:

removeChildren in interface OMContainer

lookupNamespaceURI

public final String lookupNamespaceURI(String specifiedPrefix)

Specified by:

lookupNamespaceURI in interface Node