All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

XMLParser Class CATSAXDefaultXMLFilter

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

Usage: you can derive this class.


public class CATSAXDefaultXMLFilter

Base class for deriving an XML filter.

This class is designed to sit between an CATISAXXMLReader and the client application's event handlers. By default, it does nothing but pass requests up to the reader and events on to the handlers unmodified, but subclasses can override specific methods to modify the event stream or the configuration requests as they pass through.

See also:
CATISAXXMLReader


Constructor and Destructor Index


o CATSAXDefaultXMLFilter(CATISAXXMLReader_var&)
Constructor
o ~CATSAXDefaultXMLFilter()
Destructor

Method Index


o Characters(CATUnicodeString&)
Receives notification of character data.
o EndDocument()
Receives notification of the end of a document.
o EndElement(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Receives notification of the end of an element.
o EndPrefixMapping(CATUnicodeString&)
Receives notification of the end of the scope of a prefix-URI Namespace mapping.
o Error(CATSAXParseException*)
Receives notification of a recoverable error.
o FatalError(CATSAXParseException*)
Receives notification of a non-recoverable error.
o GetContentHandler(CATISAXContentHandler_var&)
Retrieves the current content event handler.
o GetDTDHandler(CATISAXDTDHandler_var&)
Retrieves the current DTD event handler.
o GetEntityResolver(CATISAXEntityResolver_var&)
Retrieves the current entity resolver.
o GetErrorHandler(CATISAXErrorHandler_var&)
Retrieves the current error event handler.
o GetFeature(CATUnicodeString&,CATBoolean&)
Retrieves the value of a feature.
o GetParent(CATISAXXMLReader_var&)
Get the parent reader.
o GetProperty(CATUnicodeString&,CATVariant&)
Retrieves up the value of a property.
o IgnorableWhiteSpace(CATUnicodeString&)
Receives notification of ignorable whitespace in element content.
o NotationDecl(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Receives notification of a notation declaration event.
o Parse(CATISAXInputSource_var&)
Parses an XML document.
o Parse(CATUnicodeString&)
Parses an XML document from a system identifier (URI).
o ProcessingInstruction(CATUnicodeString&,CATUnicodeString&)
Receives notification of a processing instruction.
o ResolveEntity(CATUnicodeString&,CATUnicodeString&,CATISAXInputSource_var&)
Allows the application to resolve external entities.
o SetContentHandler(CATISAXContentHandler_var&)
Allows an application to register a content event handler.
o SetDTDHandler(CATISAXDTDHandler_var&)
Allows an application to register a DTD event handler.
o SetDocumentLocator(CATISAXLocator_var&)
Receives an object for locating the origin of SAX content events.
o SetEntityResolver(CATISAXEntityResolver_var&)
Allows an application to register a custom entity resolver.
o SetErrorHandler(CATISAXErrorHandler_var&)
Allows an application to register an error event handler.
o SetFeature(CATUnicodeString&,CATBoolean)
Sets the value of a feature.
o SetParent(CATISAXXMLReader_var&)
Set the parent reader.
o SetProperty(CATUnicodeString&,CATVariant)
Sets the value of a property.
o SkippedEntity(CATUnicodeString&)
Receives notification of a skipped entity.
o StartDocument()
Receives notification of the beginning of a document.
o StartElement(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATISAXAttributes_var&)
Receives notification of the beginning of an element.
o StartPrefixMapping(CATUnicodeString&,CATUnicodeString&)
Receives notification of the beginning of the scope of a prefix-URI Namespace mapping.
o UnparsedEntityDecl(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Receives notification of an unparsed entity declaration event.
o Warning(CATSAXParseException*)
Receives notification of a warning.

Data Member Index


o _parent
The parent reader.

Constructor and Destructor


o CATSAXDefaultXMLFilter
public CATSAXDefaultXMLFilter(CATISAXXMLReader_var& iParentReader)
Constructor
Parameters:
iParentReader
The parent reader
o ~CATSAXDefaultXMLFilter
public virtual ~CATSAXDefaultXMLFilter()
Destructor

Methods


o Characters
public virtual HRESULT Characters( const CATUnicodeString& iCharacters)
Receives notification of character data.
See also:
CATISAXContentHandler.Characters
o EndDocument
public virtual HRESULT EndDocument()
Receives notification of the end of a document.
See also:
CATISAXContentHandler.EndDocument
o EndElement
public virtual HRESULT EndElement( const CATUnicodeString& iURI,
const CATUnicodeString& iLocalName,
const CATUnicodeString& iQualifiedName)
Receives notification of the end of an element.
See also:
CATISAXContentHandler.EndElement
o EndPrefixMapping
public virtual HRESULT EndPrefixMapping( const CATUnicodeString& iPrefix)
Receives notification of the end of the scope of a prefix-URI Namespace mapping.
See also:
CATISAXContentHandler.EndPrefixMapping
o Error
public virtual HRESULT Error(CATSAXParseException* iException)
Receives notification of a recoverable error.
See also:
CATISAXErrorHandler.Error
o FatalError
public virtual HRESULT FatalError(CATSAXParseException* iException)
Receives notification of a non-recoverable error.
See also:
CATISAXErrorHandler.FatalError
o GetContentHandler
public virtual HRESULT GetContentHandler(CATISAXContentHandler_var& oContentHandler)
Retrieves the current content event handler.
See also:
CATISAXXMLReader.GetContentHandler
o GetDTDHandler
public virtual HRESULT GetDTDHandler(CATISAXDTDHandler_var& oDTDHandler)
Retrieves the current DTD event handler.
See also:
CATISAXXMLReader.GetDTDHandler
o GetEntityResolver
public virtual HRESULT GetEntityResolver(CATISAXEntityResolver_var& oEntityResolver)
Retrieves the current entity resolver.
See also:
CATISAXXMLReader.GetEntityResolver
o GetErrorHandler
public virtual HRESULT GetErrorHandler(CATISAXErrorHandler_var& oErrorHandler)
Retrieves the current error event handler.
See also:
CATISAXXMLReader.GetErrorHandler
o GetFeature
public virtual HRESULT GetFeature( const CATUnicodeString& iName,
CATBoolean& oFeature)
Retrieves the value of a feature.
See also:
CATISAXXMLReader.GetFeature
o GetParent
public virtual HRESULT GetParent(CATISAXXMLReader_var& oParent)
Get the parent reader.
Parameters:
oParent
The parent reader
o GetProperty
public virtual HRESULT GetProperty( const CATUnicodeString& iName,
CATVariant& oProperty)
Retrieves up the value of a property.
See also:
CATISAXXMLReader.GetProperty
o IgnorableWhiteSpace
public virtual HRESULT IgnorableWhiteSpace( const CATUnicodeString& iCharacters)
Receives notification of ignorable whitespace in element content.
See also:
CATISAXContentHandler.IgnorableWhiteSpace
o NotationDecl
public virtual HRESULT NotationDecl( const CATUnicodeString& iName,
const CATUnicodeString& iPublicId,
const CATUnicodeString& iSystemId)
Receives notification of a notation declaration event.
See also:
CATISAXDTDHandler.NotationDecl
o Parse
public virtual HRESULT Parse( const CATISAXInputSource_var& iInputSource)
Parses an XML document.
See also:
CATISAXXMLReader.Parse
o Parse
public virtual HRESULT Parse( const CATUnicodeString& iSystemId)
Parses an XML document from a system identifier (URI).
See also:
CATISAXXMLReader.Parse
o ProcessingInstruction
public virtual HRESULT ProcessingInstruction( const CATUnicodeString& iTarget,
const CATUnicodeString& iData)
Receives notification of a processing instruction.
See also:
CATISAXContentHandler.ProcessingInstruction
o ResolveEntity
public virtual HRESULT ResolveEntity( const CATUnicodeString& iPublicId,
const CATUnicodeString& iSystemId,
CATISAXInputSource_var& oInputSource)
Allows the application to resolve external entities.
See also:
CATISAXEntityResolver.ResolveEntity
o SetContentHandler
public virtual HRESULT SetContentHandler( const CATISAXContentHandler_var& iContentHandler)
Allows an application to register a content event handler.
See also:
CATISAXXMLReader.SetContentHandler
o SetDTDHandler
public virtual HRESULT SetDTDHandler( const CATISAXDTDHandler_var& iDTDHandler)
Allows an application to register a DTD event handler.
See also:
CATISAXXMLReader.SetDTDHandler
o SetDocumentLocator
public virtual HRESULT SetDocumentLocator( const CATISAXLocator_var& iLocator)
Receives an object for locating the origin of SAX content events.
See also:
CATISAXContentHandler.SetDocumentLocator
o SetEntityResolver
public virtual HRESULT SetEntityResolver( const CATISAXEntityResolver_var& iEntityResolver)
Allows an application to register a custom entity resolver.
See also:
CATISAXXMLReader.SetEntityResolver
o SetErrorHandler
public virtual HRESULT SetErrorHandler( const CATISAXErrorHandler_var& iErrorHandler)
Allows an application to register an error event handler.
See also:
CATISAXXMLReader.SetErrorHandler
o SetFeature
public virtual HRESULT SetFeature( const CATUnicodeString& iName,
CATBoolean iFeature)
Sets the value of a feature.
See also:
CATISAXXMLReader.SetFeature
o SetParent
public virtual HRESULT SetParent( const CATISAXXMLReader_var& iParent)
Set the parent reader. This is the CATISAXXMLReader from which this filter will obtain its events and to which it will pass its configuration requests. The parent may itself be another filter. If there is no parent reader set, any attempt to parse or to set or get a feature or property will fail.
Parameters:
iParent
The parent reader
o SetProperty
public virtual HRESULT SetProperty( const CATUnicodeString& iName,
CATVariant iProperty)
Sets the value of a property.
See also:
CATISAXXMLReader.SetProperty
o SkippedEntity
public virtual HRESULT SkippedEntity( const CATUnicodeString& iName)
Receives notification of a skipped entity.
See also:
CATISAXContentHandler.SkippedEntity
o StartDocument
public virtual HRESULT StartDocument()
Receives notification of the beginning of a document.
See also:
CATISAXContentHandler.StartDocument
o StartElement
public virtual HRESULT StartElement( const CATUnicodeString& iURI,
const CATUnicodeString& iLocalName,
const CATUnicodeString& iQualifiedName,
const CATISAXAttributes_var& iAttributes)
Receives notification of the beginning of an element.
See also:
CATISAXContentHandler.StartElement
o StartPrefixMapping
public virtual HRESULT StartPrefixMapping( const CATUnicodeString& iPrefix,
const CATUnicodeString& iURI)
Receives notification of the beginning of the scope of a prefix-URI Namespace mapping.
See also:
CATISAXContentHandler.StartPrefixMapping
o UnparsedEntityDecl
public virtual HRESULT UnparsedEntityDecl( const CATUnicodeString& iName,
const CATUnicodeString& iPublicId,
const CATUnicodeString& iSystemId,
const CATUnicodeString& iNotationName)
Receives notification of an unparsed entity declaration event.
See also:
CATISAXDTDHandler.NotationDecl
o Warning
public virtual HRESULT Warning(CATSAXParseException* iException)
Receives notification of a warning.
See also:
CATISAXErrorHandler.Warning

Data Members


o _parent
  protected CATISAXXMLReader_var _parent
The parent reader. When you overwrite one of methods of the default filter, you can use this member to get access to the old method from the new method.

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

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