BaseLib::IO::XMLQtInterface Class Reference

Detailed Description

Definition at line 21 of file XMLQtInterface.h.

#include <XMLQtInterface.h>

Inheritance diagram for BaseLib::IO::XMLQtInterface:

Public Member Functions
	XMLQtInterface (QString schemaFile="")
virtual	~XMLQtInterface ()=default
virtual int	readFile (const QString &fileName)

Protected Member Functions
bool	checkHash () const
QByteArray const &	getContent () const

Private Member Functions
int	isValid () const

Private Attributes
QString	fileName_
	The actual file name when reading.
QString	schemaFile_
QByteArray	fileData_
	Caches the actual file contents when reading.

Constructor & Destructor Documentation

XMLQtInterface()

BaseLib::IO::XMLQtInterface::XMLQtInterface ( QString schemaFile = "" )

explicit

Definition at line 23 of file XMLQtInterface.cpp.

    : schemaFile_(std::move(schemaFile))
{
}

References schemaFile_.

Referenced by GeoLib::IO::XmlGmlInterface::XmlGmlInterface(), FileIO::XmlPrjInterface::XmlPrjInterface(), and GeoLib::IO::XmlStnInterface::XmlStnInterface().

~XMLQtInterface()

virtual BaseLib::IO::XMLQtInterface::~XMLQtInterface ( )

virtualdefault

Member Function Documentation

checkHash()

bool BaseLib::IO::XMLQtInterface::checkHash ( ) const

protected

Checks if a hash for the given data file exists to skip the time-consuming validation part. If a hash file exists and the hash of the data file is the same as the content of the hash file the validation is skipped If no hash file exists, the xml-file is validated and a hash file is written if the xml-file was valid.

Definition at line 90 of file XMLQtInterface.cpp.

{
    QString md5FileName(fileName_ + ".md5");
    QByteArray fileHash =
        QCryptographicHash::hash(fileData_, QCryptographicHash::Md5);
 
    QFile file(md5FileName);
    if (file.open(QIODevice::ReadOnly))
    {
        QByteArray referenceHash = file.readAll();
        file.close();
        if (referenceHash == fileHash)
        {
            return true;
        }
        INFO("Hashfile does not match data ... checking file ...");
    }
 
    if (!this->isValid())
    {
        return false;
    }
 
    QFile fileMD5(md5FileName);
    if (fileMD5.open(QIODevice::WriteOnly))
    {
        fileMD5.write(fileHash);
        fileMD5.close();
        INFO("File is valid, hashfile written.");
    }
    else
    {
        WARN("File is valid but could not write hashfile!");
    }
    return true;
}

References fileData_, fileName_, INFO(), isValid(), and WARN().

Referenced by readFile().

getContent()

QByteArray const & BaseLib::IO::XMLQtInterface::getContent ( ) const

protected

Read access to the content of the read file. Must be used after readFile has been called.

Definition at line 127 of file XMLQtInterface.cpp.

{
    return fileData_;
}

References fileData_.

Referenced by FileIO::XmlPrjInterface::readFile(), GeoLib::IO::XmlGmlInterface::readFile(), and GeoLib::IO::XmlStnInterface::readFile().

isValid()

int BaseLib::IO::XMLQtInterface::isValid ( ) const

private

Check if the given xml-file is valid considering the schema-file used in the constructor

Definition at line 49 of file XMLQtInterface.cpp.

{
    QXmlSchema schema;
    if (schemaFile_.length() > 0)
    {
        auto path =
            QDir(QCoreApplication::applicationDirPath()).filePath(schemaFile_);
        auto url = QUrl::fromLocalFile(path);
        schema.load(url);
    }
    if (schema.isValid())
    {
        QXmlSchemaValidator validator(schema);
        if (validator.validate(fileData_))
        {
            return 1;
        }
 
        INFO(
            "XMLQtInterface::isValid(): XML file {:s} is invalid (in reference "
            "to schema {:s}).",
            fileName_.toStdString(), schemaFile_.toStdString());
    }
    else
    {
        // The following validator (without constructor arguments) automatically
        // searches for the xsd given in the xml file.
        QXmlSchemaValidator validator;
        if (validator.validate(fileData_))
        {
            return 1;
        }
 
        INFO(
            "XMLQtInterface::isValid(): XML file {:s} is invalid (in reference "
            "to its schema).",
            fileName_.toStdString());
    }
    return 0;
}

References fileData_, fileName_, INFO(), and schemaFile_.

Referenced by checkHash().

readFile()

int BaseLib::IO::XMLQtInterface::readFile ( const QString & fileName )

virtual

Reads the file. In an overridden function in the child class be sure to call XMLQtInterface::readFile(fileName).

Reimplemented in FileIO::XmlPrjInterface, GeoLib::IO::XmlGmlInterface, and GeoLib::IO::XmlStnInterface.

Definition at line 28 of file XMLQtInterface.cpp.

{
    fileName_ = fileName;
    QFile file(fileName);
    if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
    {
        ERR("XMLQtInterface::readFile(): Can't open xml-file {:s}.",
            fileName.toStdString());
        return 0;
    }
    fileData_ = file.readAll();
    file.close();
 
    if (!checkHash())
    {
        return 0;
    }
 
    return 1;
}

References checkHash(), ERR(), fileData_, and fileName_.

Member Data Documentation

fileData_

QByteArray BaseLib::IO::XMLQtInterface::fileData_

private

Caches the actual file contents when reading.

Definition at line 53 of file XMLQtInterface.h.

Referenced by checkHash(), getContent(), isValid(), and readFile().

fileName_

QString BaseLib::IO::XMLQtInterface::fileName_

private

The actual file name when reading.

Definition at line 48 of file XMLQtInterface.h.

Referenced by checkHash(), isValid(), and readFile().

schemaFile_

QString BaseLib::IO::XMLQtInterface::schemaFile_

private

Definition at line 50 of file XMLQtInterface.h.

Referenced by XMLQtInterface(), and isValid().

---

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

• XMLQtInterface.h
• XMLQtInterface.cpp