Home · All Classes · Modules

QXmlSchemaValidator Class Reference
^{[QtXmlPatterns module]}

The QXmlSchemaValidator class validates XML instance documents against a W3C XML Schema. More...

Methods

• __init__ (self)
• __init__ (self, QXmlSchema schema)
• QAbstractMessageHandler messageHandler (self)
• QXmlNamePool namePool (self)
• QNetworkAccessManager networkAccessManager (self)
• QXmlSchema schema (self)
• setMessageHandler (self, QAbstractMessageHandler handler)
• setNetworkAccessManager (self, QNetworkAccessManager networkmanager)
• setSchema (self, QXmlSchema schema)
• setUriResolver (self, QAbstractUriResolver resolver)
• QAbstractUriResolver uriResolver (self)
• bool validate (self, QUrl source)
• bool validate (self, QIODevice source, QUrl documentUri = QUrl())
• bool validate (self, QByteArray data, QUrl documentUri = QUrl())

The QXmlSchemaValidator class loads, parses an XML instance document and validates it against a W3C XML Schema that has been compiled with QXmlSchema.

The following example shows how to load a XML Schema from a local file, check whether it is a valid schema document and use it for validation of an XML instance document:

     QUrl schemaUrl("file:///home/user/schema.xsd");

     QXmlSchema schema;
     schema.load(schemaUrl);

     if (schema.isValid()) {
         QFile file("test.xml");
         file.open(QIODevice.ReadOnly);

         QXmlSchemaValidator validator(schema);
         if (validator.validate(&file, QUrl.fromLocalFile(file.fileName())))
             qDebug() << "instance document is valid";
         else
             qDebug() << "instance document is invalid";
     }

This class implements schema validation according to the XML Schema 1.0 specification.

Method Documentation

QXmlSchemaValidator.__init__ (self)

Constructs a schema validator. The schema used for validation must be referenced in the XML instance document via the xsi:schemaLocation or xsi:noNamespaceSchemaLocation attribute.

QXmlSchemaValidator.__init__ (self, QXmlSchema schema)

Constructs a schema validator that will use schema for validation. If an empty QXmlSchema schema is passed to the validator, the schema used for validation must be referenced in the XML instance document via the xsi:schemaLocation or xsi:noNamespaceSchemaLocation attribute.

QAbstractMessageHandler QXmlSchemaValidator.messageHandler (self)

Returns the message handler that handles parsing and validation messages for this QXmlSchemaValidator.

See also setMessageHandler().

QXmlNamePool QXmlSchemaValidator.namePool (self)

Returns the name pool used by this QXmlSchemaValidator for constructing names. There is no setter for the name pool, because mixing name pools causes errors due to name confusion.

QNetworkAccessManager QXmlSchemaValidator.networkAccessManager (self)

Returns the network manager, or 0 if it has not been set.

See also setNetworkAccessManager().

QXmlSchema QXmlSchemaValidator.schema (self)

Returns the schema that is used for validation.

See also setSchema().

QXmlSchemaValidator.setMessageHandler (self, QAbstractMessageHandler handler)

Changes the message handler for this QXmlSchemaValidator to handler. The schema validator sends all parsing and validation messages to this message handler. QXmlSchemaValidator does not take ownership of handler.

Normally, the default message handler is sufficient. It writes compile and validation messages to stderr. The default message handler includes color codes if stderr can render colors.

When QXmlSchemaValidator calls QAbstractMessageHandler.message(), the arguments are as follows:

See also messageHandler().

QXmlSchemaValidator.setNetworkAccessManager (self, QNetworkAccessManager networkmanager)

Sets the network manager to manager. QXmlSchemaValidator does not take ownership of manager.

See also networkAccessManager().

QXmlSchemaValidator.setSchema (self, QXmlSchema schema)

Sets the schema that shall be used for further validation. If the schema is empty, the schema used for validation must be referenced in the XML instance document via the xsi:schemaLocation or xsi:noNamespaceSchemaLocation attribute.

See also schema().

QXmlSchemaValidator.setUriResolver (self, QAbstractUriResolver resolver)

Sets the URI resolver to resolver. QXmlSchemaValidator does not take ownership of resolver.

See also uriResolver().

QAbstractUriResolver QXmlSchemaValidator.uriResolver (self)

Returns the schema's URI resolver. If no URI resolver has been set, QtXmlPatterns will use the URIs in instance documents as they are.

The URI resolver provides a level of abstraction, or polymorphic URIs. A resolver can rewrite logical URIs to physical ones, or it can translate obsolete or invalid URIs to valid ones.

When QtXmlPatterns calls QAbstractUriResolver.resolve() the absolute URI is the URI mandated by the schema specification, and the relative URI is the URI specified by the user.

See also setUriResolver().

bool QXmlSchemaValidator.validate (self, QUrl source)

Validates the XML instance document read from source against the schema.

Returns true if the XML instance document is valid according to the schema, false otherwise.

Example:

     const QXmlSchema schema = getSchema();

     const QUrl url("http://www.schema-example.org/test.xml");

     QXmlSchemaValidator validator(schema);
     if (validator.validate(url))
         qDebug() << "instance document is valid";
     else
         qDebug() << "instance document is invalid";

bool QXmlSchemaValidator.validate (self, QIODevice source, QUrl documentUri = QUrl())

Validates the XML instance document read from source with the given documentUri against the schema.

Returns true if the XML instance document is valid according to the schema, false otherwise.

Example:

     const QXmlSchema schema = getSchema();

     QFile file("test.xml");
     file.open(QIODevice.ReadOnly);

     QXmlSchemaValidator validator(schema);
     if (validator.validate(&file, QUrl.fromLocalFile(file.fileName())))
         qDebug() << "instance document is valid";
     else
         qDebug() << "instance document is invalid";

bool QXmlSchemaValidator.validate (self, QByteArray data, QUrl documentUri = QUrl())

Validates the XML instance document read from data with the given documentUri against the schema.

Returns true if the XML instance document is valid according to the schema, false otherwise.

Example:

     const QXmlSchema schema = getSchema();

     QByteArray data("<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
                     "<test></test>");

     QBuffer buffer(&data);
     buffer.open(QIODevice.ReadOnly);

     QXmlSchemaValidator validator(schema);
     if (validator.validate(&buffer))
         qDebug() << "instance document is valid";
     else
         qDebug() << "instance document is invalid";