org.apache.axis2.om
Interface OMDocument

All Superinterfaces:
OMContainer
All Known Subinterfaces:
SOAPMessage
All Known Implementing Classes:
OMDocumentImpl, SOAPMessageImpl

public interface OMDocument
extends OMContainer


Field Summary
static java.lang.String XML_10
          Field XML_10 XML Version 1.0
static java.lang.String XML_11
          Field XML_11 XML Version 1.1
 
Method Summary
 java.lang.String getCharsetEncoding()
          Returns the caracter set encoding scheme
 OMElement getDocumentElement()
          Returns the document element
 java.lang.String getXMLVersion()
          Returns the XML version
 java.lang.String isStandalone()
          XML standalone value This will be yes, no or null (if not available)
 void serialize(OMOutputImpl omOutput)
          Serialize the OMDocument
 void serialize(OMOutputImpl omOutput, boolean includeXMLDeclaration)
          Serilize the OMDocument with the option of excluding/including the XML declaration
 void serializeWithCache(OMOutputImpl omOutput)
          Serializa the document with cache on
 void serializeWithCache(OMOutputImpl omOutput, boolean includeXMLDeclaration)
          Seralize the document with cache on with the option on excluding the XML declaration
 void setCharsetEncoding(java.lang.String charsetEncoding)
          Sets the character set encoding scheme to be used
 void setDocumentElement(OMElement rootElement)
          Sets the document element of the XML document
 void setStandalone(java.lang.String isStandalone)
           
 void setXMLVersion(java.lang.String version)
          Sets the XML version
 
Methods inherited from interface org.apache.axis2.om.OMContainer
addChild, buildNext, getChildren, getChildrenWithName, getFirstChild, getFirstChildWithName, isComplete
 

Field Detail

XML_10

public static final java.lang.String XML_10
Field XML_10 XML Version 1.0

See Also:
Constant Field Values

XML_11

public static final java.lang.String XML_11
Field XML_11 XML Version 1.1

See Also:
Constant Field Values
Method Detail

getDocumentElement

public OMElement getDocumentElement()
Returns the document element

Returns:

setDocumentElement

public void setDocumentElement(OMElement rootElement)
Sets the document element of the XML document

Parameters:
rootElement -

getXMLVersion

public java.lang.String getXMLVersion()
Returns the XML version

Returns:

setXMLVersion

public void setXMLVersion(java.lang.String version)
Sets the XML version

Parameters:
version -
See Also:
XML 1.0, XML 1.1

getCharsetEncoding

public java.lang.String getCharsetEncoding()
Returns the caracter set encoding scheme

Returns:

setCharsetEncoding

public void setCharsetEncoding(java.lang.String charsetEncoding)
Sets the character set encoding scheme to be used

Parameters:
charsetEncoding -

isStandalone

public java.lang.String isStandalone()
XML standalone value This will be yes, no or null (if not available)

Returns:

setStandalone

public void setStandalone(java.lang.String isStandalone)

serialize

public void serialize(OMOutputImpl omOutput)
               throws XMLStreamException
Serialize the OMDocument

Parameters:
omOutput -
Throws:
XMLStreamException

serialize

public void serialize(OMOutputImpl omOutput,
                      boolean includeXMLDeclaration)
               throws XMLStreamException
Serilize the OMDocument with the option of excluding/including the XML declaration

Parameters:
omOutput -
includeXMLDeclaration - Whether to include the XML declaration or not
Throws:
XMLStreamException

serializeWithCache

public void serializeWithCache(OMOutputImpl omOutput)
                        throws XMLStreamException
Serializa the document with cache on

Parameters:
omOutput -
Throws:
XMLStreamException

serializeWithCache

public void serializeWithCache(OMOutputImpl omOutput,
                               boolean includeXMLDeclaration)
                        throws XMLStreamException
Seralize the document with cache on with the option on excluding the XML declaration

Parameters:
omOutput -
includeXMLDeclaration -
Throws:
XMLStreamException