com.goldencode.p2j.xml

Interface SaxReader

All Superinterfaces:

ADMData, SaxEntity, UniqueID, WrappedResource, XCommon, XmlSchema

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

SaxReaderImpl

public interface SaxReader
extends SaxEntity, XmlSchema

Interface describing SAX-Reader specific features of the SAX objects.

Nested Class Summary

Nested Classes

Modifier and Type

Interface and Description

static class

SaxReader.ReadStatus List of possible states of SAX-READER object, returned by the PARSE-STATUS attribute: SaxReader.ReadStatus.SAX_UNINITIALIZED -The SAX-UNINITIALIZED constant which in 4GL is the integer value 1. SaxReader.ReadStatus.SAX_RUNNING - The SAX-RUNNING constant which in 4GL is the integer 2. SaxReader.ReadStatus.SAX_COMPLETE - The SAX-COMPLETE constant which in 4GL is the integer 3. SaxReader.ReadStatus.SAX_PARSER_ERROR - The SAX-PARSER-ERROR constant which in 4GL is the integer 4.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SAX_COMPLETE The SAX-COMPLETE constant returned by the PARSE-STATUS attribute, which in 4GL is the integer value 3.
static int	SAX_PARSER_ERROR The SAX-PARSER-ERROR constant returned by the PARSE-STATUS attribute, which in 4GL is the integer value 4.
static int	SAX_RUNNING The SAX-RUNNING constant returned by the PARSE-STATUS attribute, which in 4GL is the integer value 2.
static int	SAX_UNINITIALIZED The SAX-UNINITIALIZE constant returned by the PARSE-STATUS attribute, which in 4GL is the integer value 1.

Method Summary

Modifier and Type	Method and Description
handle	getHandler() Gets the value of the handler attribute for the given SAX Reader object.
integer	getLocatorColumnNumber() Gets the value of the current 1-based column in XML source.
integer	getLocatorLineNumber() Gets the value of the current 1-based line number in XML source.
character	getLocatorPublicId() Gets the current value of the public identifier of the current XML source.
character	getLocatorSystemId() Gets the current value of the system identifier of the current XML source.
integer	getParseStatus() Gets the current value of the parse status.
logical	getValidationEnabled() Indicates if the parser validates the XML document against DTD or not.
void	saxParse() Executing single call parse of an XML document associated with a SAX-Reader object.
void	saxParseFirst() Initializes and begins progressive-scan parse of an XML document associated with a SAX-Reader object.
void	saxParseNext() Continues progressive-scan parse of an XML document associated with a SAX-Reader object.
void	setHandler(handle hCallback) Sets the value of the handler attribute for the given SAX Reader object.
logical	setInputSource(character mode, java.lang.Object source) Specifies the input source of the XML document to be parsed by a SAX-Reader object.
logical	setInputSource(java.lang.String mode, java.lang.Object source) Specifies the input source of the XML document to be parsed by a SAX-Reader object.
void	setSchemaLocation(java.lang.String location) Sets the current value of the namespace location pair mapping.
void	setSchemaPath(java.lang.String path) Sets the delimiter separated list of directory paths used to locate XML DTD associated with a particular XML document.
void	setValidationEnabled(boolean enable) Redefines whether the parser will validate the XML document against DTD or not.
void	setValidationEnabled(logical enable) Redefines whether the parser will validate the XML document against DTD or not.
logical	stopParsing() Causes parser to stop parsing the XML document.

Methods inherited from interface com.goldencode.p2j.xml.SaxEntity

insertAttribute, insertAttribute, insertAttribute, insertAttribute, insertAttribute, insertAttribute, insertAttribute, insertAttribute, insertAttribute, insertAttribute, insertAttribute, insertAttribute

Methods inherited from interface com.goldencode.p2j.xml.XCommon

addSchemaLocation, addSchemaLocation, addSchemaLocation, addSchemaLocation, getNonamespaceSchemaLocation, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, setNonamespaceSchemaLocation, setNonamespaceSchemaLocation

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Methods inherited from interface com.goldencode.p2j.util.UniqueID

getUniqueID

Methods inherited from interface com.goldencode.p2j.util.ADMData

getADMData, setADMData, setADMData

Methods inherited from interface com.goldencode.p2j.xml.XmlSchema

getEntityExpansionLimit, getSchemaLocation, getSchemaPath, getStrictEntityResolution, getSuppressNamespaceProcessing, setEntityExpansionLimit, setEntityExpansionLimit, setSchemaLocation, setSchemaPath, setStrictEntityResolution, setStrictEntityResolution, setSuppressNamespaceProcessing, setSuppressNamespaceProcessing

Field Detail

SAX_UNINITIALIZED

static final int SAX_UNINITIALIZED

The SAX-UNINITIALIZE constant returned by the PARSE-STATUS attribute, which in 4GL is the integer value 1.

See Also:

Constant Field Values

SAX_RUNNING

static final int SAX_RUNNING

The SAX-RUNNING constant returned by the PARSE-STATUS attribute, which in 4GL is the integer value 2.

See Also:

Constant Field Values

SAX_COMPLETE

static final int SAX_COMPLETE

The SAX-COMPLETE constant returned by the PARSE-STATUS attribute, which in 4GL is the integer value 3.

See Also:

Constant Field Values

SAX_PARSER_ERROR

static final int SAX_PARSER_ERROR

The SAX-PARSER-ERROR constant returned by the PARSE-STATUS attribute, which in 4GL is the integer value 4.

See Also:

Constant Field Values

Method Detail

getHandler

handle getHandler()

Gets the value of the handler attribute for the given SAX Reader object.

Returns:

The handle variable representing the handler attribute.

setHandler

void setHandler(handle hCallback)

Sets the value of the handler attribute for the given SAX Reader object.

Parameters:

hCallback - The handle of the new callback handler to be set for the handler attribute.

getLocatorColumnNumber

integer getLocatorColumnNumber()

Gets the value of the current 1-based column in XML source.

Returns:

The integer value of the current column.

getLocatorLineNumber

integer getLocatorLineNumber()

Gets the value of the current 1-based line number in XML source.

Returns:

The integer value of the current line.

getParseStatus

integer getParseStatus()

Gets the current value of the parse status. The default value is SaxReader.ReadStatus.SAX_UNINITIALIZED. The other returned values are SaxReader.ReadStatus.SAX_COMPLETE, SaxReader.ReadStatus.SAX_PARSER_ERROR or SaxReader.ReadStatus.SAX_RUNNING.

Returns:

The integer value representing the current status of the parse.

getLocatorPublicId

character getLocatorPublicId()

Gets the current value of the public identifier of the current XML source.

Returns:

The character value representing the current locator-public-id attribute.

getLocatorSystemId

character getLocatorSystemId()

Gets the current value of the system identifier of the current XML source.

Returns:

The character value representing the current locator-system-id attribute.

setSchemaLocation

void setSchemaLocation(java.lang.String location)

Sets the current value of the namespace location pair mapping.

Parameters:

location - The new value the current schema-location attribute.

setSchemaPath

void setSchemaPath(java.lang.String path)

Sets the delimiter separated list of directory paths used to locate XML DTD associated with a particular XML document.

Parameters:

path - The new value the current schema-path attribute.

getValidationEnabled

logical getValidationEnabled()

Indicates if the parser validates the XML document against DTD or not.

Returns:

The logical value representing the current validation-enabled attribute.

setValidationEnabled

void setValidationEnabled(logical enable)

Redefines whether the parser will validate the XML document against DTD or not.

Parameters:

enable - The new value the current validation-enabled attribute.

setValidationEnabled

void setValidationEnabled(boolean enable)

Redefines whether the parser will validate the XML document against DTD or not.

Parameters:

enable - The new value the current validation-enabled attribute.

saxParse

void saxParse()

Executing single call parse of an XML document associated with a SAX-Reader object.

saxParseFirst

void saxParseFirst()

Initializes and begins progressive-scan parse of an XML document associated with a SAX-Reader object.

saxParseNext

void saxParseNext()

Continues progressive-scan parse of an XML document associated with a SAX-Reader object.

setInputSource

logical setInputSource(java.lang.String mode,
                       java.lang.Object source)

Specifies the input source of the XML document to be parsed by a SAX-Reader object.

Parameters:

mode - The type of the object to process. Can be 'FILE', 'HANDLE', 'MEMPTR' or 'LONGCHAR'.

source - The appropriate object to process.

Returns:

The true in case of success false otherwise.

setInputSource

logical setInputSource(character mode,
                       java.lang.Object source)

Specifies the input source of the XML document to be parsed by a SAX-Reader object.

Parameters:

mode - The type of the object to process. Can be 'FILE', 'HANDLE', 'MEMPTR' or 'LONGCHAR'.

source - The appropriate object to process.

Returns:

The true in case of success false otherwise.

stopParsing

logical stopParsing()

Causes parser to stop parsing the XML document.

Returns:

The true in case of success false otherwise.