Contains all of the information required to copy information between an object and the database for a specific object property. More...

#include <gnc-sql-column-table-entry.hpp>

Inheritance diagram for GncSqlColumnTableEntry:

Public Member Functions
	GncSqlColumnTableEntry (const char name, const GncSqlObjectType type, unsigned int s, int f, const char gobj_name=nullptr, const char *qof_name=nullptr, QofAccessFunc get=nullptr, QofSetterFunc set=nullptr)

virtual void	load (const GncSqlBackend sql_be, GncSqlRow &row, QofIdTypeConst obj_name, void pObject) const noexcept=0
	Load a value into an object from the database row.

virtual void	add_to_table (ColVec &vec) const noexcept=0
	Add a GncSqlColumnInfo structure for the column type to a ColVec.

virtual void	add_to_query (QofIdTypeConst obj_name, void *pObject, PairVec &vec) const noexcept=0
	Add a pair of the table column heading and object's value's string representation to a PairVec; used for constructing WHERE clauses and UPDATE statements.

QofAccessFunc	get_getter (QofIdTypeConst obj_name) const noexcept
	Retrieve the getter function depending on whether it's an auto-increment field, a QofClass getter, or a function passed to the constructor.

QofSetterFunc	get_setter (QofIdTypeConst obj_name) const noexcept
	Retrieve the setter function depending on whether it's an auto-increment field, a QofClass getter, or a function passed to the constructor.

const char *	name () const noexcept
	Retrieve the field name so that we don't need to make create_single_col_select_statement and friend.

bool	is_autoincr () const noexcept
	Report if the entry is an auto-increment field.

template<typename T >
void	load_from_guid_ref (GncSqlRow &row, QofIdTypeConst obj_name, void *pObject, T get_ref) const noexcept

Protected Member Functions
template<typename T >
T	get_row_value_from_object (QofIdTypeConst obj_name, const void *pObject) const

template<typename T >
void	add_value_to_vec (QofIdTypeConst obj_name, const void *pObject, PairVec &vec) const

void	add_objectref_guid_to_query (QofIdTypeConst obj_name, const void *pObject, PairVec &vec) const noexcept
	Adds a name/guid std::pair to a PairVec for creating a query.

void	add_objectref_guid_to_table (ColVec &vec) const noexcept
	Adds a column info structure for an object reference GncGUID to a ColVec.

template<>
gint64	get_row_value_from_object (QofIdTypeConst obj_name, const void *pObject) const

template<>
void	add_value_to_vec (QofIdTypeConst obj_name, const void *pObject, PairVec &vec, std::true_type) const

template<>
void	add_value_to_vec (QofIdTypeConst obj_name, const void *pObject, PairVec &vec, std::false_type) const

Friends
template<GncSqlObjectType Otype>
class	GncSqlColumnTableEntryImpl

struct	GncSqlColumnInfo

Detailed Description

Contains all of the information required to copy information between an object and the database for a specific object property.

If an entry contains a gobj_param_name value, this string is used as the property name for a call to g_object_get() or g_object_set(). If the gobj_param_name value is NULL but qof_param_name is not NULL, this value is used as the parameter name for a call to qof_class_get_parameter_getter(). If both of these values are NULL, getter and setter are the addresses of routines to return or set the parameter value, respectively.

The database description for an object consists of an array of GncSqlColumnTableEntry objects, with a final member having col_name == NULL.

Definition at line 126 of file gnc-sql-column-table-entry.hpp.

Constructor & Destructor Documentation

◆ GncSqlColumnTableEntry()

GncSqlColumnTableEntry::GncSqlColumnTableEntry	(	const char *	name,
		const GncSqlObjectType	type,
		unsigned int	s,
		int	f,
		const char *	gobj_name = `nullptr`,
		const char *	qof_name = `nullptr`,
		QofAccessFunc	get = `nullptr`,
		QofSetterFunc	set = `nullptr`
	)

inline

Definition at line 129 of file gnc-sql-column-table-entry.hpp.

                                                         :
        m_col_name{name}, m_col_type{type}, m_size{s},
        m_flags{static_cast<ColumnFlags>(f)},
        m_gobj_param_name{gobj_name}, m_qof_param_name{qof_name}, m_getter{get},
        m_setter{set} {}

Member Function Documentation

◆ add_objectref_guid_to_query()

void GncSqlColumnTableEntry::add_objectref_guid_to_query	(	QofIdTypeConst	obj_name,
		const void *	pObject,
		PairVec &	vec
	)		const

protectednoexcept

Adds a name/guid std::pair to a PairVec for creating a query.

Parameters

sql_be	SQL backend struct
obj_name	QOF object type name
pObject	Object
pList	List

Definition at line 95 of file gnc-sql-column-table-entry.cpp.

{
    auto inst = get_row_value_from_object<QofInstance*>(obj_name, pObject);
    if (inst == nullptr) return;
    auto guid = qof_instance_get_guid (inst);
    if (guid != nullptr) {
        gchar *guid_s = guid_to_string(guid);
        vec.emplace_back (std::make_pair (std::string{m_col_name}, quote_string(guid_s)));
        g_free(guid_s);
    }
}

◆ add_objectref_guid_to_table()

void GncSqlColumnTableEntry::add_objectref_guid_to_table ( ColVec & vec ) const

protectednoexcept

Adds a column info structure for an object reference GncGUID to a ColVec.

Parameters

sql_be	SQL backend struct
pList	List

Definition at line 110 of file gnc-sql-column-table-entry.cpp.

{
    GncSqlColumnInfo info{*this, BCT_STRING, GUID_ENCODING_LENGTH, FALSE};
    vec.emplace_back(std::move(info));
}

◆ add_to_query()

virtual void GncSqlColumnTableEntry::add_to_query	(	QofIdTypeConst	obj_name,
		void *	pObject,
		PairVec &	vec
	)		const

pure virtualnoexcept

Add a pair of the table column heading and object's value's string representation to a PairVec; used for constructing WHERE clauses and UPDATE statements.

Implemented in GncSqlColumnTableEntryImpl< Type >.

◆ add_to_table()

virtual void GncSqlColumnTableEntry::add_to_table ( ColVec & vec ) const

pure virtualnoexcept

Add a GncSqlColumnInfo structure for the column type to a ColVec.

◆ add_value_to_vec() [1/3]

template<typename T >

void GncSqlColumnTableEntry::add_value_to_vec	(	QofIdTypeConst	obj_name,
		const void *	pObject,
		PairVec &	vec
	)		const

protected

Definition at line 379 of file gnc-sql-column-table-entry.hpp.

{
    add_value_to_vec<T>(obj_name, pObject, vec, std::is_pointer<T>());
}

◆ add_value_to_vec() [2/3]

template<>

void GncSqlColumnTableEntry::add_value_to_vec	(	QofIdTypeConst	obj_name,
		const void *	pObject,
		PairVec &	vec,
		std::false_type
	)		const

inlineprotected

Definition at line 431 of file gnc-sql-column-table-entry.hpp.

{
    double s = *get_row_value_from_object<double*>(obj_name, pObject);
 
    std::ostringstream stream;
    stream << std::setprecision(12) << std::fixed << s;
    vec.emplace_back(std::make_pair(std::string{m_col_name}, stream.str()));
    return;
}

◆ add_value_to_vec() [3/3]

template<>

void GncSqlColumnTableEntry::add_value_to_vec	(	QofIdTypeConst	obj_name,
		const void *	pObject,
		PairVec &	vec,
		std::true_type
	)		const

inlineprotected

Definition at line 402 of file gnc-sql-column-table-entry.hpp.

{
    double* s = get_row_value_from_object<double*>(obj_name, pObject);
 
    if (s != nullptr)
    {
        std::ostringstream stream;
        stream << std::setprecision(12) << std::fixed << *s;
        vec.emplace_back(std::make_pair(std::string{m_col_name}, stream.str()));
        return;
    }
}

◆ get_getter()

QofAccessFunc GncSqlColumnTableEntry::get_getter ( QofIdTypeConst obj_name ) const

noexcept

Retrieve the getter function depending on whether it's an auto-increment field, a QofClass getter, or a function passed to the constructor.

Definition at line 52 of file gnc-sql-column-table-entry.cpp.

{
    QofAccessFunc getter;
 
    g_return_val_if_fail (obj_name != NULL, NULL);
 
    if (m_flags & COL_AUTOINC)
    {
        getter = get_autoinc_id;
    }
    else if (m_qof_param_name != NULL)
    {
        getter = qof_class_get_parameter_getter (obj_name, m_qof_param_name);
    }
    else
    {
        getter = m_getter;
    }
 
    return getter;
}

◆ get_row_value_from_object() [1/2]

template<>

gint64 GncSqlColumnTableEntry::get_row_value_from_object	(	QofIdTypeConst	obj_name,
		const void *	pObject
	)		const

protected

Definition at line 259 of file gnc-sql-column-table-entry.cpp.

{
    g_return_val_if_fail(obj_name != nullptr && pObject != nullptr,
                         INT64_C(0));
    int64_t result = INT64_C(0);
    if (m_gobj_param_name != nullptr)
        g_object_get(const_cast<void*>(pObject), m_gobj_param_name,
                     &result, nullptr);
    else
    {
        auto getter = (Int64AccessFunc)get_getter(obj_name);
        if (getter != nullptr)
            result = (getter)(const_cast<void*>(pObject));
    }
    return result;
}

◆ get_row_value_from_object() [2/2]

template<typename T >

T GncSqlColumnTableEntry::get_row_value_from_object	(	QofIdTypeConst	obj_name,
		const void *	pObject
	)		const

protected

Definition at line 328 of file gnc-sql-column-table-entry.hpp.

{
    return get_row_value_from_object<T>(obj_name, pObject,
                                        std::is_pointer<T>());
}

◆ get_setter()

QofSetterFunc GncSqlColumnTableEntry::get_setter ( QofIdTypeConst obj_name ) const

noexcept

Retrieve the setter function depending on whether it's an auto-increment field, a QofClass getter, or a function passed to the constructor.

Definition at line 75 of file gnc-sql-column-table-entry.cpp.

{
    QofSetterFunc setter = nullptr;
    if (m_flags & COL_AUTOINC)
    {
        setter = set_autoinc_id;
    }
    else if (m_qof_param_name != nullptr)
    {
        g_assert (obj_name != NULL);
        setter = qof_class_get_parameter_setter (obj_name, m_qof_param_name);
    }
    else
    {
        setter = m_setter;
    }
    return setter;
}

◆ is_autoincr()

bool GncSqlColumnTableEntry::is_autoincr ( ) const

inlinenoexcept

Report if the entry is an auto-increment field.

Definition at line 176 of file gnc-sql-column-table-entry.hpp.

176{ return m_flags & COL_AUTOINC; }

◆ load()

virtual void GncSqlColumnTableEntry::load	(	const GncSqlBackend *	sql_be,
		GncSqlRow &	row,
		QofIdTypeConst	obj_name,
		void *	pObject
	)		const

pure virtualnoexcept

Load a value into an object from the database row.

Implemented in GncSqlColumnTableEntryImpl< Type >.

◆ load_from_guid_ref()

template<typename T >

void GncSqlColumnTableEntry::load_from_guid_ref	(	GncSqlRow &	row,
		QofIdTypeConst	obj_name,
		void *	pObject,
		T	get_ref
	)		const

inlinenoexcept

Definition at line 182 of file gnc-sql-column-table-entry.hpp.

    {
        static QofLogModule log_module = G_LOG_DOMAIN;
        g_return_if_fail (pObject != NULL);
 
        GncGUID guid;
        auto val = row.get_string_at_col (m_col_name);
        if (!val)
        {
            DEBUG("set parameter: No string in column %s.", m_col_name);
            return;
        }
 
        if (string_to_guid (val->c_str(), &guid))
        {
            auto target = get_ref(&guid);
            if (target != nullptr)
                set_parameter (pObject, target, get_setter(obj_name),
                               m_gobj_param_name);
            else
                DEBUG("GUID %s returned null %s reference.",
                      val->c_str(), m_gobj_param_name);
        }
        else
        {
            if (val->empty())
                DEBUG("Can't load empty guid string for column %s", m_col_name);
            else
                DEBUG("Invalid GUID %s for column %s", val->c_str(), m_col_name);
        }
    }

◆ name()

const char * GncSqlColumnTableEntry::name ( ) const

inlinenoexcept

Retrieve the field name so that we don't need to make create_single_col_select_statement and friend.

Definition at line 172 of file gnc-sql-column-table-entry.hpp.

172{ return m_col_name; }

Friends And Related Symbol Documentation

◆ GncSqlColumnInfo

friend struct GncSqlColumnInfo

friend

Definition at line 181 of file gnc-sql-column-table-entry.hpp.

◆ GncSqlColumnTableEntryImpl

template<GncSqlObjectType Otype>

friend class GncSqlColumnTableEntryImpl

friend

Definition at line 180 of file gnc-sql-column-table-entry.hpp.

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

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GncSqlColumnTableEntry()

Member Function Documentation

◆ add_objectref_guid_to_query()

◆ add_objectref_guid_to_table()

◆ add_to_query()

◆ add_to_table()

◆ add_value_to_vec() [1/3]

◆ add_value_to_vec() [2/3]

◆ add_value_to_vec() [3/3]

◆ get_getter()

◆ get_row_value_from_object() [1/2]

◆ get_row_value_from_object() [2/2]

◆ get_setter()

◆ is_autoincr()

◆ load()

◆ load_from_guid_ref()

◆ name()

Friends And Related Symbol Documentation

◆ GncSqlColumnInfo

◆ GncSqlColumnTableEntryImpl