|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 short |
CDATA_SECTION_NODE
The node is a CDATASection . |
static short |
COMMENT_NODE
The node is a Comment . |
static short |
DTD_NODE
This node is a DTD . |
static short |
ELEMENT_NODE
The node is an Element . |
static short |
ENTITY_REFERENCE_NODE
This node is an Entity Reference . |
static short |
PI_NODE
This node is a ProcessingInstruction . |
static short |
SPACE_NODE
This node is an Entity Reference . |
static short |
TEXT_NODE
The node is a Text node. |
Method Summary | |
void |
build()
Builds itself. |
OMNode |
detach()
Removes a node (and all of its children) from its containing parent. |
void |
discard()
Discards a node. |
OMNode |
getNextOMSibling()
Returns the next sibling in document order. |
OMFactory |
getOMFactory()
Returns the OMFactory that created this object |
OMContainer |
getParent()
Returns the parent containing node. |
OMNode |
getPreviousOMSibling()
Gets the previous sibling. |
int |
getType()
Returns the type of node. |
void |
insertSiblingAfter(OMNode sibling)
Inserts a new sibling after the current node. |
void |
insertSiblingBefore(OMNode sibling)
Inserts a sibling just before the current node. |
boolean |
isComplete()
Indicates whether parser has parsed this information item completely or not. |
void |
serialize(java.io.OutputStream output)
Serializes the node with caching. |
void |
serialize(java.io.OutputStream output,
OMOutputFormat format)
Serializes the node with caching. |
void |
serialize(java.io.Writer writer)
Serializes the node with caching. |
void |
serialize(java.io.Writer writer,
OMOutputFormat format)
Serializes the node with caching. |
void |
serialize(javax.xml.stream.XMLStreamWriter xmlWriter)
Serializes the node with caching. |
void |
serializeAndConsume(java.io.OutputStream output)
Serializes the node without caching. |
void |
serializeAndConsume(java.io.OutputStream output,
OMOutputFormat format)
Serializes the node without caching. |
void |
serializeAndConsume(java.io.Writer writer)
Serializes the node without caching. |
void |
serializeAndConsume(java.io.Writer writer,
OMOutputFormat format)
Serializes the node without caching. |
void |
serializeAndConsume(javax.xml.stream.XMLStreamWriter xmlWriter)
Serializes the node without caching. |
Field Detail |
public static final short ELEMENT_NODE
Element
.
getType()
,
Constant Field Valuespublic static final short TEXT_NODE
Text
node.
getType()
,
Constant Field Valuespublic static final short CDATA_SECTION_NODE
CDATASection
.
getType()
,
Constant Field Valuespublic static final short COMMENT_NODE
Comment
.
getType()
,
Constant Field Valuespublic static final short DTD_NODE
DTD
.
getType()
,
Constant Field Valuespublic static final short PI_NODE
ProcessingInstruction
.
getType()
,
Constant Field Valuespublic static final short ENTITY_REFERENCE_NODE
Entity Reference
.
getType()
,
Constant Field Valuespublic static final short SPACE_NODE
Entity Reference
.
getType()
,
Constant Field ValuesMethod Detail |
public OMContainer getParent()
Returns the parent container, which may be either an OMDocument
or OMElement
.
OMContainer
of the node.public OMNode getNextOMSibling() throws OMException
OMException
public boolean isComplete()
public OMNode detach() throws OMException
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.
OMException
- If a node is not complete, the detach can trigger further
parsing, which may cause an exception.public void discard() throws OMException
Discard goes to the parser level and if the element is not completely built, then it will be completely skipped at the parser level.
OMException
public void insertSiblingAfter(OMNode sibling) throws OMException
sibling
- The node that will be added after the current node.
OMException
public void insertSiblingBefore(OMNode sibling) throws OMException
sibling
- The node that will be added before the current node.
OMException
public int getType()
ELEMENT_NODE
, TEXT_NODE
, CDATA_SECTION_NODE
, COMMENT_NODE
,
DTD_NODE
, PI_NODE
, ENTITY_REFERENCE_NODE
, SPACE_NODE
,
or TEXT_NODE
.public OMNode getPreviousOMSibling()
public void serialize(javax.xml.stream.XMLStreamWriter xmlWriter) throws javax.xml.stream.XMLStreamException
xmlWriter
-
javax.xml.stream.XMLStreamException
public void serialize(java.io.OutputStream output) throws javax.xml.stream.XMLStreamException
output
-
javax.xml.stream.XMLStreamException
public void serialize(java.io.Writer writer) throws javax.xml.stream.XMLStreamException
writer
-
javax.xml.stream.XMLStreamException
public void serialize(java.io.OutputStream output, OMOutputFormat format) throws javax.xml.stream.XMLStreamException
output
- format
-
javax.xml.stream.XMLStreamException
public void serialize(java.io.Writer writer, OMOutputFormat format) throws javax.xml.stream.XMLStreamException
writer
- format
-
javax.xml.stream.XMLStreamException
public void serializeAndConsume(javax.xml.stream.XMLStreamWriter xmlWriter) throws javax.xml.stream.XMLStreamException
xmlWriter
-
javax.xml.stream.XMLStreamException
public void serializeAndConsume(java.io.OutputStream output) throws javax.xml.stream.XMLStreamException
output
-
javax.xml.stream.XMLStreamException
public void serializeAndConsume(java.io.Writer writer) throws javax.xml.stream.XMLStreamException
writer
-
javax.xml.stream.XMLStreamException
public void serializeAndConsume(java.io.OutputStream output, OMOutputFormat format) throws javax.xml.stream.XMLStreamException
output
- format
-
javax.xml.stream.XMLStreamException
public void serializeAndConsume(java.io.Writer writer, OMOutputFormat format) throws javax.xml.stream.XMLStreamException
writer
- format
-
javax.xml.stream.XMLStreamException
public void build()
public OMFactory getOMFactory()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |