BOXMLDocument

This interface provides the mechanisms for creating and representing an XML document in memory.

Purpose

This interface allows you to build and to represent an XML document.

Example

This is an example of the BOXMLDocument interface.

public interface BOXMLDocument
{
   /**
    * Returns the root DataObject for the XML Document. 
    * This object is an instance of the root element's type or subtype.
    * 
    * @return root DataObject for the XMLDocument
    */
public DataObject
getDataObject();


   /**
    * Returns the targetnamespace for the root element and null
    * 		if there is no targetnamespace.
    * @return the targetnamespace URI for the root element.
    */
public String
getRootElementURI();


   /**
    * Returns the name of the root element.
    * 
    * @return name of the root element.
    */
public String
getRootElementName();


   /**
    * Returns the XML version of the document, or null if not specified.
    * 
    * @return XML version of the XML Document
    */
public String
getXMLVersion();


   /**
    * Set the XML version of the document, or null if not specified.
    * 
    * @param xmlVersion XML version of the XML Document
    */
public void
setXMLVersion(String xmlVersion);


   /**
    * Returns the XML encoding of the document, or null if not specified.
    * 		Default value is UTF-8.
    * @return Encoding of the XML Document
    */
public String
getEncoding();


   /**
    * Sets the XML encoding of the document, or null if not specified.
    * 
    * @param encoding encoding used in the XML Document
    */
public void
setEncoding(String encoding);

Parent topic: Programming interfaces

Related reference
BOChangeSummary
BOCopy
BODataObject
BOEquality
BOEventSummary
BOFactory
BOType
BOTypeMetadata
BOXMLSerializer

Related information
Interface BOXMLDocument APIs


Terms of use |

Last updated: Tue Sep 20 03:22:36 2005

Copyright IBM Corporation 2005.
This information center is powered by Eclipse technology (http://www.eclipse.org)