2005/5/9

acdk::xml::libxmldom::LibXMLDocument Class Reference

Inheritance diagram for acdk::xml::libxmldom::LibXMLDocument:

Constructor & Destructor Documentation

acdk::xml::libxmldom::LibXMLDocument::LibXMLDocument (  xmlNodePtr  np, FreeXmlNodePtrFuncPtr  freeIt = 0 )  [inline]

Member Function Documentation

org::w3c::dom::RNode acdk::xml::libxmldom::LibXMLDocument::_adoptNode (  IN(org::w3c::dom::RNode)  source  )  throw ( org::w3c::dom::RDOMException ) [protected]

org::w3c::dom::RNode acdk::xml::libxmldom::LibXMLDocument::adoptNode (  IN(org::w3c::dom::RNode)  source  )  throw ( org::w3c::dom::RDOMException )

bool acdk::xml::libxmldom::LibXMLDocument::canSetParameter (  IN(RString)  name, IN(acdk::lang::Object)  value )  [virtual]

Check if setting a parameter to a specific value is supported. Parameters: name  The name of the parameter to check. value  An object. if null, the returned value is true. Returns: true if the parameter could be successfully set to the specified value, or false if the parameter is not recognized or the requested value is not supported. This does not change the current value of the parameter itself. Implements org::w3c::dom::DOMConfiguration.

org::w3c::dom::RAttr acdk::xml::libxmldom::LibXMLDocument::createAttribute (  IN(RString)  name  )  throw ( org::w3c::dom::RDOMException ) [virtual]

Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttributeNode method. To create an attribute with a qualified name and namespace URI, use the createAttributeNS method. Parameters: name  The name of the attribute. Returns: A new Attr object with the nodeName attribute set to name, and localName, prefix, and namespaceURI set to null. The value of the attribute is the empty string. Exceptions: DOMException  INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute. Implements org::w3c::dom::Document.

org::w3c::dom::RAttr acdk::xml::libxmldom::LibXMLDocument::createAttributeNS (  IN(RString)  namespaceURI, IN(RString)  qualifiedName )  throw ( org::w3c::dom::RDOMException )

org::w3c::dom::RCDATASection acdk::xml::libxmldom::LibXMLDocument::createCDATASection (  IN(RString)  data  )  throw ( org::w3c::dom::RDOMException ) [virtual]

Creates a CDATASection node whose value is the specified string. Parameters: data  The data for the CDATASection contents. Returns: The new CDATASection object. Exceptions: DOMException  NOT_SUPPORTED_ERR: Raised if this document is an HTML document. Implements org::w3c::dom::Document.

org::w3c::dom::RComment acdk::xml::libxmldom::LibXMLDocument::createComment (  IN(RString)  data  )  [virtual]

Creates a Comment node given the specified string. Parameters: data  The data for the node. Returns: The new Comment object. Implements org::w3c::dom::Document.

org::w3c::dom::RDocumentFragment acdk::xml::libxmldom::LibXMLDocument::createDocumentFragment (   )  [virtual]

Creates an empty DocumentFragment object. Returns: A new DocumentFragment. Implements org::w3c::dom::Document.

org::w3c::dom::RElement acdk::xml::libxmldom::LibXMLDocument::createElement (  IN(RString)  tagName  )  throw ( org::w3c::dom::RDOMException ) [virtual]

Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object. In addition, if there are known attributes with default values, Attr nodes representing them are automatically created and attached to the element. To create an element with a qualified name and namespace URI, use the createElementNS method. Parameters: tagName  The name of the element type to instantiate. For XML, this is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use. In that case, the name is mapped to the canonical form of that markup by the DOM implementation. Returns: A new Element object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to null. Exceptions: DOMException  INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute. Implements org::w3c::dom::Document.

org::w3c::dom::RElement acdk::xml::libxmldom::LibXMLDocument::createElementNS (  IN(RString)  namespaceURI, IN(RString)  qualifiedName )  throw ( org::w3c::dom::RDOMException )

org::w3c::dom::REntityReference acdk::xml::libxmldom::LibXMLDocument::createEntityReference (  IN(RString)  name  )  throw ( org::w3c::dom::RDOMException ) [virtual]

Creates an EntityReference object. In addition, if the referenced entity is known, the child list of the EntityReference node is made the same as that of the corresponding Entity node. <p >Note: If any descendant of the Entity node has an unbound namespace prefix, the corresponding descendant of the created EntityReference node is also unbound; (its namespaceURI is null). The DOM Level 2 and 3 do not support any mechanism to resolve namespace prefixes in this case. Parameters: name  The name of the entity to reference.Unlike Document.createElementNS or Document.createAttributeNS, no namespace well-formed checking is done on the entity name. Applications should invoke Document.normalizeDocument() with the parameter namespaces set to true in order to ensure that the entity name is namespace well-formed. Returns: The new EntityReference object. Exceptions: DOMException  INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute. NOT_SUPPORTED_ERR: Raised if this document is an HTML document. Implements org::w3c::dom::Document.

org::w3c::dom::xpath::RXPathExpression acdk::xml::libxmldom::LibXMLDocument::createExpression (  IN(RString)  expression, IN(org::w3c::dom::xpath::RXPathNSResolver)  resolver )  throw ( org::w3c::dom::xpath::RXPathException , org::w3c::dom::RDOMException )

org::w3c::dom::traversal::RNodeIterator acdk::xml::libxmldom::LibXMLDocument::createNodeIterator (  IN(org::w3c::dom::RNode)  root, int  whatToShow, IN(org::w3c::dom::traversal::RNodeFilter)  filter, bool  entityReferenceExpansion )  throw ( org::w3c::dom::RDOMException )

org::w3c::dom::xpath::RXPathNSResolver acdk::xml::libxmldom::LibXMLDocument::createNSResolver (  IN(org::w3c::dom::RNode)  nodeResolver  )

org::w3c::dom::RProcessingInstruction acdk::xml::libxmldom::LibXMLDocument::createProcessingInstruction (  IN(RString)  target, IN(RString)  data )  throw ( org::w3c::dom::RDOMException ) [virtual]

Creates a ProcessingInstruction node given the specified name and data strings. Parameters: target  The target part of the processing instruction.Unlike Document.createElementNS or Document.createAttributeNS, no namespace well-formed checking is done on the target name. Applications should invoke Document.normalizeDocument() with the parameter namespaces set to true in order to ensure that the target name is namespace well-formed. data  The data for the node. Returns: The new ProcessingInstruction object. Exceptions: DOMException  INVALID_CHARACTER_ERR: Raised if the specified target is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute. NOT_SUPPORTED_ERR: Raised if this document is an HTML document. Implements org::w3c::dom::Document.

org::w3c::dom::RText acdk::xml::libxmldom::LibXMLDocument::createTextNode (  IN(RString)  data  )  [virtual]

Creates a Text node given the specified string. Parameters: data  The data for the node. Returns: The new Text object. Implements org::w3c::dom::Document.

org::w3c::dom::traversal::RTreeWalker acdk::xml::libxmldom::LibXMLDocument::createTreeWalker (  IN(org::w3c::dom::RNode)  root, int  whatToShow, IN(org::w3c::dom::traversal::RNodeFilter)  filter, bool  entityReferenceExpansion )  throw ( org::w3c::dom::RDOMException )

xmlOutputBufferPtr acdk::xml::libxmldom::LibXMLDocument::createWriterOutputBuffer (  IN(acdk::io::RWriter)  out  )  [static]

acdk::lang::Object acdk::xml::libxmldom::LibXMLDocument::evaluate (  IN(RString)  expression, IN(org::w3c::dom::RNode)  contextNode, IN(org::w3c::dom::xpath::RXPathNSResolver)  resolver, short  type, IN(acdk::lang::Object)  result )  throw ( org::w3c::dom::xpath::RXPathException , org::w3c::dom::RDOMException )

void acdk::xml::libxmldom::LibXMLDocument::finalize (   )  [virtual]

This is for java-compatibility. For real clean using Destructor is a better way. But different to destructors inside finalize() calls to virtual methods will still be dispatched to derived classes. Reimplemented from acdk::lang::Object.

org::w3c::dom::RDocumentType acdk::xml::libxmldom::LibXMLDocument::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.

org::w3c::dom::RElement acdk::xml::libxmldom::LibXMLDocument::getDocumentElement (   )  [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.

RString acdk::xml::libxmldom::LibXMLDocument::getDocumentURI (   )

org::w3c::dom::RDOMConfiguration acdk::xml::libxmldom::LibXMLDocument::getDomConfig (   )  [inline]

org::w3c::dom::RElement acdk::xml::libxmldom::LibXMLDocument::getElementById (  IN(RString)  elementId  )

org::w3c::dom::RNodeList acdk::xml::libxmldom::LibXMLDocument::getElementsByTagName (  IN(RString)  tagName  )  [virtual]

Returns a NodeList of all the Elements in document order with a given tag name and are contained in the document. Parameters: tagname  The name of the tag to match on. The special value * matches all tags. For XML, the tagname parameter is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use. Returns: A new NodeList object containing all the matched Elements. Implements org::w3c::dom::Document.

org::w3c::dom::RNodeList acdk::xml::libxmldom::LibXMLDocument::getElementsByTagNameNS (  IN(RString)  namespaceURI, IN(RString)  localName )

org::w3c::dom::RDOMImplementation acdk::xml::libxmldom::LibXMLDocument::getImplementation (   )  [inline, virtual]

The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations. Implements org::w3c::dom::Document.

RString acdk::xml::libxmldom::LibXMLDocument::getInputEncoding (   )

acdk::lang::Object acdk::xml::libxmldom::LibXMLDocument::getParameter (  IN(RString)  name  )  throw ( org::w3c::dom::RDOMException ) [virtual]

Return the value of a parameter if known. Parameters: name  The name of the parameter. Returns: The current object associated with the specified parameter or null if no object has been associated or if the parameter is not supported. Exceptions: DOMException  NOT_FOUND_ERR: Raised when the parameter name is not recognized. Implements org::w3c::dom::DOMConfiguration.

RStringArray acdk::xml::libxmldom::LibXMLDocument::getParameterNames (   )  [virtual]

The list of the parameters supported by this DOMConfiguration object and for which at least one value can be set by the application. Note that this list can also contain parameter names defined outside this specification. Implements org::w3c::dom::DOMConfiguration.

bool acdk::xml::libxmldom::LibXMLDocument::getStrictErrorChecking (   )

RString acdk::xml::libxmldom::LibXMLDocument::getXmlEncoding (   )

bool acdk::xml::libxmldom::LibXMLDocument::getXmlStandalone (   )

RString acdk::xml::libxmldom::LibXMLDocument::getXmlVersion (   )

org::w3c::dom::RNode acdk::xml::libxmldom::LibXMLDocument::importNode (  IN(org::w3c::dom::RNode)  importedNode, bool  deep )  throw ( org::w3c::dom::RDOMException )

void acdk::xml::libxmldom::LibXMLDocument::normalizeDocument (   )  [inline]

org::w3c::dom::RNode acdk::xml::libxmldom::LibXMLDocument::renameNode (  IN(org::w3c::dom::RNode)  n, IN(RString)  namespaceURI, IN(RString)  qualifiedName )

void acdk::xml::libxmldom::LibXMLDocument::setDocumentURI (  IN(RString)  documentURI  )

void acdk::xml::libxmldom::LibXMLDocument::setParameter (  IN(RString)  name, IN(acdk::lang::Object)  value )  throw ( org::w3c::dom::RDOMException ) [virtual]

Set the value of a parameter. Parameters: name  The name of the parameter to set. value  The new value or null if the user wishes to unset the parameter. While the type of the value parameter is defined as DOMUserData, the object type must match the type defined by the definition of the parameter. For example, if the parameter is error-handler, the value must be of type DOMErrorHandler. Exceptions: DOMException  NOT_FOUND_ERR: Raised when the parameter name is not recognized. NOT_SUPPORTED_ERR: Raised when the parameter name is recognized but the requested value cannot be set. TYPE_MISMATCH_ERR: Raised if the value type for this parameter name is incompatible with the expected value type. Implements org::w3c::dom::DOMConfiguration.

void acdk::xml::libxmldom::LibXMLDocument::setStrictErrorChecking (  bool  strictErrorChecking  )

void acdk::xml::libxmldom::LibXMLDocument::setXmlStandalone (  bool  xmlStandalone  )

void acdk::xml::libxmldom::LibXMLDocument::setXmlVersion (  IN(RString)  xmlVersion  )

RString acdk::xml::libxmldom::LibXMLDocument::toString (   )  [virtual]

return a string representation of this object Object::toString() return getName() by default Reimplemented from acdk::xml::libxmldom::LibXMLNode.

RString acdk::xml::libxmldom::LibXMLDocument::toXML (   )  [inline, virtual]

dom4j like extension Todo: implement in derived interfaces Reimplemented from acdk::xml::libxmldom::LibXMLNode.

Member Data Documentation

bool acdk::xml::libxmldom::LibXMLDocument::_canonicalForm [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_cdataSections [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_checkCharacterNormalization [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_comments [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_datatypeNormalization [protected]

org::w3c::dom::RDOMImplementation acdk::xml::libxmldom::LibXMLDocument::_domImpl [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_elementContentWhitespace [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_entities [protected]

org::w3c::dom::RDOMErrorHandler acdk::xml::libxmldom::LibXMLDocument::_errorHandler [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_namespaceDeclarations [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_namespaces [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_normalizeCharacters [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_splitCdataSections [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_strictErrorChecking [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_validate [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_validateIfSchema [protected]

bool acdk::xml::libxmldom::LibXMLDocument::_wellFormed [protected]