SAX-READER Object
Interfaces
|
OS
|
SpeedScript
|
All
|
All
|
Yes
|
Provides access to the XML parser when used with the Simple API for XML (SAX). The SAX-READER object, used with SAX, corresponds to the X-DOCUMENT object of the Document Object Model (DOM) interface, but presents a programming interface that is radically different.
SYNTAX
sax-reader-handle
A handle to a SAX-READER object.
attribute
An attribute of the SAX-READER object. Table D–11 summarizes each attribute.
Table D–11: SAX-READER Object Attributes
Attribute
|
Type
|
Description
|
|
CHARACTER
|
An arbitrary string for use by the ADM only.
|
|
HANDLE
|
A handle to the procedure containing the callbacks.
|
|
INTEGER
|
The current column in the XML source.
|
|
INTEGER
|
The current line in the XML source.
|
|
CHARACTER
|
The public identifier of the current XML source.
|
|
CHARACTER
|
The system identifier of the current XML source.
|
|
INTEGER
|
The current status of the parse. Valid values are:
SAX-UNINITIALIZED
SAX-RUNNING
SAX-COMPLETE
SAX-PARSER-ERROR
|
|
CHARACTER
|
An arbitrary string.
|
|
CHARACTER
|
The path of a DTD associated with the XML document to be parsed.
|
|
LOGICAL
|
Whether the parser performs namespace processing.
|
|
CHARACTER
|
The type of a SAX-READER handle, which is “SAX-READER.”
|
|
INTEGER
|
A value guaranteed by Progress to be unique within the Progress session.
|
|
LOGICAL
|
Whether the parser performs validation.
|
method
A method of the SAX-READER object. Table D–12 summarizes each method.
Table D–12: Methods Of the SAX-READER Object
Method
|
Return Type
|
Description
|
|
None.
(Check ERROR-STATUS: ERROR.)
|
Performs a single-call parse of an XML document.
|
|
None.
(Check ERROR-STATUS:ERROR.)
|
Initializes a progressive-scan parse of an XML document. Called once at the beginning of the parse.
|
|
None.
(Check ERROR-STATUS:ERROR.)
|
Continues a progressive-scan parse of the XML document. Called repeatedly to continue the parse.
|
|
LOGICAL
|
Defines the source of the XML document to be parsed.
|
|
LOGICAL
|
Causes the parser to stop parsing the XML document.
|
SEE ALSO
CREATE SAX-READER Statement, SAX-ATTRIBUTES Object.