org.apache.axiom.om.impl.dom
Class ChildNode

java.lang.Object
  org.apache.axiom.om.impl.dom.NodeImpl
      org.apache.axiom.om.impl.dom.ChildNode

All Implemented Interfaces:

java.lang.Cloneable, org.w3c.dom.Node, org.w3c.dom.NodeList

Direct Known Subclasses:

CharacterImpl, DocumentTypeImpl, ParentNode, ProcessingInstructionImpl

public abstract class ChildNode
extends NodeImpl

Field Summary

protected ChildNode	nextSibling
protected ChildNode	previousSibling

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

builder, done, 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

Constructor Summary

protected	ChildNode(DocumentImpl ownerDocument, OMFactory factory)
protected	ChildNode(OMFactory factory)

Method Summary

void	build() Builds next element.
void	buildWithAttachments() Parses this node and builds the object structure in memory.
org.w3c.dom.Node	cloneNode(boolean deep)
void	close(boolean build)
OMNode	detach()
void	discard()
OMNode	getNextOMSibling()
OMNode	getNextOMSiblingIfAvailable()
org.w3c.dom.Node	getNextSibling() Returns the next child of this node's parent, or null if none.
org.w3c.dom.Document	getOwnerDocument()
OMContainer	getParent()
org.w3c.dom.Node	getParentNode()
OMNode	getPreviousOMSibling()
org.w3c.dom.Node	getPreviousSibling() Returns the previous child of this node's parent, or null if none.
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(javax.xml.stream.XMLStreamWriter writer)
abstract void	internalSerialize(javax.xml.stream.XMLStreamWriter writer, boolean cache)
void	internalSerializeAndConsume(javax.xml.stream.XMLStreamWriter writer)
boolean	isComplete()
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)
void	setComplete(boolean state)
void	setNextOMSibling(OMNode node)
void	setParent(OMContainer element)
void	setPreviousOMSibling(OMNode node)

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

appendChild, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getNodeValue, getOMFactory, getPrefix, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, 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

getNodeName, getNodeType

Field Detail

previousSibling

protected ChildNode previousSibling

nextSibling

protected ChildNode nextSibling

Constructor Detail

ChildNode

protected ChildNode(DocumentImpl ownerDocument,
                    OMFactory factory)

Parameters:

ownerDocument -

ChildNode

protected ChildNode(OMFactory factory)

Method Detail

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

getNextOMSibling

public OMNode getNextOMSibling()
                        throws OMException

Throws:

OMException

getNextOMSiblingIfAvailable

public OMNode getNextOMSiblingIfAvailable()

getNextSibling

public org.w3c.dom.Node getNextSibling()

Description copied from class: NodeImpl

Returns the next child of this node's parent, or null if none.

Specified by:

getNextSibling in interface org.w3c.dom.Node

Overrides:

getNextSibling in class NodeImpl

getPreviousOMSibling

public OMNode getPreviousOMSibling()

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()

Description copied from class: NodeImpl

Returns the previous child of this node's parent, or null if none.

Specified by:

getPreviousSibling in interface org.w3c.dom.Node

Overrides:

getPreviousSibling in class NodeImpl

setNextOMSibling

public void setNextOMSibling(OMNode node)

setPreviousOMSibling

public void setPreviousOMSibling(OMNode node)

getParent

public OMContainer getParent()
                      throws OMException

Throws:

OMException

getParentNode

public org.w3c.dom.Node getParentNode()

setParent

public void setParent(OMContainer element)

detach

public OMNode detach()
              throws OMException

Throws:

OMException

discard

public void discard()
             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

cloneNode

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

Specified by:

cloneNode in interface org.w3c.dom.Node

Overrides:

cloneNode in class NodeImpl

setComplete

public void setComplete(boolean state)

isComplete

public boolean isComplete()

build

public void build()

Builds next element.

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