Namespace: Consultingwerk.Studio.OpenEdgeDocs
Class 
OpenEdgeDocParser Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implements: Consultingwerk.ISaxReader

File:OpenEdgeDocParser
Description:Creates an index of the ABL classes contained in the
OpenEdge HTML Documentation (contained in the oeide
plugin com.openedge.pdt.langref.help
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Feb 15 13:31:32 CET 2013



Top Method Summary
Options Name Purpose
+ ParseClassDocumentation (character, table) Parses/searches html documents in the OpenEdge HTML Documentation for documents containing classes/interfaces and creates a document index
+ SaxCharacters (longchar, integer) Invoked when the XML parser detects character data.
+ SaxEndElement (character, character, character) Invoked when the XML parser detects the end of an XML document.
+ SaxStartElement (character, character, character, handle) Invoked when the XML parser detects the beginning of an element.

Top Constructor Summary
Options Name Purpose
+ OpenEdgeDocParser () Constructor for the OpenEdgeDocParser class


Method Detail
Top

PUBLIC ParseClassDocumentation (character, table)

Purpose: Parses/searches html documents in the OpenEdge HTML Documentation
for documents containing classes/interfaces and creates a document
index
Notes:

Parameters:
pcFolder CHARACTER
The name of the folder to parse html documents in
ttClassDocumentation TEMP-TABLE ttClassDocumentation
OUTPUT Temp-Table with the document index
Top

PUBLIC SaxCharacters (longchar, integer)

Purpose: Invoked when the XML parser detects character data.
Notes: The parser calls this method to report each chunk of character data.
It might report contiguous character data in one chunk, or split it
into several chunks. If validation is enabled, whitespace is reported
by the IgnorableWhitespace callback

Parameters:
plcCharData LONGCHAR
A LONGCHAR that contains a chunk of character data.
piNumChars INTEGER
The number of characters contained in the MEMPTR.
Top

PUBLIC SaxEndElement (character, character, character)

Purpose: Invoked when the XML parser detects the end of an XML document.
Notes:

Parameters:
pcNamespaceURI CHARACTER
A character string indicating the namespace URI of the element. If namespace processing is not enabled or the element is not part of a namespace, the string is of length zero.
pcLocalName CHARACTER
A character string indicating the non-prefixed element name. If namespace processing is not enabled, the string is of length zero.
pcName CHARACTER
A character string indicating the actual name of the element in the XML source. If the name has a prefix, qName includes it, whether or not namespace processing is enabled.
Top

PUBLIC SaxStartElement (character, character, character, handle)

Purpose: Invoked when the XML parser detects the beginning of an element.
Notes:

Parameters:
pcNamespaceURI CHARACTER
A character string indicating the namespace URI of the element. If namespace processing is not enabled or the element is not part of a namespace, the string is of length zero.
pcLocalName CHARACTER
A character string indicating the non-prefixed element name. If namespace processing is not enabled, the string is of length zero.
pcName CHARACTER
A character string indicating the actual name of the element in the XML source. If the name has a prefix, qName includes it, whether or not namespace processing is enabled.
phAttributes HANDLE
A handle to a SAX-attributes object, which provides access to all attributes specified for the element. If the element has no attributes, attributes is still a valid handle, and the NUM-ITEMS attribute is zero.


Constructor Detail
Top

PUBLIC OpenEdgeDocParser ()

Purpose: Constructor for the OpenEdgeDocParser class
Notes:



Temp-Table Detail

Temp-Table ttClassDocumentation

Defined in:


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:15:39