SqlBoundObjectClassData Class Reference

Contains static information about a specific SqlBoundObjectGroup class. Is used to capture data shared at the class level that cannot be specified statically.

#include <DataAnalysis/DataStructures/sqlboundobjectclassdata.h>

Public Member Functions
	SqlBoundObjectClassData (BoundTableNameFunc getBoundTableName)
	SqlBoundObjectClassData (const QString &tableName)
void	clearCachedData ()
QStringList	getAutoIncrementFieldNames () const
const QStringList &	getFieldNames () const
QStringList	getNonRelationFieldAliases () const
QStringList	getNonRelationFieldNames () const
QStringList	getPrimaryKeyFieldNames () const
QStringList	getRelationFieldNames (bool recursive) const
QStringList	getSqlValidFieldList () const
void	registerAutoIncrementField (const QString &name)
void	registerFieldName (const QString &name)
void	registerPrimaryKeyFieldName (const QString &name)
void	registerPrimaryKeyFieldNames (const QStringList &names)
void	registerRelation (const QString &fieldName, const SqlBindingRelation &relation)
QString	tableName () const

Constructor & Destructor Documentation

SqlBoundObjectClassData() [1/2]

SqlBoundObjectClassData

(

const QString &

tableName

)

Parameters

tableName

SqlBoundObjectClassData() [2/2]

SqlBoundObjectClassData

(

BoundTableNameFunc

getBoundTableName

)

Parameters

getBoundTableName

Pointer to getBoundTableName() function

Member Function Documentation

clearCachedData()

void clearCachedData

(

)

Clears cached data that is generated during fetch requests.

getAutoIncrementFieldNames()

QStringList getAutoIncrementFieldNames

(

)

const

getFieldNames()

const QStringList & getFieldNames

(

)

const

getNonRelationFieldAliases()

QStringList getNonRelationFieldAliases

(

)

const

Returns

getNonRelationFieldNames()

QStringList getNonRelationFieldNames

(

)

const

Returns

getPrimaryKeyFieldNames()

QStringList getPrimaryKeyFieldNames

(

)

const

getRelationFieldNames()

QStringList getRelationFieldNames

(

bool

recursive

)

const

Parameters

recursive

Return all the relation field names, including those of related classes. If false, the method will return only those attached to this class.

Returns

A QStringList of relation field names, optionally including those from related classes.

getSqlValidFieldList()

QStringList getSqlValidFieldList

(

)

const

Returns

registerAutoIncrementField()

void registerAutoIncrementField

(

const QString &

name

)

Parameters

name

registerFieldName()

void registerFieldName

(

const QString &

name

)

Parameters

name

registerPrimaryKeyFieldName()

void registerPrimaryKeyFieldName

(

const QString &

name

)

Parameters

name

registerPrimaryKeyFieldNames()

void registerPrimaryKeyFieldNames

(

const QStringList &

names

)

Parameters

names

The field names to register

registerRelation()

void registerRelation	(	const QString &	fieldName,
		const SqlBindingRelation &	relation
	)

Parameters

fieldName	Name of the field against which the relation will be registered
relation	The relation object representing the relation

tableName()

QString tableName

(

)

const