Class: DOMParser

The DOMParser Package provides an interface to the Document Object Model (DOM) XML parser. The DOM parser provides the ability to validate an XML document according to a Document Type Definition (DTD), to validate for well-formedness, support for namespaces. A set of methods configure various options for parsing and the ability to retrieve the DOMDocument node that represents the root node of the document.

INDEX_SIZE_ERR: If index or size is negative, or greater than the allowed value
DOMSTRING_SIZE_ERR: If the specified range of text does not fit into a DOMString
HIERARCHY_REQUEST_ERR: If any node is inserted somewhere it doesn't belong
WRONG_DOCUMENT_ERR: If a node is used in a different document than the one that created it (that doesn't support it)
INVALID_CHARACTER_ERR: If an invalid character is specified, such as in a name
NO_DATA_ALLOWED_ERR: If data is specified for a node which does not support data
NO_MODIFICATION_ALLOWED_ERR: If an attempt is made to modify an object where modifications are not allowed
NOT_FOUND_ERR: If an attempt was made to reference a node in a context where it does not exist
NOT_SUPPORTED_ERR: If the implementation does not support the type of object requested
INUSE_ATTRIBUTE_ERR: If an attempt is made to add an attribute that is already inuse elsewhere
INVALID_STATE_ERR: Introduced in DOM Level 2. If an attempt is made to use an object that is not, or no longer, usable
SYNTAX_ERR: Introduced in DOM Level 2. If an invalid or illegal string is specified.
INVALID_MODIFICATION_ERR: Introduced in DOM Level 2. If an attempt is made to modify the type of the underlying object.
NAMESPACE_ERR: Introduced in DOM Level 2. If an attempt is made to create or change an object in a way which is incorrect with regard to namespaces.
INVALID_ACCESS_ERR: Introduced in DOM Level 2. If a parameter or an operation is not supported by the underlying object.
UNKNOWN_EXCEPTION: Exception thrown that does not correspond to any of the known DOM exceptions.
Message: Informational status or message.
Warning: Warning message.
Error: Recoverable error.
FatalError: Error that will stop processing.
Val_Never: Validation scheme - never validate.
Val_Always: Validation scheme - always validate.
Val_Auto: Validation scheme - automatically validate (default).

New(): Create a new DOMParser instance.

Parse( String xmlFile ): Parse an XML file into a DOM representation.
ParseBytes( Bytes xmlData ): Parse an XML bytes array into a DOM representation.
GetDocument(): Retrieves the Document node of the parsed document.
GetErrorCount(): Retrieves the error count for the parsed document.
SetDoValidation( Boolean arg1 ): Determines whether the XML document should be validated against the Document Type Definition (DTD).
GetDoNamespaces( ): Return whether support for XML Namespaces should be enabled.
SetDoNamespaces( Boolean arg1 ): Determines whether support for XML Namespaces should be enabled.
SetExpandEntityReferences( Boolean arg1 ): Determines whether Entities should be expanded when parsed.
SetEntityResolver( Dynamic objref, Dynamic entryName ): Sets the object reference and entry point name for the resolve entity reference callback.
GetExitOnFirstFatalError( ): Return whether parsing should exit with the first fatal error.
SetExitOnFirstFatalError( Boolean arg1 ): Determines whether parsing should exit with the first fatal error.
GetValidationConstraintFatal( ): Return whether the parser will treat a validation constraint error as a fatal error.
SetValidationConstraintFatal( Boolean arg1 ): Determines whether the parser will treat a validation constraint error as a fatal error.
GetCreateEntityReferenceNodes( ): Return whether the parser will create entity reference nodes.
SetCreateEntityReferenceNodes( Boolean arg1 ): Determines whether the parser will create entity reference nodes.
GetIncludeIgnorableWhitespace( ): Return whether the parser should include ignorable whitespace.
SetIncludeIgnorableWhitespace( Boolean arg1 ): Determines whether the parser should include ignorable whitespace.
GetValidationScheme( ): Return the parser validation scheme.
SetValidationScheme( Integer arg1 ): Determines the parser validation scheme.
GetDoSchema( ): Return whether the parser will process schema.
SetDoSchema( Boolean arg1 ): Determines whether the parser will process schema.
GetValidationSchemaFullChecking( ): Return whether the parser will perform full schema validation.
SetValidationSchemaFullChecking( Boolean arg1 ): Determines whether the parser will perform full schema validation.
GetExternalSchemaLocation( ): Return the location for external schema.
SetExternalSchemaLocation( String arg1 ): Provide the location for external schema.
GetExternalNoNamespaceSchemaLocation( ): Return the location for external no namespace schema.
SetExternalNoNamespaceSchemaLocation( String arg1 ): Provide the location for external no namespace schema.
GetLoadExternalDTD( ): Return whether the parser will try and load external DTD.
SetLoadExternalDTD( Boolean arg1 ): Determines whether the parser will try and load external DTD.
GetCreateCommentNodes( ): Return whether the parser will create comment nodes.
SetCreateCommentNodes( Boolean arg1 ): Determines whether the parser will create comment nodes.

INDEX_SIZE_ERR

 Integer INDEX_SIZE_ERR

If index or size is negative, or greater than the allowed value

DOMSTRING_SIZE_ERR

 Integer DOMSTRING_SIZE_ERR

If the specified range of text does not fit into a DOMString

HIERARCHY_REQUEST_ERR

 Integer HIERARCHY_REQUEST_ERR

If any node is inserted somewhere it doesn't belong

WRONG_DOCUMENT_ERR

 Integer WRONG_DOCUMENT_ERR

If a node is used in a different document than the one that created it (that doesn't support it)

INVALID_CHARACTER_ERR

 Integer INVALID_CHARACTER_ERR

If an invalid character is specified, such as in a name

NO_DATA_ALLOWED_ERR

 Integer NO_DATA_ALLOWED_ERR

If data is specified for a node which does not support data

NO_MODIFICATION_ALLOWED_ERR

 Integer NO_MODIFICATION_ALLOWED_ERR

If an attempt is made to modify an object where modifications are not allowed

NOT_FOUND_ERR

 Integer NOT_FOUND_ERR

If an attempt was made to reference a node in a context where it does not exist

NOT_SUPPORTED_ERR

 Integer NOT_SUPPORTED_ERR

If the implementation does not support the type of object requested

INUSE_ATTRIBUTE_ERR

 Integer INUSE_ATTRIBUTE_ERR

If an attempt is made to add an attribute that is already inuse elsewhere

INVALID_STATE_ERR

 Integer INVALID_STATE_ERR

Introduced in DOM Level 2. If an attempt is made to use an object that is not, or no longer, usable

SYNTAX_ERR

 Integer SYNTAX_ERR

Introduced in DOM Level 2. If an invalid or illegal string is specified.

INVALID_MODIFICATION_ERR

 Integer INVALID_MODIFICATION_ERR

Introduced in DOM Level 2. If an attempt is made to modify the type of the underlying object.

NAMESPACE_ERR

 Integer NAMESPACE_ERR

Introduced in DOM Level 2. If an attempt is made to create or change an object in a way which is incorrect with regard to namespaces.

INVALID_ACCESS_ERR

 Integer INVALID_ACCESS_ERR

Introduced in DOM Level 2. If a parameter or an operation is not supported by the underlying object.

UNKNOWN_EXCEPTION

 Integer UNKNOWN_EXCEPTION

Exception thrown that does not correspond to any of the known DOM exceptions.

Message

 Integer Message

Informational status or message.

Warning

 Integer Warning

Warning message.

Error

 Integer Error

Recoverable error.

FatalError

 Integer FatalError

Error that will stop processing.

Val_Never

 Integer Val_Never

Validation scheme - never validate. See SetValidationScheme.

Val_Always

 Integer Val_Always

Validation scheme - always validate. See SetValidationScheme.

Val_Auto

 Integer Val_Auto

Validation scheme - automatically validate (default). See SetValidationScheme.

New

 DOMParser New()

Create a new DOMParser instance.

Returns:: A new DOMParser.

Parse

 Assoc Parse(
          String xmlFile )

Parse an XML file into a DOM representation.

Parameters:

xmlFile

XML file to be parsed.

Returns:

An Assoc that contains:

Boolean		OK	-	Status of the parse.
RecArray		Error	-	Errors that occurred during parsing.

If the status of the parse is false, then the error RecArray contains:

String	ErrType	-	The type of error: warning, error or fatal.
String	ErrMsg	-	Parser generated error message.
String	PublicID	-	Public Identifier of the XML file, filename in this instance.
String	SystemId	-	System Identifier of the XML file, usually empty.
Integer	LineNumber	-	Line number in the file in which the error occurred.
Integer	ColumnNumber	-	Column number in the file in which the error occurred.

ParseBytes

 Assoc ParseBytes(
          Bytes xmlData )

Parse an XML bytes array into a DOM representation.

Parameters:

xmlData

XML bytes array to be parsed.

Returns:

An Assoc that contains:

Boolean		OK	-	Status of the parse.
RecArray		Error	-	Errors that occurred during parsing.

If the status of the parse is false, then the error RecArray contains information like that described in the Parse instance method.

GetDocument

 DOMDocument GetDocument()

Retrieves the Document node of the parsed document.

Returns:: The Document node.

GetErrorCount

 Integer GetErrorCount()

Retrieves the number of parse errors associated with the parsed document.

Returns:: An Integer of the number of errors.

SetDoValidation

 Void SetDoValidation(
              Boolean newState )

Determines whether the XML document should be validated against the Document Type Definition (DTD). This method has been DEPRECATED and is replaced with SetValidationScheme

Parameters:

newState

TRUE if the XML document should be validated against the DTD.

GetDoNamespaces

 Boolean GetDoNamespaces()

Returns whether parser support for XML Namespaces is enabled.

Returns:: Returns TRUE if parser support for XML Namespaces is enabled, FALSE otherwise.

SetDoNamespaces

 Void SetDoNamespaces(
              Boolean newState )

Determines whether support for XML Namespaces should be enabled.

Parameters:

newState

TRUE if namespaces should be enabled.

SetExpandEntityReferences

 Void SetExpandEntityReferences(
                   Boolean newState )

Determines whether Entities should be expanded when parsed. This method has been DEPRECATED, and is replaced with SetCreateEntityReferenceNodes

Parameters:

newState

TRUE if entities should be expanded when parsed.

SetEntityResolver

 Void SetEntityResolver(
             Dynamic objref,
             Dynamic entryName )

Sets the object reference and entry point name for the resolve entity callback.

The callback script prototype is:

String ResolveEntity( String publicID, String systemID )

The return value is a string to the resolved entity. An undefined return value indicates to the parser that it should use its default internal entity resolution.

Parameters:

objref	-	The reference to the object that has the script to be used in the callback.
entryName	-	The script name of the callback that will be executed on callback.

GetExitOnFirstFatalError

 Boolean GetExitOnFirstFatalError()

Returns whether parsing should exit with the first fatal error.

Returns:: Returns TRUE if parser should exit parsing when it encounters the the first fatal error, FALSE otherwise.

SetExitOnFirstFatalError

 Void SetExitOnFirstFatalError(
                   Boolean newState )

Determines whether parsing should exit with the first fatal error.

Parameters:

newState

TRUE if parsing should exit with the first fatal error.

GetValidationConstraintFatal

 Boolean GetValidationConstraintFatal()

Returns whether the parser will consider validation constraint errors as fatal.

Returns:: Returns TRUE, if the parser is currently configured to consider validation constraint errors as fatal, FALSE otherwise.

SetValidationConstraintFatal

 Void SetValidationConstraintFatal(
                   Boolean newState )

Determines whether the parser should consider validation constraint errors as fatal errors.

Parameters:

newState

TRUE, if the parser should consider validation constraint errors as fatal errors, FALSE otherwise.

GetCreateEntityReferenceNodes

 Boolean GetCreateEntityReferenceNodes()

Returns whether the parser will expand/create entity references when parsed.

Returns:: Returns TRUE, if the parser will expand/create entities, FALSE otherwise.

SetCreateEntityReferenceNodes

 Void SetCreateEntityReferenceNodes(
                   Boolean newState )

Determines whether the parser should expand/create entity references.

Parameters:

newState

TRUE, if the parser should expand/create entity references, FALSE otherwise.

GetIncludeIgnorableWhitespace

 Boolean GetIncludeIgnorableWhitespace()

Returns whether parsed text nodes that can be considered ignorable whitespace are included in the DOM tree.

Returns:: Returns TRUE, if the parser will create text nodes for ignorable whitespace, FALSE otherwise.

SetIncludeIgnorableWhitespace

 Void SetIncludeIgnorableWhitespace(
                   Boolean newState )

Determines whether the parser will create text nodes for ignorable whitespace.

Parameters:

newState

TRUE, if the parser will create text nodes for ignorable whitespace, FALSE otherwise.

GetValidationScheme

 Integer GetValidationScheme()

Returns the parser validation scheme.

Returns:: Returns an Integer with one of the defined constant values: Val_Never or Val_Always or Val_Auto.

SetValidationScheme

 Void SetValidationScheme(
                   Integer scheme )

Determines parser validation scheme.

Parameters:

scheme

Val_Never The parser does not report validation errors.

Val_Always The parser will always report validation errors.

Val_Auto The parser will report validation errors only if a grammar is specified.

GetDoSchema

 Boolean GetDoSchema()

Returns whether the parser's schema support is enabled.

Returns:: Returns TRUE, if the parser's schema support is enabled, FALSE otherwise.

SetDoSchema

 Void SetDoSchema(
                   Boolean newState )

Determines whether the parser's schema support is enabled.

Parameters:

newState

TRUE, to enable the parser's schema support. FALSE, to disable the parser's schema support.

GetValidationSchemaFullChecking

 Boolean GetValidationSchemaFullChecking()

Returns whether the parser will perform full schema constraint checking.

Returns:: Returns TRUE, if the parser will perform full schema constraint checking, FALSE otherwise.

SetValidationSchemaFullChecking

 Void SetValidationSchemaFullChecking(
                   Boolean newState )

Determines whether the parser will perform checks on the schema grammar itself for additional errors. These additional checks could be time-consuming or memory intensive. The default is FALSE.

Parameters:

newState

TRUE, enable full schema constraint checking.

FALSE, disable full schema constraint checking.

GetExternalSchemaLocation

 String GetExternalSchemaLocation()

Returns the previously specified list of schemas to use.

Returns:: Returns a string containing the list of schemas to use that was previously set with SetExternalSchemaLocation.

SetExternalSchemaLocation

 Void SetExternalSchemaLocation(
                   String schemaList )

Set a list of schemas to use. The targetNamespace of a schema specified in this list will override the internal schema location in the instance document for both the schemaLocation attribute, or the "import" element.

Parameters:

schemaList

The syntax is the same as for schemaLocation attributes in an instance document: e.g, "http://www.schemas.com sample.xsd". The user can specify more than one XML schema in the list.

GetExternalNoNamespaceSchemaLocation

 String GetExternalNoNamespaceSchemaLocation()

Returns the previously specified no target namespace XML schema location.

Returns:: Returns a string containing the no target namespace XML schema location that was previously set with SetExternalNoNamespaceSchemaLocation.

SetExternalSchemaLocation

 Void SetExternalSchemaLocation(
                   String location )

Provide the no target namespace XML schema location.

Parameters:

location

The syntax is the same as for the noNamespaceSchemaLocation attribute in an instance document: e.g, "sample.xsd".

GetLoadExternalDTD

 Boolean GetLoadExternalDTD()

Returns whether the parser will load external DTD when the validation scheme is Val_Never.

Returns:: Returns TRUE, if the loading of external DTD is enabled, FALSE otherwise.

SetLoadExternalDTD

 Void SetLoadExternalDTD(
                   Boolean newState )

Determines whether the parser will load external DTD when the validation scheme is Val_Never. This flag is ignored if the validation scheme is set (see SetValidationScheme) to Val_Always or Val_Auto.

Parameters:

newState

FALSE, parser will ignore any external DTD completely when the validation scheme is Val_Never. TRUE, otherwise (default).

GetCreateCommentNodes

 Boolean GetCreateCommentNodes()

Returns whether the parser will create comment nodes in the DOM tree.

Returns:: Returns TRUE, the parser will create comment nodes in the DOM tree, FALSE otherwise.

SetCreateCommentNodes

 Void SetCreateCommentNodes(
                   Boolean newState )