All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

XMLParser Interface CATIXMLSAXFactory

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

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIXMLSAXFactory

Factory interface for SAX objects.
CATISAXInputSource and CATISAXParser objects.


Method Index


o CreateInputSourceFromFile(CATUnicodeString&,CATUnicodeString&,CATISAXInputSource_var&)
Creates a CATISAXInputSource from the supplied file.
o CreateInputSourceFromMemoryBuffer(CATUnicodeString&,CATUnicodeString&,CATISAXInputSource_var&)
Creates a CATISAXInputSource from the supplied memory buffer.
o CreateInputSourceFromStream(CATIXMLInputStream_var&,CATUnicodeString&,CATISAXInputSource_var&)
Creates a CATISAXInputSource from the supplied stream.
o CreateParser(CATISAXParser_var&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&)
Creates a CATISAXParser.
o CreateXMLReader(CATISAXXMLReader_var&)
Creates a CATISAXXMLReader.
o GetSupportedOptions(CATListOfCATUnicodeString&)
Returns the list of options which can be used to customize the parser.

Methods


o CreateInputSourceFromFile
public virtual HRESULT CreateInputSourceFromFile( const CATUnicodeString& iFileName,
const CATUnicodeString& iPublicId,
CATISAXInputSource_var& oInputSource)= 0
Creates a CATISAXInputSource from the supplied file.
Parameters:
iFileName
The path of the file
iPublicId
The public id which will be assigned to the input source.
oInputSource
The resulting CATISAXInputSource
o CreateInputSourceFromMemoryBuffer
public virtual HRESULT CreateInputSourceFromMemoryBuffer( const CATUnicodeString& iBuffer,
const CATUnicodeString& iPublicId,
CATISAXInputSource_var& oInputSource)= 0
Creates a CATISAXInputSource from the supplied memory buffer.
Parameters:
iBuffer
A buffer containing XML text
iPublicId
The public id which will be assigned to the input source.
oInputSource
The resulting CATISAXInputSource
o CreateInputSourceFromStream
public virtual HRESULT CreateInputSourceFromStream( const CATIXMLInputStream_var& iStream,
const CATUnicodeString& iPublicId,
CATISAXInputSource_var& oInputSource)= 0
Creates a CATISAXInputSource from the supplied stream.
Parameters:
iStream
A stream from which XML contents will be fetched
iPublicId
The public id which will be assigned to the input source
oInputSource
The resulting CATISAXInputSource
o CreateParser
public virtual HRESULT CreateParser(CATISAXParser_var& oParser,
const CATListOfCATUnicodeString& iOptions= CATListOfCATUnicodeString(),
const CATListOfCATUnicodeString& iOptionValues= CATListOfCATUnicodeString())= 0
Creates a CATISAXParser.
Parameters:
oParser
The resulting CATISAXParser
iOptions
The names of the options to set
iOptionValues
The values of the options to set.
Errors Returned:
Error Class Error Id Description
CATSAXException XMLParserERR_2100 Invalid options definition
CATSAXException XMLParserERR_2101 Unsupported option
CATSAXException XMLParserERR_2102 Illegal option value
o CreateXMLReader
public virtual HRESULT CreateXMLReader(CATISAXXMLReader_var& oXMLReader)= 0
Creates a CATISAXXMLReader.

No options are required since SAX defines a standard way to pass them to the reader

Parameters:
oParser
The resulting CATISAXParser
o GetSupportedOptions
public virtual HRESULT GetSupportedOptions(CATListOfCATUnicodeString& oOptions) = 0
Returns the list of options which can be used to customize the parser.
Parameters:
oOptions
The list of options supported by the
CATISAXParser implementation. The current list of options is
Option name Description Possible values Default value
CATDoValidation Specifies if validation check is performed during parse true or false true
CATEnableNameSpaces Specifies if the parser is XML namespace aware true or false false

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

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