GncSqlTaxTableBackend Class Reference

Inheritance diagram for GncSqlTaxTableBackend:

Public Member Functions
void	load_all (GncSqlBackend *) override
	Load all objects of m_type in the database into memory.
void	create_tables (GncSqlBackend *) override
	Conditionally create or update a database table from m_col_table.
bool	commit (GncSqlBackend *sql_be, QofInstance *inst) override
	UPDATE/INSERT a single instance of m_type_name into the database.
bool	write (GncSqlBackend *) override
	Write all objects of m_type_name to the database.
Public Member Functions inherited from GncSqlObjectBackend
	GncSqlObjectBackend (int version, const std::string &type, const std::string &table, const EntryVec &vec)
const char *	type () const noexcept
	Return the m_type_name for the class.
const bool	is_version (int version) const noexcept
	Compare a version with the compiled version (m_version).
bool	instance_in_db (const GncSqlBackend *sql_be, QofInstance *inst) const noexcept
	Check the presence of an object in the backend's database.

Additional Inherited Members
Protected Attributes inherited from GncSqlObjectBackend
const std::string	m_table_name
const int	m_version
const std::string	m_type_name
const EntryVec &	m_col_table
	The front-end QofIdType.

Detailed Description

Definition at line 35 of file gnc-tax-table-sql.h.

Constructor & Destructor Documentation

GncSqlTaxTableBackend()

GncSqlTaxTableBackend::GncSqlTaxTableBackend

(

)

Definition at line 120 of file gnc-tax-table-sql.cpp.

                                             :
    GncSqlObjectBackend(TT_TABLE_VERSION, GNC_ID_TAXTABLE,
                        TT_TABLE_NAME, tt_col_table) {}

Member Function Documentation

commit()

bool GncSqlTaxTableBackend::commit ( GncSqlBackend *  sql_be, QofInstance *  inst  )

overridevirtual

UPDATE/INSERT a single instance of m_type_name into the database.

Parameters

sql_be	The GncSqlBackend containing the database.
inst	The QofInstance to be written out.

Reimplemented from GncSqlObjectBackend.

Definition at line 409 of file gnc-tax-table-sql.cpp.

{
    GncTaxTable* tt;
    const GncGUID* guid;
    E_DB_OPERATION op;
    gboolean is_infant;
    gboolean is_ok;
 
    g_return_val_if_fail (inst != NULL, FALSE);
    g_return_val_if_fail (GNC_IS_TAXTABLE (inst), FALSE);
    g_return_val_if_fail (sql_be != NULL, FALSE);
 
    tt = GNC_TAXTABLE (inst);
 
    is_infant = qof_instance_get_infant (inst);
    if (qof_instance_get_destroying (inst))
    {
        op = OP_DB_DELETE;
    }
    else if (sql_be->pristine() || is_infant)
    {
        op = OP_DB_INSERT;
    }
    else
    {
        op = OP_DB_UPDATE;
    }
    is_ok = sql_be->do_db_operation(op, TT_TABLE_NAME, GNC_ID_TAXTABLE, tt,
                                    tt_col_table);
 
    if (is_ok)
    {
        // Now, commit or delete any slots and tax table entries
        guid = qof_instance_get_guid (inst);
        if (!qof_instance_get_destroying (inst))
        {
            is_ok = gnc_sql_slots_save (sql_be, guid, is_infant, inst);
            if (is_ok)
            {
                is_ok = save_tt_entries (sql_be, guid, gncTaxTableGetEntries (tt));
            }
        }
        else
        {
            is_ok = gnc_sql_slots_delete (sql_be, guid);
            if (is_ok)
            {
                is_ok = delete_all_tt_entries (sql_be, guid);
            }
        }
    }
 
    return is_ok;
}

create_tables()

void GncSqlTaxTableBackend::create_tables ( GncSqlBackend *  sql_be )

overridevirtual

Conditionally create or update a database table from m_col_table.

The condition is the version returned by querying the database's version table: If it's 0 then the table wasn't found and will be created; All tables areat least version 1. If the database's version is less than the compiled version then the table schema is upgraded but the data isn't, that's the engine's responsibility when the object is loaded. If the version is greater than the compiled version then nothing is touched.

Parameters

sql_be

The GncSqlBackend containing the database connection.

Reimplemented from GncSqlObjectBackend.

Definition at line 334 of file gnc-tax-table-sql.cpp.

{
    gint version;
 
    g_return_if_fail (sql_be != NULL);
 
    version = sql_be->get_table_version( TT_TABLE_NAME);
    if (version == 0)
    {
        sql_be->create_table(TT_TABLE_NAME, TT_TABLE_VERSION, tt_col_table);
    }
    else if (version < m_version)
    {
        /* Upgrade 64 bit int handling */
        sql_be->upgrade_table(TT_TABLE_NAME, tt_col_table);
        sql_be->set_table_version (TT_TABLE_NAME, TT_TABLE_VERSION);
        PINFO ("Taxtables table upgraded from version 1 to version %d\n",
               TT_TABLE_VERSION);
    }
 
    version = sql_be->get_table_version( TTENTRIES_TABLE_NAME);
    if (version == 0)
    {
        sql_be->create_table(TTENTRIES_TABLE_NAME, TTENTRIES_TABLE_VERSION,
                              ttentries_col_table);
    }
    else if (version < TTENTRIES_TABLE_VERSION)
    {
        /* Upgrade 64 bit int handling */
        sql_be->upgrade_table(TTENTRIES_TABLE_NAME, ttentries_col_table);
        sql_be->set_table_version (TTENTRIES_TABLE_NAME, TTENTRIES_TABLE_VERSION);
        PINFO ("Taxtable entries table upgraded from version 1 to version %d\n",
               TTENTRIES_TABLE_VERSION);
    }
}

load_all()

void GncSqlTaxTableBackend::load_all ( GncSqlBackend *  sql_be )

overridevirtual

Load all objects of m_type in the database into memory.

Parameters

sql_be

The GncSqlBackend containing the database connection.

Implements GncSqlObjectBackend.

Definition at line 284 of file gnc-tax-table-sql.cpp.

{
    g_return_if_fail (sql_be != NULL);
 
    /* First time, create the query */
    std::stringstream sql;
    sql << "SELECT * FROM " << TT_TABLE_NAME;
    auto stmt = sql_be->create_statement_from_sql(sql.str());
    auto result = sql_be->execute_select_statement(stmt);
    TaxTblParentGuidVec tt_needing_parents;
 
    for (auto row : *result)
        load_single_taxtable (sql_be, row, tt_needing_parents);
 
    /* While there are items on the list of taxtables needing parents,
       try to see if the parent has now been loaded.  Theory says that if
       items are removed from the front and added to the back if the
       parent is still not available, then eventually, the list will
       shrink to size 0. */
    if (!tt_needing_parents.empty())
    {
        bool progress_made = true;
    std::reverse(tt_needing_parents.begin(),
             tt_needing_parents.end());
    auto end = tt_needing_parents.end();
        while (progress_made)
        {
            progress_made = false;
            end = std::remove_if(tt_needing_parents.begin(), end,
                 [&](TaxTblParentGuidPtr s)
                 {
                     auto pBook = qof_instance_get_book (QOF_INSTANCE (s->tt));
                     auto parent = gncTaxTableLookup (pBook,
                                      &s->guid);
                     if (parent != nullptr)
                     {
                     tt_set_parent (s->tt, &s->guid);
                     progress_made = true;
                     delete s;
                     return true;
                     }
                     return false;
                 });
 
        }
    }
}

write()

bool GncSqlTaxTableBackend::write ( GncSqlBackend *  sql_be )

overridevirtual

Write all objects of m_type_name to the database.

Parameters

sql_be

The GncSqlBackend containing the database.

Returns

true if the objects were successfully written, false otherwise.

Reimplemented from GncSqlObjectBackend.

Definition at line 477 of file gnc-tax-table-sql.cpp.

{
    g_return_val_if_fail (sql_be != NULL, FALSE);
    write_objects_t data{sql_be, true, this};
 
    qof_object_foreach (GNC_ID_TAXTABLE, sql_be->book(), save_next_taxtable, &data);
 
    return data.is_ok;
}

---

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

• gnc-tax-table-sql.h
• gnc-tax-table-sql.cpp