QH::PKG::DBObjectSet Class Reference

The DBObjectSet class add features for control database object arrays. You will be able be get or remove multiple objects into database table. More...

#include <dbobjectset.h>

Inheritance diagram for QH::PKG::DBObjectSet:

Collaboration diagram for QH::PKG::DBObjectSet:

Public Member Functions
	DBObjectSet (const QString table)
PrepareResult	prepareInsertQuery (QSqlQuery &q, bool replace) const override final
	prepareInsertQuery This method should be prepare a query for insert object into database. You need to create a own insert sql query for this object into database. Override this method for insert item into database. By Default This method prepare a insert query using the data that returned from the variantMap method.
PrepareResult	prepareRemoveQuery (QSqlQuery &q) const override final
	prepareRemoveQuery This method should be prepare a query for remove this object from a database. Override this method for remove this item from database. The default implementation remove item from id or primaryKey for more information see DBObject::condition method.
PrepareResult	prepareSelectQuery (QSqlQuery &q) const override final
	prepareSelectQuery This method should be prepare a query for selected data. Override this method for get item from database. The default implementation generate default select:
PrepareResult	prepareUpdateQuery (QSqlQuery &q) const override final
	prepareUpdateQuery this method should be prepare a insert data query.
bool	isCached () const override final
	isCached This method sholud be return status of object. If this method return true then this object can be saved into cache of database. Override this method and set this value to false for composite objects (objects for which a select query can return several objects or an object that does not have a direct representation in the database but contains common characteristics of several objects).
bool	isBundle () const override final
	isBundle This method definef determines whether the object will be abstract (composite objects) or single object If this function return true then SqlDBWriter create only one object after invoked selectquery. And if the selectquery function return a list of more 1 elements then a method fromSqlRecord must be invoked for each all elements of list.
QString	primaryKey () const override
	primaryKey This method must be return the name of primary key of this object table. If you want to create data object without primary key just return empty string.
QString	table () const override
	table This method should be return name of the database table that should be contains objects with this type.
Public Member Functions inherited from QH::PKG::DBObject
	DBObject ()
	~DBObject () override
bool	isValid () const override
	isValid This method check current object to valid.
bool	isHaveAPrimaryKey () const
	isHaveAPrimaryKey This method return true if this object has a primary key. If you want to cache this database object then primary key must be not null.
virtual void	clear ()
	clear This method clear all data of database object. Override This method for remove or reset your own members of class.
virtual DBObject *	createDBObject () const =0
	createDBObject This method should be create a object with the some type as the object called this method. Example of override:
virtual bool	fromSqlRecord (const QSqlRecord &q)=0
	fromSqlRecord This method should be initialize this object from the executed sqlRecord. The Default implementation get general dbObject information ( id and table name ). Override This method for initialize this object from sql query.
DbAddress	dbAddress () const
	dbAddress This method return address of the database object. IF the object is not valid then this method return an invalid database address.
QString	toString () const override
virtual DBVariantMap	variantMap () const
	variantMap This method should be create a DBVariantMap implementation of this database object.
Public Member Functions inherited from QH::PKG::AbstractData
	~AbstractData () override
virtual unsigned short	cmd () const =0
	cmd - This is command of this object, (for generate cmd use macross QH_PACKAGE)
virtual QString	cmdString () const =0
	cmdString - This is command string of this object, (for generate cmd use macross QH_PACKAGE)
virtual bool	toPackage (Package &package, const DistVersion &reqVersion, unsigned int triggerHash=0) const
	toPackage This method convert this class object to the package. For more info see Package class.
QString	toString () const override
	toString - Return a string implementation for this object.
template<class C , class... Args>
C *	create (Args &&... args) const
	create - This is factory method for create a new object.
void	fromPakcage (const Package &pkg)
	fromPakcage - This method initialize the current object from a package class object.
Public Member Functions inherited from QH::StreamBase
	StreamBase ()
virtual	~StreamBase ()
bool	fromBytes (const QByteArray &data)
	fromBytes This method provide initialization of object from byte array.
QByteArray	toBytes () const
	toBytes This method convert a current object to bytes array.
bool	fromBase64 (const QString &data)
	fromBase64 This method provide initialization of object from the base64 string.
bool	fromBase64 (const QByteArray &data)
	fromBase64 This method provide initialization of object from the base64 string.
QByteArray	toBase64 () const
	toBase64 This method convert a current object to the base64 string.
template<class T >
T &	copy (const StreamBase &right)
	copy This is base copy method for all StreamBase structures. Default implementation it is copy from byteArray.
template<class T >
bool	compare (const T &right)
	compare This method compare array signatures of this and right objects.

Additional Inherited Members
Static Public Member Functions inherited from QH::PKG::AbstractData
static unsigned int	command ()
	command This static method that return glaball code of this object.
static QString	commandText ()
	commandText This method return text of package command
Protected Member Functions inherited from QH::PKG::DBObject
QDataStream &	fromStream (QDataStream &stream) override
	fromStream This method should be read all bytes from the stream object and full the current object.
QDataStream &	toStream (QDataStream &stream) const override
	fromStream This method should be write all members of the current object to the stream object.
virtual std::pair< QString, QMap< QString, QVariant > >	condition () const
	condition This method must to return a condition of the WHERE block of the sql query. This method using on default implementation of DBObject::prepareSelectQuery and DBObject::prepareRemoveQuery methods. The default implementation generate when block by map for more information see the variantMap nethod. Override this method for customize your select or delete query.
virtual QVariant	primaryValue () const
	primaryValue This method is wraper of DBAddress::id. If This object do not contains a id value then return invalid value.
bool	isInsertPrimaryKey () const
	isInsertPrimaryKey This method check primaryKeys type. If the primary key have a type MemberType::Insert then return true.
Protected Member Functions inherited from QH::PKG::AbstractData
	AbstractData ()
	AbstractData - Base constructor of this object.
Protected Member Functions inherited from QH::StreamBase
virtual int	parsingVersion () const
	parsingVersion this method return parsing version of Qt. By Default is 0 (last available parsing). see https://doc.qt.io/qt-6/qdatastream.html#Version-enum
virtual unsigned int	typeId () const
	typeId This method return id of type.

Detailed Description

The DBObjectSet class add features for control database object arrays. You will be able be get or remove multiple objects into database table.

For using This class override the DBObject::condition and DBObject::fromSqlRecord methods.

Definition at line 23 of file dbobjectset.h.

Constructor & Destructor Documentation

DBObjectSet()

QH::PKG::DBObjectSet::DBObjectSet

(

const QString

table

)

Definition at line 11 of file dbobjectset.cpp.

Here is the call graph for this function:

Member Function Documentation

isBundle()

bool QH::PKG::DBObjectSet::isBundle ( ) const

finaloverridevirtual

isBundle This method definef determines whether the object will be abstract (composite objects) or single object If this function return true then SqlDBWriter create only one object after invoked selectquery. And if the selectquery function return a list of more 1 elements then a method fromSqlRecord must be invoked for each all elements of list.

Returns

true if the object is a selection from a set of database object.

Reimplemented from QH::PKG::DBObject.

Definition at line 35 of file dbobjectset.cpp.

isCached()

bool QH::PKG::DBObjectSet::isCached ( ) const

finaloverridevirtual

isCached This method sholud be return status of object. If this method return true then this object can be saved into cache of database. Override this method and set this value to false for composite objects (objects for which a select query can return several objects or an object that does not have a direct representation in the database but contains common characteristics of several objects).

Returns

True if item in cache. The Default implementation check the primary key if this object and if primary key is valid then return true else return false.

Reimplemented from QH::PKG::DBObject.

Definition at line 31 of file dbobjectset.cpp.

prepareInsertQuery()

PrepareResult QH::PKG::DBObjectSet::prepareInsertQuery ( QSqlQuery &  q, bool  replace  ) const

finaloverridevirtual

prepareInsertQuery This method should be prepare a query for insert object into database. You need to create a own insert sql query for this object into database. Override this method for insert item into database. By Default This method prepare a insert query using the data that returned from the variantMap method.

Parameters

q	Thuis is query object.
replace	This option disable or enable replacing of exists objects.

Default insert query have a next template:

INSERT INTO %0(%1) VALUES (%3)

For more information see the DBObject::variantMap method.

Note

before creating a own object you need to create a own database structure.

Parameters

q	This is query object.

Returns

PrepareResult object with information about prepare results.

Example of overriding:

PrepareResult ExampleObject::prepareInsertQuery(QSqlQuery &q, replace) const {
 
    DBVariantMap map = variantMap();
 
 
    QString queryString = "INSERT INTO %0(%1) VALUES (%2) ";
 
 
    queryString = queryString.arg(table());
    QString tableInsertHeader = "";
    QString tableInsertValues = "";
 
    for (auto it = map.begin(); it != map.end(); ++it) {
 
        tableInsertHeader += it.key();
        tableInsertValues += ":" + it.key();
 
        if (it + 1 != map.end()) {
            tableInsertHeader += ", ";
            tableInsertValues += ", ";
        }
 
    }
 
    queryString = queryString.arg(tableInsertHeader);
    queryString = queryString.arg(tableInsertValues);
 
    if (q.prepare(queryString)) {
 
        for (auto it = map.begin(); it != map.end(); ++it) {
            q.bindValue(":" + it.key(), it.value().value);
        }
 
        return PrepareResult::Success;
    }
 
    return PrepareResult::Fail;
}

Note

If you want disable this method, just override it and return the PrepareResult::Disabled value.

Reimplemented from QH::PKG::DBObject.

Definition at line 15 of file dbobjectset.cpp.

prepareRemoveQuery()

PrepareResult QH::PKG::DBObjectSet::prepareRemoveQuery ( QSqlQuery &  q ) const

finaloverridevirtual

prepareRemoveQuery This method should be prepare a query for remove this object from a database. Override this method for remove this item from database. The default implementation remove item from id or primaryKey for more information see DBObject::condition method.

Parameters

q	This is query object.

Returns

PrepareResult object with information about prepare results.

Note

If you want disable this method just override it and return the PrepareResult::Disabled value.

Reimplemented from QH::PKG::DBObject.

Definition at line 19 of file dbobjectset.cpp.

Here is the call graph for this function:

prepareSelectQuery()

PrepareResult QH::PKG::DBObjectSet::prepareSelectQuery ( QSqlQuery &  q ) const

finaloverridevirtual

prepareSelectQuery This method should be prepare a query for selected data. Override this method for get item from database. The default implementation generate default select:

"select * from [table] where id=[id]".

This method create where block using the condition method. See DBObject::condition fr more information.

Parameters

q	This is query object.

Returns

PrepareResult object with information about prepare results.

Note

If you want disable this mehod just override it and return the PrepareResult::Disabled value.

Reimplemented from QH::PKG::DBObject.

Definition at line 23 of file dbobjectset.cpp.

Here is the call graph for this function:

prepareUpdateQuery()

PrepareResult QH::PKG::DBObjectSet::prepareUpdateQuery ( QSqlQuery &  q ) const

finaloverridevirtual

prepareUpdateQuery this method should be prepare a insert data query.

Bt Default This method generate query like this:

UPDATE value SET value = 2 WHERE id = 1

If you want to create a own insert query override this method.

Example of overriding this method:

PrepareResult prepareUpdateQuery(QSqlQuery& q) const {
    DBVariantMap map = variantMap();
 
    QString queryString = "UPDATE %0 SET %1 WHERE %2";
 
    queryString = queryString.arg(table());
    QString tableUpdateValues = "";
    QString tableUpdateRules = QString("%0 = :%0").
            arg(primaryKey());
 
    for (auto it = map.begin(); it != map.end(); ++it) {
        if (!(it.value().type & MemberType::Update)) {
            continue;
        }
 
        if (tableUpdateValues.size()) {
            tableUpdateValues += ", ";
        }
 
        tableUpdateValues += QString("%0= :%0").arg(it.key());
 
    }
 
    queryString = queryString.arg(tableUpdateValues);
    queryString = queryString.arg(tableUpdateRules);
 
    if (q.prepare(queryString)) {
 
        for (auto it = map.begin(); it != map.end(); ++it) {
            if (it.value().type != MemberType::InsertUpdate) {
                continue;
            }
 
            q.bindValue(":" + it.key(), it.value().value);
        }
 
        return PrepareResult::Success;
    }
 
    return PrepareResult::Fail;
}

Parameters

q	This is query object.

Returns

PrepareResult object with information about prepare results.

Reimplemented from QH::PKG::DBObject.

Definition at line 27 of file dbobjectset.cpp.

primaryKey()

QString QH::PKG::DBObjectSet::primaryKey ( ) const

overridevirtual

primaryKey This method must be return the name of primary key of this object table. If you want to create data object without primary key just return empty string.

Note

If you returned empty value then this method can not be prepare insert update and delete querys.

Returns

The primary key name.

Reimplemented from QH::PKG::DBObject.

Definition at line 39 of file dbobjectset.cpp.

table()

QString QH::PKG::DBObjectSet::table ( ) const

overridevirtual

table This method should be return name of the database table that should be contains objects with this type.

Returns

table name that contains object with this type.

Implements QH::PKG::DBObject.

Definition at line 43 of file dbobjectset.cpp.

Here is the caller graph for this function:

---

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

• src/public/packages/dbobjectset.h
• src/public/packages/dbobjectset.cpp