Namespace: OpenEdge.Core.XML
Type: Class SaxReader
Parent Classes:
Progress.Lang.Object

Inherits: Progress.Lang.Object


Copyright (c) 2013, 2017, 2021 by Progress Software Corporation. All rights reserved.
File:SaxReader
Purpose:Wrapper OpenEdge/Core/XML/SaxReaderfacade.p which handles SAX
parser events.
Author(s):pjudge
Created:Tue Jul 13 09:50:23 EDT 2010
Notes:* The strongly-typed events in this class correspond to the
SAX-READER events, as documented in the ABL documentation
set. This class basically acts as a wrapper around a .P
since classes can't be specified as listeners for the SAX-
READER object. This class then re-publishes the events as
strongly typed events.
and not the sender,eventargs convention otherwise used in
this reference code.
/* SAX Events from SAX-READER callbacks



Method Summary
  Options Name Purpose
  Characters (longchar, integer)
  EndDocument ()
  EndElement (character, character, character)
  EndPrefixMapping (character)
  Error (character)
  FatalError (character)
  IgnorableWhitespace (character, integer)
  NotationDecl (character, character, character) /** Process notations and unparsed entities.*/
  ParseDocument (longchar) /* Parses the XML contained in the input longchar @param longchar The XML data to parse. */
  ParseDocument (memptr) /* Parses the XML contained in the input memptr @param memptr The XML data to parse. */
  ParseFile (character) /* Parses the XML contained in the input file @param character The name of the file to parse. */
  ProcessingInstruction (character, character)
  ResolveEntity (character, character, character, longchar) /* Tell the parser where to find an external entity. */
  StartDocument () /** Process various XML tokens. */
  StartElement (character, character, character, handle)
  StartPrefixMapping (character, character)
  UnparsedEntityDecl (character, character, character, character)
  Warning (character) /*Handle errors.*/

Constructor Summary
  Options Name Purpose
  SaxReader () /* Default constructor */

Event Summary
  Options Name Purpose
  SaxReaderCharacters (handle, longchar, integer)
  SaxReaderEndDocument (handle)
  SaxReaderEndElement (handle, character, character, character)
  SaxReaderEndPrefixMapping (handle, character)
  SaxReaderError (handle, character)
  SaxReaderFatalError (handle, character)
  SaxReaderIgnorableWhitespace (handle, character, integer)
  SaxReaderNotationDecl (handle, character, character, character)
  SaxReaderProcessingInstruction (handle, character, character)
  SaxReaderResolveEntity (handle, character, character, character, longchar)
  SaxReaderStartDocument (handle) /* SAX Events from SAX-READER callbacks */
  SaxReaderStartElement (handle, character, character, character, handle)
  SaxReaderStartPrefixMapping (handle, character, character)
  SaxReaderUnparsedEntityDecl (handle, character, character, character, character)
  SaxReaderWarning (handle, character)

Method Detail
Top

Characters (longchar, integer)

Parameters:
pcCharData LONGCHAR
 
piNumChars INTEGER
 
Top

EndDocument ()

Top

EndElement (character, character, character)

Parameters:
pcNamespaceURI CHARACTER
 
pcLocalName CHARACTER
 
pcQName CHARACTER
 
Top

EndPrefixMapping (character)

Parameters:
pcPrefix CHARACTER
 
Top

Error (character)

Parameters:
pcErrMessage CHARACTER
 
Top

FatalError (character)

Parameters:
pcErrMessage CHARACTER
 
Top

IgnorableWhitespace (character, integer)

Parameters:
pcCharData CHARACTER
 
piNumChars INTEGER
 
Top

NotationDecl (character, character, character)

Purpose: Process notations and unparsed entities.
Parameters:
pcName CHARACTER
 
pcPublicID CHARACTER
 
pcSystemID CHARACTER
 
Top

ParseDocument (longchar)

/* Parses the XML contained in the input longchar
Parameters:
pcXML LONGCHAR
 
Top

ParseDocument (memptr)

/* Parses the XML contained in the input memptr
Parameters:
pmXML MEMPTR
 
Top

ParseFile (character)

/* Parses the XML contained in the input file
Parameters:
pcFilename CHARACTER
 
Top

ProcessingInstruction (character, character)

Parameters:
pcTarget CHARACTER
 
pcData CHARACTER
 
Top

ResolveEntity (character, character, character, longchar)

/* Tell the parser where to find an external entity.
Parameters:
pcPublicID CHARACTER
 
pcSystemID CHARACTER
 
pcFilePath CHARACTER
 
pcMemPointer LONGCHAR
 
Top

StartDocument ()

Purpose: Process various XML tokens.
Top

StartElement (character, character, character, handle)

Parameters:
pcNamespaceURI CHARACTER
 
pcLocalName CHARACTER
 
pcQName CHARACTER
 
phAttributes HANDLE
 
Top

StartPrefixMapping (character, character)

Parameters:
pcPrefix CHARACTER
 
pcURI CHARACTER
 
Top

UnparsedEntityDecl (character, character, character, character)

Parameters:
pcName CHARACTER
 
pcPublicID CHARACTER
 
pcSystemID CHARACTER
 
pcNotationName CHARACTER
 
Top

Warning (character)

/*Handle errors.
Parameters:
pcErrMessage CHARACTER
 


Constructor Detail
Top

SaxReader ()

/* Default constructor


Event Detail
Top

SaxReaderCharacters (handle, longchar, integer)

Parameters:
phReader HANDLE
 
pcCharData LONGCHAR
 
piNumChars INTEGER
 
Top

SaxReaderEndDocument (handle)

Parameters:
phReader HANDLE
 
Top

SaxReaderEndElement (handle, character, character, character)

Parameters:
phSaxReader HANDLE
 
pcNamespaceURI CHARACTER
 
pcLocalName CHARACTER
 
pcQName CHARACTER
 
Top

SaxReaderEndPrefixMapping (handle, character)

Parameters:
phReader HANDLE
 
pcPrefix CHARACTER
 
Top

SaxReaderError (handle, character)

Parameters:
phReader HANDLE
 
pcErrMessage CHARACTER
 
Top

SaxReaderFatalError (handle, character)

Parameters:
phReader HANDLE
 
pcErrMessage CHARACTER
 
Top

SaxReaderIgnorableWhitespace (handle, character, integer)

Parameters:
phReader HANDLE
 
pcCharData CHARACTER
 
piNumChars INTEGER
 
Top

SaxReaderNotationDecl (handle, character, character, character)

Parameters:
phReader HANDLE
 
pcName CHARACTER
 
pcPublicID CHARACTER
 
pcSystemID CHARACTER
 
Top

SaxReaderProcessingInstruction (handle, character, character)

Parameters:
phReader HANDLE
 
pcTarget CHARACTER
 
pcData CHARACTER
 
Top

SaxReaderResolveEntity (handle, character, character, character, longchar)

Parameters:
phReader HANDLE
 
pcPublicID CHARACTER
 
pcSystemID CHARACTER
 
pcFilePath CHARACTER
 
pcMemPointer LONGCHAR
 
Top

SaxReaderStartDocument (handle)

/* SAX Events from SAX-READER callbacks
Parameters:
phReader HANDLE
 
Top

SaxReaderStartElement (handle, character, character, character, handle)

Parameters:
phReader HANDLE
 
pcNamespaceURI CHARACTER
 
pcLocalName CHARACTER
 
pcQName CHARACTER
 
phAttributes HANDLE
 
Top

SaxReaderStartPrefixMapping (handle, character, character)

Parameters:
phReader HANDLE
 
pcPrefix CHARACTER
 
pcURI CHARACTER
 
Top

SaxReaderUnparsedEntityDecl (handle, character, character, character, character)

Parameters:
phReader HANDLE
 
pcName CHARACTER
 
publicID CHARACTER
 
systemID CHARACTER
 
pcNotationName CHARACTER
 
Top

SaxReaderWarning (handle, character)

Parameters:
phReader HANDLE
 
pcErrMessage CHARACTER