All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

XMLParser Interface CATISAXDocumentHandler

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISAXDocumentHandler
 

Usage: you can freely reimplement this interface.


interface CATISAXDocumentHandler

Interface to receive notification of general document events.

This is the main interface that most SAX applications implement: if the application needs to be informed of basic parsing events, it implements this interface and registers an instance with the SAX parser using the CATISAXParser.SetDocumentHandler method. The parser uses the instance to report basic document-related events like the start and end of elements and character data.

The order of events in this interface is very important, and mirrors the order of information in the document itself. For example, all of an element content (character data, processing instructions, and/or subelements) will appear, in order, between the StartElement event and the corresponding EndElement event.

Application writers who do not want to implement the entire interface can derive a class from CATSAXHandlerBase, which implements the default functionality; parser writers can instantiate CATSAXHandlerBase to obtain a default handler. The application can find the location of any document event using the CATISAXLocator interface supplied by the CATISAXParser through the SetDocumentLocator method.

See also:
CATISAXParser.SetDocumentHandler, CATISAXLocator, CATSAXHandlerBase


Method Index


o Characters(CATUnicodeString&)
Receives notification of character data.
o EndDocument()
Receives notification of the end of a document.
o EndElement(CATUnicodeString&)
Receives notification of the end of an element.
o IgnorableWhiteSpace(CATUnicodeString&)
Receives notification of ignorable whitespace in element content.
o ProcessingInstruction(CATUnicodeString&,CATUnicodeString&)
Receives notification of a processing instruction.
o SetDocumentLocator(CATISAXLocator_var&)
Receives an object for locating the origin of SAX document events.
o StartDocument()
Receives notification of the beginning of a document.
o StartElement(CATUnicodeString&,CATISAXAttributeList_var&)
Receives notification of the beginning of an element.

Methods


o Characters
public virtual HRESULT Characters( const CATUnicodeString& iCharacters) = 0
Receives notification of character data.

The CATISAXParser 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 CATISAXLocator provides useful information.

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

Parameters:
iCharacters
The characters from the XML document.
Errors Returned:
Error Class Error Id Description
CATSAXException XMLParserERR_2000 The method can raise a CATSAXException
CATSAXParseException XMLParserERR_2002 The method can raise a CATSAXParseException
See also:
IgnorableWhiteSpace, CATISAXLocator
o EndDocument
public virtual HRESULT EndDocument()= 0
Receives 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.

Errors Returned:
Error Class Error Id Description
CATSAXException XMLParserERR_2000 The method can raise a CATSAXException
CATSAXParseException XMLParserERR_2002 The method can raise a CATSAXParseException
o EndElement
public virtual HRESULT EndElement( const CATUnicodeString& iName) = 0
Receives 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:
iName
The element type name
Errors Returned:
Error Class Error Id Description
CATSAXException XMLParserERR_2000 The method can raise a CATSAXException
CATSAXParseException XMLParserERR_2002 The method can raise a CATSAXParseException
o IgnorableWhiteSpace
public virtual HRESULT IgnorableWhiteSpace( const CATUnicodeString& iCharacters) = 0
Receives 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 CATISAXLocator provides useful information.

Parameters:
iCharacters
The characters from the XML document.
Errors Returned:
Error Class Error Id Description
CATSAXException XMLParserERR_2000 The method can raise a CATSAXException
CATSAXParseException XMLParserERR_2002 The method can raise a CATSAXParseException
See also:
Characters
o ProcessingInstruction
public virtual HRESULT ProcessingInstruction( const CATUnicodeString& iTarget,
const CATUnicodeString& iData) = 0
Receives notification of a processing instruction.

The CATISAXParser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

Parameters:
iTarget
The processing instruction target.
iData
The processing instruction data (can be an empty
CATUnicodeString if no processing instruction data was given).
Errors Returned:
Error Class Error Id Description
CATSAXException XMLParserERR_2000 The method can raise a CATSAXException
CATSAXParseException XMLParserERR_2002 The method can raise a CATSAXParseException
o SetDocumentLocator
public virtual HRESULT SetDocumentLocator( const CATISAXLocator_var& iLocator) = 0
Receives 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 CATISAXDocumentHandler 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:
iLocator
An object that can return the location of any SAX document event.
See also:
CATISAXLocator
o StartDocument
public virtual HRESULT StartDocument()= 0
Receives 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 CATISAXDTDHandler (except for SetDocumentLocator ).

Errors Returned:
Error Class Error Id Description
CATSAXException XMLParserERR_2000 The method can raise a CATSAXException
CATSAXParseException XMLParserERR_2002 The method can raise a CATSAXParseException
o StartElement
public virtual HRESULT StartElement( const CATUnicodeString& iName,
const CATISAXAttributeList_var& iAttributes) = 0
Receives notification of the beginning of an element.

The CATISAXParser 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 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:
iName
The element type name.
iAttributes
The attributes attached to the element, if any.
Errors Returned:
Error Class Error Id Description
CATSAXException XMLParserERR_2000 The method can raise a CATSAXException
CATSAXParseException XMLParserERR_2002 The method can raise a CATSAXParseException
See also:
CATISAXAttributeList, EndElement

This object is included in the file: CATISAXDocumentHandler.h
If needed, your Imakefile.mk should include the module: CATXMLParserItf

Copyright © 2003, Dassault Systèmes. All rights reserved.