XMLParserItf 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 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:


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&,CATBaseUnknown_var&)
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(CATUnicodeString&)
Parses an XML document from a system identifier (URI).
o Parse(CATISAXInputSource_var&)
Parses an XML document.
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&,CATBaseUnknown_var)
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( iParentReader)
Constructor
Parameters:
iParentReader
The parent reader
o ~CATSAXDefaultXMLFilter
public virtual ~CATSAXDefaultXMLFilter()
Destructor

Methods


o Characters
public virtual Characters( const iCharacters)
Receives notification of character data.
See also:
o EndDocument
public virtual EndDocument()
Receives notification of the end of a document.
See also:
o EndElement
public virtual EndElement( const iURI,
const iLocalName,
const iQualifiedName)
Receives notification of the end of an element.
See also:
o EndPrefixMapping
public virtual EndPrefixMapping( const iPrefix)
Receives notification of the end of the scope of a prefix-URI Namespace mapping.
See also:
o Error
public virtual Error( iException)
Receives notification of a recoverable error.
See also:
o FatalError
public virtual FatalError( iException)
Receives notification of a non-recoverable error.
See also:
o GetContentHandler
public virtual GetContentHandler( oContentHandler)
Retrieves the current content event handler.
See also:
o GetDTDHandler
public virtual GetDTDHandler( oDTDHandler)
Retrieves the current DTD event handler.
See also:
o GetEntityResolver
public virtual GetEntityResolver( oEntityResolver)
Retrieves the current entity resolver.
See also:
o GetErrorHandler
public virtual GetErrorHandler( oErrorHandler)
Retrieves the current error event handler.
See also:
o GetFeature
public virtual GetFeature( const iName,
oFeature)
Retrieves the value of a feature.
See also:
o GetParent
public virtual GetParent( oParent)
Get the parent reader.
Parameters:
oParent
The parent reader
o GetProperty
public virtual GetProperty( const iName,
oProperty)
Retrieves up the value of a property.
See also:
o IgnorableWhiteSpace
public virtual IgnorableWhiteSpace( const iCharacters)
Receives notification of ignorable whitespace in element content.
See also:
o NotationDecl
public virtual NotationDecl( const iName,
const iPublicId,
const iSystemId)
Receives notification of a notation declaration event.
See also:
o Parse
public virtual Parse( const iSystemId)
Parses an XML document from a system identifier (URI).
See also:
o Parse
public virtual Parse( const iInputSource)
Parses an XML document.
See also:
o ProcessingInstruction
public virtual ProcessingInstruction( const iTarget,
const iData)
Receives notification of a processing instruction.
See also:
o ResolveEntity
public virtual ResolveEntity( const iPublicId,
const iSystemId,
oInputSource)
Allows the application to resolve external entities.
See also:
o SetContentHandler
public virtual SetContentHandler( const iContentHandler)
Allows an application to register a content event handler.
See also:
o SetDTDHandler
public virtual SetDTDHandler( const iDTDHandler)
Allows an application to register a DTD event handler.
See also:
o SetDocumentLocator
public virtual SetDocumentLocator( const iLocator)
Receives an object for locating the origin of SAX content events.
See also:
o SetEntityResolver
public virtual SetEntityResolver( const iEntityResolver)
Allows an application to register a custom entity resolver.
See also:
o SetErrorHandler
public virtual SetErrorHandler( const iErrorHandler)
Allows an application to register an error event handler.
See also:
o SetFeature
public virtual SetFeature( const iName,
iFeature)
Sets the value of a feature.
See also:
o SetParent
public virtual SetParent( const iParent)
Set the parent reader. This is the 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 SetProperty( const iName,
iProperty)
Sets the value of a property.
See also:
o SkippedEntity
public virtual SkippedEntity( const iName)
Receives notification of a skipped entity.
See also:
o StartDocument
public virtual StartDocument()
Receives notification of the beginning of a document.
See also:
o StartElement
public virtual StartElement( const iURI,
const iLocalName,
const iQualifiedName,
const iAttributes)
Receives notification of the beginning of an element.
See also:
o StartPrefixMapping
public virtual StartPrefixMapping( const iPrefix,
const iURI)
Receives notification of the beginning of the scope of a prefix-URI Namespace mapping.
See also:
o UnparsedEntityDecl
public virtual UnparsedEntityDecl( const iName,
const iPublicId,
const iSystemId,
const iNotationName)
Receives notification of an unparsed entity declaration event.
See also:
o Warning
public virtual Warning( iException)
Receives notification of a warning.
See also:

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: CatXmlItfBase

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.