org.apache.axiom.om.impl.dom

Class NodeImpl

java.lang.Object

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

All Implemented Interfaces:

org.w3c.dom.Node

Direct Known Subclasses:

LeafNode, ParentNode

public abstract class NodeImpl
extends java.lang.Object
implements org.w3c.dom.Node

Field Summary

Fields

Modifier and Type	Field and Description
protected OMFactory	factory Factory that created this node
protected static short	FIRSTCHILD
protected short	flags
protected static short	HAS_PARENT Used by ChildNode to determine the meaning of the ownerNode attribute.
protected static short	SPECIFIED
private java.util.Hashtable	userData Holds the user data objects

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeImpl(OMFactory factory)

Method Summary

Modifier and Type	Method and Description
(package private) abstract void	build()
void	buildWithAttachments() Parses this node and builds the object structure in memory.
private boolean	checkNamedNodeMapEquality(org.w3c.dom.Node node)
(package private) void	checkSameOwnerDocument(org.w3c.dom.Node otherNode)
private boolean	checkStringAttributeEquality(org.w3c.dom.Node node)
OMInformationItem	clone(OMCloneOptions options)
(package private) abstract NodeImpl	clone(OMCloneOptions options, ParentNode targetParent, boolean deep, boolean namespaceRepairing)
org.w3c.dom.Node	cloneNode(boolean deep)
void	close(boolean build)
short	compareDocumentPosition(org.w3c.dom.Node other)
OMNode	detach()
(package private) OMNode	detach(boolean useDomSemantics)
org.w3c.dom.NamedNodeMap	getAttributes() Returns the collection of attributes associated with this node, or null if none.
java.lang.String	getBaseURI()
abstract OMXMLParserWrapper	getBuilder()
java.lang.Object	getFeature(java.lang.String feature, java.lang.String version)
org.w3c.dom.Node	getFirstChild() Gets the first child of this Node, or null if none.
org.w3c.dom.Node	getLastChild() Gets the last child of this Node, or null if none.
java.lang.String	getLocalName()
java.lang.String	getNamespaceURI()
OMNode	getNextOMSiblingIfAvailable()
java.lang.String	getNodeValue()
OMFactory	getOMFactory() Returns the OMFactory that created this node
org.w3c.dom.Document	getOwnerDocument()
OMContainer	getParent()
org.w3c.dom.Node	getParentNode()
java.lang.String	getPrefix()
OMNode	getPreviousOMSibling()
org.w3c.dom.Node	getPreviousSibling()
java.lang.String	getTextContent()
(package private) void	getTextContent(java.lang.StringBuffer buf)
java.lang.Object	getUserData(java.lang.String key)
boolean	hasAttributes()
boolean	hasChildNodes()
(package private) boolean	hasParent()
(package private) void	hasParent(boolean value)
void	insertSiblingAfter(OMNode sibling) Inserts the given sibling next to this item.
void	insertSiblingBefore(OMNode sibling) Inserts the given sibling before this item.
(package private) abstract NodeImpl	internalGetNextSibling()
(package private) abstract ParentNode	internalGetOwnerNode() Get the parent or the owner document of the node.
(package private) abstract NodeImpl	internalGetPreviousSibling()
void	internalSerialize(javax.xml.stream.XMLStreamWriter writer)
abstract void	internalSerialize(javax.xml.stream.XMLStreamWriter writer, boolean cache)
void	internalSerializeAndConsume(javax.xml.stream.XMLStreamWriter writer)
(package private) abstract void	internalSetNextSibling(NodeImpl nextSibling)
(package private) abstract void	internalSetOwnerNode(ParentNode ownerNode)
(package private) abstract void	internalSetPreviousSibling(NodeImpl previousSibling)
abstract boolean	isComplete()
boolean	isDefaultNamespace(java.lang.String namespaceURI)
boolean	isEqualNode(org.w3c.dom.Node node) Tests whether two nodes are equal.
(package private) boolean	isFirstChild()
(package private) void	isFirstChild(boolean value)
boolean	isSameNode(org.w3c.dom.Node node)
(package private) boolean	isSpecified()
(package private) void	isSpecified(boolean value)
boolean	isSupported(java.lang.String feature, java.lang.String version)
java.lang.String	lookupPrefix(java.lang.String namespaceURI)
void	normalize()
(package private) void	normalize(DOMConfigurationImpl config)
(package private) DocumentImpl	ownerDocument() Get the owner document of this node.
(package private) ParentNode	parentNode()
void	serialize(java.io.OutputStream output)
void	serialize(java.io.OutputStream output, OMOutputFormat format)
void	serialize(java.io.Writer writer)
void	serialize(java.io.Writer writer2, OMOutputFormat format)
void	serialize(javax.xml.stream.XMLStreamWriter xmlWriter)
void	serialize(javax.xml.stream.XMLStreamWriter xmlWriter, boolean cache)
void	serializeAndConsume(java.io.OutputStream output)
void	serializeAndConsume(java.io.OutputStream output, OMOutputFormat format)
void	serializeAndConsume(java.io.Writer writer)
void	serializeAndConsume(java.io.Writer writer2, OMOutputFormat format)
void	serializeAndConsume(javax.xml.stream.XMLStreamWriter xmlWriter)
abstract void	setComplete(boolean state)
void	setNextOMSibling(OMNode node)
void	setNodeValue(java.lang.String nodeValue)
(package private) void	setOwnerDocument(DocumentImpl document) Sets the owner document.
void	setParent(OMContainer element)
protected void	setParent(ParentNode parent, boolean useDomSemantics)
void	setPrefix(java.lang.String prefix)
void	setPreviousOMSibling(OMNode node)
void	setTextContent(java.lang.String textContent)
java.lang.Object	setUserData(java.lang.String key, java.lang.Object value, org.w3c.dom.UserDataHandler userDataHandler)

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, getChildNodes, getNextSibling, getNodeName, getNodeType, insertBefore, lookupNamespaceURI, removeChild, replaceChild

Field Detail

userData

private java.util.Hashtable userData

Holds the user data objects

factory

protected OMFactory factory

Factory that created this node

flags

protected short flags

HAS_PARENT

protected static final short HAS_PARENT

Used by ChildNode to determine the meaning of the ownerNode attribute. If the flag is set, then the attribute contains the reference to the parent node. If the flag is not set, then the node has no parent and the attribute stores a reference to the owner document (which may be null if the owner document has not been created yet).

See Also:

Constant Field Values

FIRSTCHILD

protected static final short FIRSTCHILD

See Also:

Constant Field Values

SPECIFIED

protected static final short SPECIFIED

See Also:

Constant Field Values

Constructor Detail

NodeImpl

protected NodeImpl(OMFactory factory)

Method Detail

normalize

void normalize(DOMConfigurationImpl config)

normalize

public void normalize()

Specified by:

normalize in interface org.w3c.dom.Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface org.w3c.dom.Node

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface org.w3c.dom.Node

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface org.w3c.dom.Node

getNamespaceURI

public java.lang.String getNamespaceURI()

Specified by:

getNamespaceURI in interface org.w3c.dom.Node

getNodeValue

public java.lang.String getNodeValue()
                              throws org.w3c.dom.DOMException

Specified by:

getNodeValue in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getPrefix

public java.lang.String getPrefix()

Specified by:

getPrefix in interface org.w3c.dom.Node

setNodeValue

public void setNodeValue(java.lang.String nodeValue)
                  throws org.w3c.dom.DOMException

Specified by:

setNodeValue in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

setPrefix

public void setPrefix(java.lang.String prefix)
               throws org.w3c.dom.DOMException

Specified by:

setPrefix in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

Returns the collection of attributes associated with this node, or null if none. At this writing, Element is the only type of node which will ever have attributes.

Specified by:

getAttributes in interface org.w3c.dom.Node

See Also:

ElementImpl

getFirstChild

public org.w3c.dom.Node getFirstChild()

Gets the first child of this Node, or null if none.

By default we do not have any children, ParentNode overrides this.

Specified by:

getFirstChild in interface org.w3c.dom.Node

See Also:

ParentNode

getLastChild

public org.w3c.dom.Node getLastChild()

Gets the last child of this Node, or null if none.

By default we do not have any children, ParentNode overrides this.

Specified by:

getLastChild in interface org.w3c.dom.Node

See Also:

ParentNode

cloneNode

public final org.w3c.dom.Node cloneNode(boolean deep)

Specified by:

cloneNode in interface org.w3c.dom.Node

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)

Specified by:

isSupported in interface org.w3c.dom.Node

hasParent

final boolean hasParent()

hasParent

final void hasParent(boolean value)

isFirstChild

final boolean isFirstChild()

isFirstChild

final void isFirstChild(boolean value)

isSpecified

final boolean isSpecified()

isSpecified

final void isSpecified(boolean value)

getBaseURI

public java.lang.String getBaseURI()

Specified by:

getBaseURI in interface org.w3c.dom.Node

compareDocumentPosition

public short compareDocumentPosition(org.w3c.dom.Node other)
                              throws org.w3c.dom.DOMException

Specified by:

compareDocumentPosition in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getTextContent

public java.lang.String getTextContent()
                                throws org.w3c.dom.DOMException

Specified by:

getTextContent in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getTextContent

void getTextContent(java.lang.StringBuffer buf)
             throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

setTextContent

public void setTextContent(java.lang.String textContent)
                    throws org.w3c.dom.DOMException

Specified by:

setTextContent in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

isSameNode

public boolean isSameNode(org.w3c.dom.Node node)

Specified by:

isSameNode in interface org.w3c.dom.Node

lookupPrefix

public java.lang.String lookupPrefix(java.lang.String namespaceURI)

Specified by:

lookupPrefix in interface org.w3c.dom.Node

isDefaultNamespace

public boolean isDefaultNamespace(java.lang.String namespaceURI)

Specified by:

isDefaultNamespace in interface org.w3c.dom.Node

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node node)

Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied:

• The two nodes are of the same type.
• The following string attributes are equal: nodeName, localName, namespaceURI, prefix, nodeValue . This is: they are both null, or they have the same length and are character for character identical.
• The attributes NamedNodeMaps are equal. This is: they are both null, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.
• The childNodes NodeLists are equal. This is: they are both null, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.

For two DocumentType nodes to be equal, the following conditions must also be satisfied:

• The following string attributes are equal: publicId, systemId, internalSubset.
• The entities NamedNodeMaps are equal.
• The notations NamedNodeMaps are equal.

On the other hand, the following do not affect equality: the ownerDocument, baseURI, and parentNode attributes, the specified attribute for Attr nodes, the schemaTypeInfo attribute for Attr and Element nodes, the Text.isElementContentWhitespace attribute for Text nodes, as well as any user data or event listeners registered on the nodes.

Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.

Specified by:

isEqualNode in interface org.w3c.dom.Node

Parameters:

node - The node to compare equality with.

Returns:

Returns true if the nodes are equal, false otherwise.

Since:

DOM Level 3

checkStringAttributeEquality

private boolean checkStringAttributeEquality(org.w3c.dom.Node node)

checkNamedNodeMapEquality

private boolean checkNamedNodeMapEquality(org.w3c.dom.Node node)

getFeature

public java.lang.Object getFeature(java.lang.String feature,
                                   java.lang.String version)

Specified by:

getFeature in interface org.w3c.dom.Node

setUserData

public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object value,
                                    org.w3c.dom.UserDataHandler userDataHandler)

Specified by:

setUserData in interface org.w3c.dom.Node

getUserData

public java.lang.Object getUserData(java.lang.String key)

Specified by:

getUserData in interface org.w3c.dom.Node

getOMFactory

public OMFactory getOMFactory()

Returns the OMFactory that created this node

internalGetOwnerNode

abstract ParentNode internalGetOwnerNode()

Get the parent or the owner document of the node. The meaning of the return value depends on the HAS_PARENT flag.

internalSetOwnerNode

abstract void internalSetOwnerNode(ParentNode ownerNode)

internalGetPreviousSibling

abstract NodeImpl internalGetPreviousSibling()

internalGetNextSibling

abstract NodeImpl internalGetNextSibling()

internalSetPreviousSibling

abstract void internalSetPreviousSibling(NodeImpl previousSibling)

internalSetNextSibling

abstract void internalSetNextSibling(NodeImpl nextSibling)

ownerDocument

final DocumentImpl ownerDocument()

Get the owner document of this node. In contrast to Node.getOwnerDocument(), this method returns a non null value when invoked on a Document instance.

Returns:

the owner document

checkSameOwnerDocument

void checkSameOwnerDocument(org.w3c.dom.Node otherNode)

setOwnerDocument

void setOwnerDocument(DocumentImpl document)

Sets the owner document.

Parameters:

document -

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

Specified by:

getOwnerDocument in interface org.w3c.dom.Node

parentNode

ParentNode parentNode()

getNextOMSiblingIfAvailable

public final OMNode getNextOMSiblingIfAvailable()

getPreviousOMSibling

public final OMNode getPreviousOMSibling()

getPreviousSibling

public final org.w3c.dom.Node getPreviousSibling()

Specified by:

getPreviousSibling in interface org.w3c.dom.Node

setNextOMSibling

public final void setNextOMSibling(OMNode node)

setPreviousOMSibling

public final void setPreviousOMSibling(OMNode node)

getParent

public final OMContainer getParent()
                            throws OMException

Throws:

OMException

getParentNode

public org.w3c.dom.Node getParentNode()

Specified by:

getParentNode in interface org.w3c.dom.Node

setParent

public final void setParent(OMContainer element)

setParent

protected void setParent(ParentNode parent,
                         boolean useDomSemantics)

detach

public OMNode detach()
              throws OMException

Throws:

OMException

detach

OMNode detach(boolean useDomSemantics)

insertSiblingAfter

public void insertSiblingAfter(OMNode sibling)
                        throws OMException

Inserts the given sibling next to this item.

Throws:

OMException

insertSiblingBefore

public void insertSiblingBefore(OMNode sibling)
                         throws OMException

Inserts the given sibling before this item.

Throws:

OMException

getBuilder

public abstract OMXMLParserWrapper getBuilder()

setComplete

public abstract void setComplete(boolean state)

isComplete

public abstract boolean isComplete()

build

abstract void build()

buildWithAttachments

public void buildWithAttachments()

Parses this node and builds the object structure in memory. AXIOM supports two levels of deffered building. First is deffered building of AXIOM using StAX. Second level is the deffered building of attachments. AXIOM reads in the attachements from the stream only when user asks by calling getDataHandler(). build() method builds the OM without the attachments. buildAll() builds the OM together with attachement data. This becomes handy when user wants to free the input stream.

close

public void close(boolean build)

serialize

public void serialize(javax.xml.stream.XMLStreamWriter xmlWriter)
               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

public void serializeAndConsume(javax.xml.stream.XMLStreamWriter xmlWriter)
                         throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serialize

public void serialize(javax.xml.stream.XMLStreamWriter xmlWriter,
                      boolean cache)
               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serialize

public void serialize(java.io.OutputStream output)
               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serialize

public void serialize(java.io.Writer writer)
               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

public void serializeAndConsume(java.io.OutputStream output)
                         throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

public void serializeAndConsume(java.io.Writer writer)
                         throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serialize

public void serialize(java.io.OutputStream output,
                      OMOutputFormat format)
               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serialize

public void serialize(java.io.Writer writer2,
                      OMOutputFormat format)
               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

public void serializeAndConsume(java.io.OutputStream output,
                                OMOutputFormat format)
                         throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

public void serializeAndConsume(java.io.Writer writer2,
                                OMOutputFormat format)
                         throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

internalSerialize

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

Throws:

javax.xml.stream.XMLStreamException

internalSerializeAndConsume

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

Throws:

javax.xml.stream.XMLStreamException

internalSerialize

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

Throws:

javax.xml.stream.XMLStreamException

clone

public final OMInformationItem clone(OMCloneOptions options)

clone

abstract NodeImpl clone(OMCloneOptions options,
                        ParentNode targetParent,
                        boolean deep,
                        boolean namespaceRepairing)