QXmlSchemaValidator Class Reference

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

#include <qxmlschemavalidator.h>

Public Functions
QAbstractMessageHandler *	messageHandler () const
	Returns the message handler that handles parsing and validation messages for this QXmlSchemaValidator. More...
QXmlNamePool	namePool () const
	Returns the name pool used by this QXmlSchemaValidator for constructing QXmlName {names}. More...
QNetworkAccessManager *	networkAccessManager () const
	Returns the network manager, or 0 if it has not been set. More...
	QXmlSchemaValidator ()
	Constructs a schema validator. More...
	QXmlSchemaValidator (const QXmlSchema &schema)
	Constructs a schema validator that will use schema for validation. More...
QXmlSchema	schema () const
	Returns the schema that is used for validation. More...
void	setMessageHandler (QAbstractMessageHandler *handler)
	Changes the QAbstractMessageHandler{message handler} for this QXmlSchemaValidator to handler. More...
void	setNetworkAccessManager (QNetworkAccessManager *networkmanager)
	Sets the network manager to manager. More...
void	setSchema (const QXmlSchema &schema)
	Sets the schema that shall be used for further validation. More...
void	setUriResolver (const QAbstractUriResolver *resolver)
	Sets the URI resolver to resolver. More...
const QAbstractUriResolver *	uriResolver () const
	Returns the schema's URI resolver. More...
bool	validate (const QUrl &source) const
	Validates the XML instance document read from source against the schema. More...
bool	validate (QIODevice *source, const QUrl &documentUri=QUrl()) const
	Validates the XML instance document read from source with the given documentUri against the schema. More...
bool	validate (const QByteArray &data, const QUrl &documentUri=QUrl()) const
	Validates the XML instance document read from data with the given documentUri against the schema. More...
	~QXmlSchemaValidator ()
	Destroys this QXmlSchemaValidator. More...

Properties
QXmlSchemaValidatorPrivate *const	d

Detailed Description

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

Note

This class or function is reentrant.

Since

4.6

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";
    }

XML Schema Version

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

See also

QXmlSchema, {xmlpatterns/schema}{XML Schema Validation Example}

Definition at line 62 of file qxmlschemavalidator.h.

Constructors and Destructors

QXmlSchemaValidator() [1/2]

QXmlSchemaValidator::QXmlSchemaValidator

(

)

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.

Definition at line 90 of file qxmlschemavalidator.cpp.

    : d(new QXmlSchemaValidatorPrivate(QXmlSchema()))
{
}

QXmlSchemaValidator() [2/2]

QXmlSchemaValidator::QXmlSchemaValidator

(

const 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.

Definition at line 101 of file qxmlschemavalidator.cpp.

    : d(new QXmlSchemaValidatorPrivate(schema))
{
}

~QXmlSchemaValidator()

QXmlSchemaValidator::~QXmlSchemaValidator

(

)

Destroys this QXmlSchemaValidator.

Definition at line 109 of file qxmlschemavalidator.cpp.

{
    delete d;
}

Functions

messageHandler()

QAbstractMessageHandler * QXmlSchemaValidator::messageHandler

(

)

const

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

Definition at line 290 of file qxmlschemavalidator.cpp.

Referenced by validate().

{
    if (d->m_userMessageHandler)
        return d->m_userMessageHandler;

    return d->m_messageHandler.data()->value;
}

namePool()

QXmlNamePool QXmlSchemaValidator::namePool

(

)

const

Returns the name pool used by this QXmlSchemaValidator for constructing QXmlName {names}.

There is no setter for the name pool, because mixing name pools causes errors due to name confusion.

Definition at line 233 of file qxmlschemavalidator.cpp.

{
    return d->m_namePool;
}

networkAccessManager()

QNetworkAccessManager * QXmlSchemaValidator::networkAccessManager

(

)

const

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

See also

setNetworkAccessManager()

Definition at line 344 of file qxmlschemavalidator.cpp.

Referenced by validate().

{
    if (d->m_userNetworkAccessManager)
        return d->m_userNetworkAccessManager;

    return d->m_networkAccessManager.data()->value;
}

schema()

QXmlSchema QXmlSchemaValidator::schema

(

)

const

Returns the schema that is used for validation.

Definition at line 241 of file qxmlschemavalidator.cpp.

{
    return d->m_originalSchema;
}

setMessageHandler()

void QXmlSchemaValidator::setMessageHandler

(

QAbstractMessageHandler *

handler

)

Changes the QAbstractMessageHandler{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:

message() argument	Semantics
QtMsgType type	Only QtWarningMsg and QtFatalMsg are used. The former identifies a warning, while the latter identifies an error.
const QString & description	An XHTML document which is the actual message. It is translated into the current language.
const QUrl &identifier	Identifies the error with a URI, where the fragment is the error code, and the rest of the URI is the error namespace.
const QSourceLocation & sourceLocation	Identifies where the error occurred.

Definition at line 281 of file qxmlschemavalidator.cpp.

{
    d->m_userMessageHandler = handler;
}

setNetworkAccessManager()

void QXmlSchemaValidator::setNetworkAccessManager

(

QNetworkAccessManager *

manager

)

Sets the network manager to manager.

QXmlSchemaValidator does not take ownership of manager.

See also

networkAccessManager()

Definition at line 334 of file qxmlschemavalidator.cpp.

{
    d->m_userNetworkAccessManager = manager;
}

setSchema()

void QXmlSchemaValidator::setSchema

(

const 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.

Definition at line 120 of file qxmlschemavalidator.cpp.

{
    d->setSchema(schema);
}

setUriResolver()

void QXmlSchemaValidator::setUriResolver

(

const QAbstractUriResolver *

resolver

)

Sets the URI resolver to resolver.

QXmlSchemaValidator does not take ownership of resolver.

See also

uriResolver()

Definition at line 304 of file qxmlschemavalidator.cpp.

{
    d->m_uriResolver = resolver;
}

uriResolver()

const QAbstractUriResolver * QXmlSchemaValidator::uriResolver

(

)

const

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()

Definition at line 323 of file qxmlschemavalidator.cpp.

Referenced by validate().

{
    return d->m_uriResolver;
}

validate() [1/3]

bool QXmlSchemaValidator::validate

(

const QUrl &

source

)

const

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";

Definition at line 156 of file qxmlschemavalidator.cpp.

Referenced by validate().

{
    d->m_context->setMessageHandler(messageHandler());
    d->m_context->setUriResolver(uriResolver());
    d->m_context->setNetworkAccessManager(networkAccessManager());

    const QPatternist::AutoPtr<QNetworkReply> reply(QPatternist::AccelTreeResourceLoader::load(source, d->m_context->networkAccessManager(),
                                                                                               d->m_context, QPatternist::AccelTreeResourceLoader::ContinueOnError));
    if (reply)
        return validate(reply.data(), source);
    else
        return false;
}

validate() [2/3]

bool QXmlSchemaValidator::validate	(	QIODevice *	source,
		const QUrl &	documentUri = QUrl()
	)		const

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";

Definition at line 181 of file qxmlschemavalidator.cpp.

{
    if (!source) {
        qWarning("A null QIODevice pointer cannot be passed.");
        return false;
    }

    if (!source->isReadable()) {
        qWarning("The device must be readable.");
        return false;
    }

    const QUrl normalizedUri = QPatternist::XPathHelper::normalizeQueryURI(documentUri);

    d->m_context->setMessageHandler(messageHandler());
    d->m_context->setUriResolver(uriResolver());
    d->m_context->setNetworkAccessManager(networkAccessManager());

    QPatternist::NetworkAccessDelegator::Ptr delegator(new QPatternist::NetworkAccessDelegator(d->m_context->networkAccessManager(),
                                                                                               d->m_context->networkAccessManager()));

    QPatternist::AccelTreeResourceLoader loader(d->m_context->namePool(), delegator, QPatternist::AccelTreeBuilder<true>::SourceLocationsFeature);

    QPatternist::Item item;
    try {
        item = loader.openDocument(source, normalizedUri, d->m_context);
    } catch (QPatternist::Exception exception) {
        Q_UNUSED(exception);
        return false;
    }

    const QAbstractXmlNodeModel *model = item.asNode().model();

    QPatternist::XsdValidatedXmlNodeModel *validatedModel = new QPatternist::XsdValidatedXmlNodeModel(model);

    QPatternist::XsdValidatingInstanceReader reader(validatedModel, normalizedUri, d->m_context);
    if (d->m_schema)
        reader.addSchema(d->m_schema, d->m_schemaDocumentUri);
    try {
        reader.read();
    } catch (QPatternist::Exception exception) {
        Q_UNUSED(exception);
        return false;
    }

    return true;
}

validate() [3/3]

bool QXmlSchemaValidator::validate	(	const QByteArray &	data,
		const QUrl &	documentUri = QUrl()
	)		const

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";

Definition at line 136 of file qxmlschemavalidator.cpp.

{
    QByteArray localData(data);

    QBuffer buffer(&localData);
    buffer.open(QIODevice::ReadOnly);

    return validate(&buffer, documentUri);
}

Properties

d

QXmlSchemaValidatorPrivate* const QXmlSchemaValidator::d

private

Definition at line 88 of file qxmlschemavalidator.h.

Referenced by messageHandler(), namePool(), networkAccessManager(), schema(), setMessageHandler(), setNetworkAccessManager(), setSchema(), setUriResolver(), uriResolver(), validate(), and ~QXmlSchemaValidator().

---

The documentation for this class was generated from the following files:

• /src/xmlpatterns/api/qxmlschemavalidator.h
• /src/xmlpatterns/api/qxmlschemavalidator.cpp