NAME
XML::Toolset::XMLDOM - Interface to XML::DOM toolset
SYNOPSIS
my $toolset = new XML::Toolset::XMLDOM(%options);
if ($doc = $toolset->validate_document($xml)) {
... Do stuff with $doc ...
} else {
print "Document is invalid\n";
}
DESCRIPTION
XML::Toolset::XMLDOM is an interface to the XMLDOM parser which can be used with the XML::Toolset module.
METHODS
- new(%options)
-
Returns a new XML::Toolset::XMLDOM instance using the specified options. (See OPTIONS below.)
- validate_document($xml)
-
Returns a true value if $xml could be successfully parsed, undef otherwise.
- last_error()
-
Returns the error from the last validate_document call. This is a hash ref with the following fields:
message
line
column
Note that the error gets cleared at the beginning of each
validate_document
call. - version()
-
Returns the version of the XML::DOM module that is installed
OPTIONS
XML::Toolset::XMLDOM takes the following options:
- validation
-
If this boolean value is true, the document will be validated during parsing. Otherwise it will only be checked for well-formedness. Defaults to true.
- schema_location
-
Since the XML document is supplied as a string, the toolset doesn't know the document's URI. If the document contains any components referenced using relative URI's, you'll need to set this option to the document's URI so that the toolset can retrieve them correctly.
ERROR REPORTING
When a call to validate_document fails to parse the document, the error may be retrieved using last_error.
On errors not related to the XML parsing, these methods will throw exceptions. Wrap calls with eval to catch them.
DEPENDENCIES
XML::DOM XML::XPATH
VERSION
$Revision: 1.21 $ on $Date: 2005/09/06 11:05:09 $ by $Author: johna $
AUTHOR
Nathan Carr, Colin Robertson
<cpan _at_ bbc _dot_ co _dot_ uk>
COPYRIGHT
(c) BBC 2005. This program is free software; you can redistribute it and/or modify it under the GNU GPL. See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt