Home » axiom-1.2.8-src » org.apache.axiom.om » [javadoc | source]
org.apache.axiom.om
public interface: OMNode [javadoc | source]

All Known Implementing Classes:
    SOAP11FaultReasonImpl, SOAPElement, OMElementImpl, OMSourcedElementImpl, OMProcessingInstructionImpl, SOAPFaultValue, ProcessingInstructionImpl, SOAPFaultNodeImpl, SOAPFaultReason, SOAPFaultImpl, SOAPFaultReasonImpl, SOAP11FaultSubCodeImpl, SOAP12FaultReasonImpl, OMDocTypeImpl, SOAPFault, SOAP12FaultTextImpl, SOAP11HeaderBlockImpl, SOAP12FaultCodeImpl, SOAPFaultNode, SOAPHeader, SOAP11FaultImpl, SOAPFaultRoleImpl, SOAP12FaultValueImpl, SOAPFaultText, SOAPFaultDetailImpl, SOAP12FaultNodeImpl, SOAPFaultNodeImpl, CommentImpl, SOAP11FaultReasonImpl, SOAP11FaultCodeImpl, SOAPBody, OMNodeImpl, SOAPFaultTextImpl, SOAPFaultRoleImpl, SOAPFaultSubCodeImpl, SOAPBodyImpl, SOAP11HeaderImpl, SOAPElement, SOAP12FaultDetailImpl, SOAP12FaultCodeImpl, SOAP12FaultNodeImpl, SOAP12FaultDetailImpl, SOAPFaultImpl, SOAP12HeaderBlockImpl, TextImpl, SOAP12FaultTextImpl, SOAPFaultCodeImpl, SOAP11FaultRoleImpl, OMSourcedElement, SOAP11FaultTextImpl, SOAP12HeaderImpl, SOAP12FaultSubCodeImpl, SOAP12FaultSubCodeImpl, SOAPEnvelopeImpl, SOAPHeaderBlockImpl, SOAP11FaultDetailImpl, SOAPFaultSubCode, SOAPHeaderImpl, SOAPHeaderImpl, SOAPTextImpl, SOAPFaultReasonImpl, SOAPEnvelopeImpl, SOAPFaultRole, SOAP12BodyImpl, OMNodeEx, SOAPFaultValueImpl, SOAPEnvelope, SOAP11FaultTextImpl, SOAPFaultSubCodeImpl, SOAP11FaultValueImpl, SOAP12FaultValueImpl, SOAPHeaderBlockImpl, SOAP11FaultValueImpl, SOAP12FaultReasonImpl, SOAP11BodyImpl, OMCommentImpl, SOAP12HeaderBlockImpl, OMProcessingInstruction, ElementImpl, SOAPFaultDetail, SOAP11FaultSubCodeImpl, SOAP11BodyImpl, SOAP12BodyImpl, OMComment, SOAP11HeaderImpl, SOAP11HeaderBlockImpl, SOAPFaultTextImpl, OMDocType, SOAP12FaultImpl, OMText, SOAPFaultCodeImpl, SOAPHeaderBlock, SOAP12FaultImpl, SOAP11FaultCodeImpl, SOAPFaultDetailImpl, SOAP11FaultImpl, SOAPFaultValueImpl, OMTextImpl, SOAPTextImpl, SOAP11FaultDetailImpl, SOAP12HeaderImpl, SOAP12FaultRoleImpl, OMElement, SOAP12FaultRoleImpl, SOAP11FaultRoleImpl, SOAPBodyImpl, SOAPFaultCode

Defines the base interface used by most of the XML object model within Axis.

This tree model for XML captures the idea of deferring the construction of child nodes until they are needed. The isComplete function identifies whether or not a particular node has been fully parsed. A node may not be fully parsed, for example, if all of the children of an element have not yet been parsed.

In comparison to DOM, in this model, you will not find document fragments, or entities. In addition, while OMDocument and OMAttribute exist, neither is an extension of OMNode.

Field Summary
static final  short ELEMENT_NODE    The node is an Element. 
static final  short TEXT_NODE    The node is a Text node. 
static final  short CDATA_SECTION_NODE    The node is a CDATASection. 
static final  short COMMENT_NODE    The node is a Comment. 
static final  short DTD_NODE    This node is a DTD. 
static final  short PI_NODE    This node is a ProcessingInstruction. 
static final  short ENTITY_REFERENCE_NODE    This node is an Entity Reference. 
static final  short SPACE_NODE    This node is an Entity Reference. 
Method from org.apache.axiom.om.OMNode Summary:
build,   buildWithAttachments,   close,   detach,   discard,   getNextOMSibling,   getOMFactory,   getParent,   getPreviousOMSibling,   getType,   insertSiblingAfter,   insertSiblingBefore,   isComplete,   serialize,   serialize,   serialize,   serialize,   serialize,   serializeAndConsume,   serializeAndConsume,   serializeAndConsume,   serializeAndConsume,   serializeAndConsume
Method from org.apache.axiom.om.OMNode Detail:
 public  void build()
    Builds itself.
 public  void buildWithAttachments()
    Builds itself with the OMText binary content. 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.
 public  void close(boolean build)
    If a builder and parser is associated with the node, it is closed.
 public OMNode detach() throws OMException
    Removes a node (and all of its children) from its containing parent.

    Removes a node from its parent. Partially complete nodes will be completed before they are detached from the model. A node cannot be detached until its next sibling has been identified, so that the next sibling and parent can be updated appropriately. Please note that this will not handle the namespaces. For example, if there you have used a namespace within the detaching node and which is defined outside the detaching node, user has to handle it manually.

 public  void discard() throws OMException
    Discards a node.

    Discard goes to the parser level and if the element is not completely built, then it will be completely skipped at the parser level.

 public OMNode getNextOMSibling() throws OMException
    Returns the next sibling in document order.
 public OMFactory getOMFactory()
    Returns the OMFactory that created this object
 public OMContainer getParent()
    Returns the parent containing node.

    Returns the parent container, which may be either an OMDocument or OMElement .

 public OMNode getPreviousOMSibling()
    Gets the previous sibling.
 public int getType()
    Returns the type of node.
 public  void insertSiblingAfter(OMNode sibling) throws OMException
    Inserts a new sibling after the current node.
 public  void insertSiblingBefore(OMNode sibling) throws OMException
    Inserts a sibling just before the current node.
 public boolean isComplete()
    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.
 public  void serialize(XMLStreamWriter xmlWriter) throws XMLStreamException
    Serializes the node with caching.
 public  void serialize(OutputStream output) throws XMLStreamException
    Serializes the node with caching.
 public  void serialize(Writer writer) throws XMLStreamException
    Serializes the node with caching.
 public  void serialize(OutputStream output,
    OMOutputFormat format) throws XMLStreamException
    Serializes the node with caching.
 public  void serialize(Writer writer,
    OMOutputFormat format) throws XMLStreamException
    Serializes the node with caching.
 public  void serializeAndConsume(XMLStreamWriter xmlWriter) throws XMLStreamException
    Serializes the node without caching.
 public  void serializeAndConsume(OutputStream output) throws XMLStreamException
    Serializes the node without caching.
 public  void serializeAndConsume(Writer writer) throws XMLStreamException
    Serializes the node without caching.
 public  void serializeAndConsume(OutputStream output,
    OMOutputFormat format) throws XMLStreamException
    Serializes the node without caching.
 public  void serializeAndConsume(Writer writer,
    OMOutputFormat format) throws XMLStreamException
    Serializes the node without caching.