org.apache.axiom.om.impl.dom

Class NodeImpl

java.lang.Object

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

All Implemented Interfaces:

Node

Direct Known Subclasses:

LeafNode, ParentNode

public abstract class NodeImpl
extends Object
implements 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

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
void	buildWithAttachments() Parses this node and builds the object structure in memory.
OMInformationItem	clone(OMCloneOptions options)
Node	cloneNode(boolean deep)
void	close(boolean build)
short	compareDocumentPosition(Node other)
OMNode	detach()
NamedNodeMap	getAttributes() Returns the collection of attributes associated with this node, or null if none.
String	getBaseURI()
abstract OMXMLParserWrapper	getBuilder()
Object	getFeature(String feature, String version)
Node	getFirstChild() Gets the first child of this Node, or null if none.
Node	getLastChild() Gets the last child of this Node, or null if none.
String	getLocalName()
String	getNamespaceURI()
OMNode	getNextOMSiblingIfAvailable()
String	getNodeValue()
OMFactory	getOMFactory() Returns the OMFactory that created this node
Document	getOwnerDocument()
OMContainer	getParent()
Node	getParentNode()
String	getPrefix()
OMNode	getPreviousOMSibling()
Node	getPreviousSibling()
String	getTextContent()
Object	getUserData(String key)
boolean	hasAttributes()
boolean	hasChildNodes()
void	insertSiblingAfter(OMNode sibling) Inserts the given sibling next to this item.
void	insertSiblingBefore(OMNode sibling) Inserts the given sibling before this item.
void	internalSerialize(XMLStreamWriter writer)
abstract void	internalSerialize(XMLStreamWriter writer, boolean cache)
void	internalSerializeAndConsume(XMLStreamWriter writer)
abstract boolean	isComplete()
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node node) Tests whether two nodes are equal.
boolean	isSameNode(Node node)
boolean	isSupported(String feature, String version)
String	lookupPrefix(String namespaceURI)
void	normalize()
void	serialize(OutputStream output)
void	serialize(OutputStream output, OMOutputFormat format)
void	serialize(Writer writer)
void	serialize(Writer writer2, OMOutputFormat format)
void	serialize(XMLStreamWriter xmlWriter)
void	serialize(XMLStreamWriter xmlWriter, boolean cache)
void	serializeAndConsume(OutputStream output)
void	serializeAndConsume(OutputStream output, OMOutputFormat format)
void	serializeAndConsume(Writer writer)
void	serializeAndConsume(Writer writer2, OMOutputFormat format)
void	serializeAndConsume(XMLStreamWriter xmlWriter)
abstract void	setComplete(boolean state)
void	setNextOMSibling(OMNode node)
void	setNodeValue(String nodeValue)
void	setParent(OMContainer element)
protected void	setParent(ParentNode parent, boolean useDomSemantics)
void	setPrefix(String prefix)
void	setPreviousOMSibling(OMNode node)
void	setTextContent(String textContent)
Object	setUserData(String key, Object value, 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

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

public void normalize()

Specified by:

normalize in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface Node

getNamespaceURI

public String getNamespaceURI()

Specified by:

getNamespaceURI in interface Node

getNodeValue

public String getNodeValue()
                    throws DOMException

Specified by:

getNodeValue in interface Node

Throws:

DOMException

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface Node

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException

Specified by:

setNodeValue in interface Node

Throws:

DOMException

setPrefix

public void setPrefix(String prefix)
               throws DOMException

Specified by:

setPrefix in interface Node

Throws:

DOMException

getAttributes

public 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 Node

See Also:

ElementImpl

getFirstChild

public 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 Node

See Also:

ParentNode

getLastChild

public 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 Node

See Also:

ParentNode

cloneNode

public final Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

isSupported

public boolean isSupported(String feature,
                           String version)

Specified by:

isSupported in interface Node

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

isSameNode

public boolean isSameNode(Node node)

Specified by:

isSameNode in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

isEqualNode

public boolean isEqualNode(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 Node

Parameters:

node - The node to compare equality with.

Returns:

Returns true if the nodes are equal, false otherwise.

Since:

DOM Level 3

getFeature

public Object getFeature(String feature,
                         String version)

Specified by:

getFeature in interface Node

setUserData

public Object setUserData(String key,
                          Object value,
                          UserDataHandler userDataHandler)

Specified by:

setUserData in interface Node

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node

getOMFactory

public OMFactory getOMFactory()

Returns the OMFactory that created this node

getOwnerDocument

public Document getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

getNextOMSiblingIfAvailable

public final OMNode getNextOMSiblingIfAvailable()

getPreviousOMSibling

public final OMNode getPreviousOMSibling()

getPreviousSibling

public final Node getPreviousSibling()

Specified by:

getPreviousSibling in interface 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 Node getParentNode()

Specified by:

getParentNode in interface Node

setParent

public final void setParent(OMContainer element)

setParent

protected void setParent(ParentNode parent,
                         boolean useDomSemantics)

detach

public OMNode detach()
              throws OMException

Throws:

OMException

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()

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(XMLStreamWriter xmlWriter)
               throws XMLStreamException

Throws:

XMLStreamException

serializeAndConsume

public void serializeAndConsume(XMLStreamWriter xmlWriter)
                         throws XMLStreamException

Throws:

XMLStreamException

serialize

public void serialize(XMLStreamWriter xmlWriter,
                      boolean cache)
               throws XMLStreamException

Throws:

XMLStreamException

serialize

public void serialize(OutputStream output)
               throws XMLStreamException

Throws:

XMLStreamException

serialize

public void serialize(Writer writer)
               throws XMLStreamException

Throws:

XMLStreamException

serializeAndConsume

public void serializeAndConsume(OutputStream output)
                         throws XMLStreamException

Throws:

XMLStreamException

serializeAndConsume

public void serializeAndConsume(Writer writer)
                         throws XMLStreamException

Throws:

XMLStreamException

serialize

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

Throws:

XMLStreamException

serialize

public void serialize(Writer writer2,
                      OMOutputFormat format)
               throws XMLStreamException

Throws:

XMLStreamException

serializeAndConsume

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

Throws:

XMLStreamException

serializeAndConsume

public void serializeAndConsume(Writer writer2,
                                OMOutputFormat format)
                         throws XMLStreamException

Throws:

XMLStreamException

internalSerialize

public void internalSerialize(XMLStreamWriter writer)
                       throws XMLStreamException

Throws:

XMLStreamException

internalSerializeAndConsume

public void internalSerializeAndConsume(XMLStreamWriter writer)
                                 throws XMLStreamException

Throws:

XMLStreamException

internalSerialize

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

Throws:

XMLStreamException

clone

public final OMInformationItem clone(OMCloneOptions options)