2005/5/9

     
 

class XMLDocument

artefaktur
Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

acdk::xml::dom::XMLDocument Class Reference

#include <XMLDocument.h>

Inheritance diagram for acdk::xml::dom::XMLDocument:

acdk::xml::dom::XMLNode org::w3c::dom::Document org::w3c::dom::DOMImplementation acdk::lang::Object org::w3c::dom::Node acdk::lang::ObjectBase acdk::lang::dmi::StdDispatch List of all members.

Detailed Description

API: acdk.xml.dom<br>.

Author:
Roger Rene Kommer
Version:
Revision
1.14
Date:
Date
2005/04/08 10:53:21


Public Member Functions

 XMLDocument ()
virtual RString toString ()
 return a string representation of this object Object::toString() return getName() by default

virtual RDocument getOwnerDocument ()
 The Document object associated with this node.

virtual::org::w3c::dom::RDocumentType getDoctype ()
 The Document Type Declaration (see DocumentType) associated with this document.

virtual RDOMImplementation getImplementation ()
virtual::org::w3c::dom::RElement getDocumentElement ()
 This is a convenience attribute that allows direct access to the child node that is the document element of the document.

void setDocumentRoot (IN(RXMLElement) el)
virtual org::w3c::dom::RElement createElement (IN(RString) s) throw ( org::w3c::dom::RDOMException )
virtual::org::w3c::dom::RDocumentFragment createDocumentFragment ()
virtual RText createTextNode (IN(RString) s)
virtual RComment createComment (IN(RString) s)
virtual RCDATASection createCDATASection (IN(RString) s) throw ( org::w3c::dom::RDOMException )
virtual RProcessingInstruction createProcessingInstruction (IN(RString) s, IN(RString) s1) throw ( org::w3c::dom::RDOMException )
virtual RAttr createAttribute (IN(RString) s) throw ( org::w3c::dom::RDOMException )
virtual REntityReference createEntityReference (IN(RString) s) throw ( org::w3c::dom::RDOMException )
virtual RNodeList getElementsByTagName (IN(RString) s)
virtual bool hasFeature (IN(RString) feature, IN(RString) version)
 Test if the DOM implementation implements a specific feature and version, as specified in .

virtual RDocument createDocument (IN(RString) namespaceURI, IN(RString) qualifiedName, IN(RDocumentType) doctype)
 Creates a DOM Document object of the specified type with its document element.

RString toXML ()
 dom4j like extension


Constructor & Destructor Documentation

acdk::xml::dom::XMLDocument::XMLDocument  )  [inline]
 


Member Function Documentation

virtual RAttr acdk::xml::dom::XMLDocument::createAttribute IN(RString s  )  throw ( org::w3c::dom::RDOMException ) [virtual]
 

Bug:
not supported

Implements org::w3c::dom::Document.

virtual RCDATASection acdk::xml::dom::XMLDocument::createCDATASection IN(RString s  )  throw ( org::w3c::dom::RDOMException ) [virtual]
 

Bug:
not supported

Implements org::w3c::dom::Document.

virtual RComment acdk::xml::dom::XMLDocument::createComment IN(RString s  )  [virtual]
 

Bug:
not supported

Implements org::w3c::dom::Document.

virtual RDocument acdk::xml::dom::XMLDocument::createDocument IN(RString namespaceURI,
IN(RString qualifiedName,
IN(RDocumentType doctype
[virtual]
 

Creates a DOM Document object of the specified type with its document element.


Note that based on the DocumentType given to create the document, the implementation may instantiate specialized Document objects that support additional features than the Core, such as HTML [DOM Level 2 HTML] . On the other hand, setting the DocumentType after the document was created makes this very unlikely to happen. Alternatively, specialized Document creation methods, such as createHTMLDocument [DOM Level 2 HTML] , can be used to obtain specific types of Document objects.

Parameters:
namespaceURI The namespace URI of the document element to create or null.
qualifiedName The qualified name of the document element to be created or null.
doctype The type of document to be created or null. When doctype is not null, its Node.ownerDocument attribute is set to the document being created.
Returns:
A new Document object with its document element. If the NamespaceURI, qualifiedName, and doctype are null, the returned Document is empty with no document element.
Exceptions:
DOMException INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to [XML 1.0].
NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName is null and the namespaceURI is different from null, or if the qualifiedName has a prefix that is xml and the namespaceURI is different from http://www.w3.org/XML/1998/namespace [XML Namespaces] , or if the DOM implementation does not support the XML feature but a non-null namespace URI was provided, since namespaces were defined by XML.
WRONG_DOCUMENT_ERR: Raised if doctype has already been used with a different document or was created from a different implementation.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature XML and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).
Since:
DOM Level 2

Implements org::w3c::dom::DOMImplementation.

virtual ::org::w3c::dom::RDocumentFragment acdk::xml::dom::XMLDocument::createDocumentFragment  )  [virtual]
 

Bug:
not supported

Implements org::w3c::dom::Document.

virtual org::w3c::dom::RElement acdk::xml::dom::XMLDocument::createElement IN(RString s  )  throw ( org::w3c::dom::RDOMException ) [virtual]
 

Bug:
not supported

Implements org::w3c::dom::Document.

virtual REntityReference acdk::xml::dom::XMLDocument::createEntityReference IN(RString s  )  throw ( org::w3c::dom::RDOMException ) [virtual]
 

Bug:
not supported

Implements org::w3c::dom::Document.

virtual RProcessingInstruction acdk::xml::dom::XMLDocument::createProcessingInstruction IN(RString s,
IN(RString s1
throw ( org::w3c::dom::RDOMException ) [virtual]
 

Bug:
not supported

Implements org::w3c::dom::Document.

virtual RText acdk::xml::dom::XMLDocument::createTextNode IN(RString s  )  [virtual]
 

Bug:
not supported

Implements org::w3c::dom::Document.

virtual ::org::w3c::dom::RDocumentType acdk::xml::dom::XMLDocument::getDoctype  )  [virtual]
 

The Document Type Declaration (see DocumentType) associated with this document.

For XML documents without a document type declaration this returns null. For HTML documents, a DocumentType object may be returned, independently of the presence or absence of document type declaration in the HTML document.
This provides direct access to the DocumentType node, child node of this Document. This node can be set at document creation time and later changed through the use of child nodes manipulation methods, such as Node.insertBefore, or Node.replaceChild. Note, however, that while some implementations may instantiate different types of Document objects supporting additional features than the Core, such as HTML [DOM Level 2 HTML] , based on the DocumentType specified at creation time, changing it afterwards is very unlikely to result in a change of the features supported.

Version:
DOM Level 3

Implements org::w3c::dom::Document.

virtual ::org::w3c::dom::RElement acdk::xml::dom::XMLDocument::getDocumentElement  )  [inline, virtual]
 

This is a convenience attribute that allows direct access to the child node that is the document element of the document.

Implements org::w3c::dom::Document.

virtual RNodeList acdk::xml::dom::XMLDocument::getElementsByTagName IN(RString s  )  [virtual]
 

Bug:
not supported

Implements org::w3c::dom::Document.

virtual RDOMImplementation acdk::xml::dom::XMLDocument::getImplementation  )  [virtual]
 

Bug:
not supported

Implements org::w3c::dom::Document.

virtual RDocument acdk::xml::dom::XMLDocument::getOwnerDocument  )  [inline, virtual]
 

The Document object associated with this node.

This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.

Version:
DOM Level 2

Reimplemented from acdk::xml::dom::XMLNode.

virtual bool acdk::xml::dom::XMLDocument::hasFeature IN(RString feature,
IN(RString version
[virtual]
 

Test if the DOM implementation implements a specific feature and version, as specified in .

Parameters:
feature The name of the feature to test.
version This is the version number of the feature to test.
Returns:
true if the feature is implemented in the specified version, false otherwise.

Implements org::w3c::dom::DOMImplementation.

void acdk::xml::dom::XMLDocument::setDocumentRoot IN(RXMLElement el  ) 
 

virtual RString acdk::xml::dom::XMLDocument::toString  )  [inline, virtual]
 

return a string representation of this object Object::toString() return getName() by default

Reimplemented from acdk::lang::Object.

RString acdk::xml::dom::XMLDocument::toXML  )  [inline, virtual]
 

dom4j like extension

Todo:
implement in derived interfaces

Reimplemented from acdk::xml::dom::XMLNode.