artefaktur
software engineer &        architecture

 
 
 
 

class DOMParser

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

acdk::xml::dom::DOMParser Class Reference

#include <DOMParser.h>

Inheritance diagram for acdk::xml::dom::DOMParser:

acdk::lang::Object org::xml::sax::DocumentHandler org::xml::sax::ErrorHandler acdk::lang::ObjectBase acdk::lang::dmi::StdDispatch List of all members.

Detailed Description

API: org.w3c.dom<br>.

Author:
Roger Rene Kommer
Version:
Revision
1.8
Date:
Date
2005/02/05 10:45:36


Public Member Functions

 DOMParser ()
RXMLDocument parse (IN(RString) text)
 deprecated

RXMLDocument parse (IN(RbyteArray) text)
virtual void setDocumentLocator (IN(RLocator) locator)
 Receive an object for locating the origin of SAX document events.

virtual void startDocument () throw ( org::xml::sax::RSAXException )
 Receive notification of the beginning of a document.

virtual void endDocument () throw ( org::xml::sax::RSAXException )
 Receive notification of the end of a document.

virtual void startElement (IN(::acdk::lang::RString) s, IN(RAttributeList) attributelist) throw ( org::xml::sax::RSAXException )
 Receive notification of the beginning of an element.

virtual void endElement (IN(::acdk::lang::RString) s) throw ( org::xml::sax::RSAXException )
 Receive notification of the end of an element.

virtual void characters (IN(RString) str, int start, int length) throw ( org::xml::sax::RSAXException )
 Receive notification of character data.

virtual void ignorableWhitespace (IN(RString) str, int start, int length) throw ( org::xml::sax::RSAXException )
 Receive notification of ignorable whitespace in element content.

virtual void processingInstruction (IN(::acdk::lang::RString) s, IN(::acdk::lang::RString) s1) throw ( org::xml::sax::RSAXException )
virtual void warning (IN(org::xml::sax::RSAXParseException) saxparseexception) throw ( org::xml::sax::RSAXException )
virtual void error (IN(org::xml::sax::RSAXParseException) saxparseexception) throw ( org::xml::sax::RSAXException )
virtual void fatalError (IN(org::xml::sax::RSAXParseException) saxparseexception) throw ( org::xml::sax::RSAXException )

Public Attributes

RLocator _locator
RXMLDocument _document
RNode _curNode
RText _curText

Constructor & Destructor Documentation

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


Member Function Documentation

virtual void acdk::xml::dom::DOMParser::characters IN(RString str,
int  start,
int  length
throw ( org::xml::sax::RSAXException ) [virtual]
 

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).

Parameters:
ch The characters from the XML document.
start The start position in the array.
length The number of characters to read from the array.
Exceptions:
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
See also:
ignorableWhitespace

org::xml::sax::Locator

Implements org::xml::sax::DocumentHandler.

virtual void acdk::xml::dom::DOMParser::endDocument  )  throw ( org::xml::sax::RSAXException ) [virtual]
 

Receive notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

Exceptions:
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.

Implements org::xml::sax::DocumentHandler.

virtual void acdk::xml::dom::DOMParser::endElement IN(::acdk::lang::RString s  )  throw ( org::xml::sax::RSAXException ) [virtual]
 

Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

If the element name has a namespace prefix, the prefix will still be attached to the name.

Parameters:
name The element type name
Exceptions:
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.

Implements org::xml::sax::DocumentHandler.

virtual void acdk::xml::dom::DOMParser::error IN(org::xml::sax::RSAXParseException saxparseexception  )  throw ( org::xml::sax::RSAXException ) [virtual]
 

virtual void acdk::xml::dom::DOMParser::fatalError IN(org::xml::sax::RSAXParseException saxparseexception  )  throw ( org::xml::sax::RSAXException ) [virtual]
 

virtual void acdk::xml::dom::DOMParser::ignorableWhitespace IN(RString str,
int  start,
int  length
throw ( org::xml::sax::RSAXException ) [virtual]
 

Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Parameters:
ch The characters from the XML document.
start The start position in the array.
length The number of characters to read from the array.
Exceptions:
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
See also:
characters

Implements org::xml::sax::DocumentHandler.

RXMLDocument acdk::xml::dom::DOMParser::parse IN(RbyteArray text  ) 
 

RXMLDocument acdk::xml::dom::DOMParser::parse IN(RString text  ) 
 

deprecated

virtual void acdk::xml::dom::DOMParser::processingInstruction IN(::acdk::lang::RString s,
IN(::acdk::lang::RString s1
throw ( org::xml::sax::RSAXException ) [virtual]
 

virtual void acdk::xml::dom::DOMParser::setDocumentLocator IN(RLocator locator  )  [virtual]
 

Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the DocumentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.

Parameters:
locator An object that can return the location of any SAX document event.
See also:
org::xml::sax::Locator

Implements org::xml::sax::DocumentHandler.

virtual void acdk::xml::dom::DOMParser::startDocument  )  throw ( org::xml::sax::RSAXException ) [virtual]
 

Receive notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).

Exceptions:
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.

Implements org::xml::sax::DocumentHandler.

virtual void acdk::xml::dom::DOMParser::startElement IN(::acdk::lang::RString s,
IN(RAttributeList attributelist
throw ( org::xml::sax::RSAXException ) [virtual]
 

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.

If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.

Parameters:
name The element type name.
atts The attributes attached to the element, if any.
Exceptions:
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
See also:
endElement

org::xml::sax::AttributeList

Implements org::xml::sax::DocumentHandler.

virtual void acdk::xml::dom::DOMParser::warning IN(org::xml::sax::RSAXParseException saxparseexception  )  throw ( org::xml::sax::RSAXException ) [virtual]
 


Member Data Documentation

RNode acdk::xml::dom::DOMParser::_curNode
 

RText acdk::xml::dom::DOMParser::_curText
 

RXMLDocument acdk::xml::dom::DOMParser::_document
 

RLocator acdk::xml::dom::DOMParser::_locator
 

 
Last modified 2005-05-08 18:34 by SYSTEM By Artefaktur, Ing. Bureau Kommer