Referencia de la Clase FLManager

#include <FLManager.h>

Diagrama de herencias de FLManager

Lista de todos los miembros.

Métodos públicos
	FLManager ()
	~FLManager ()
void	init ()
void	finish ()
FLTableMetaData *	metadata (const QString &n, bool quick=false)
FLSqlQuery *	query (const QString &n, QObject *parent=0)
FLAction *	action (const QString &n)
bool	existsTable (const QString &n, bool cache=true) const
bool	checkMetaData (const QString &n)
bool	checkMetaData (const QString &mtd1, const QString &mtd2)
bool	checkMetaData (FLTableMetaData *tmd1, FLTableMetaData *tmd2)
bool	alterTable (const QString &n)
bool	alterTable (const QString &mtd1, const QString &mtd2, const QString &key=QString::null)
FLTableMetaData *	createTable (const QString &n)
FLTableMetaData *	createTable (FLTableMetaData *tmd)
QString	formatValueLike (FLFieldMetaData *fMD, const QVariant &v, const bool upper=false)
QString	formatAssignValueLike (FLFieldMetaData *fMD, const QVariant &v, const bool upper=false)
QString	formatAssignValueLike (const QString &fieldName, FLFieldMetaData *fMD, const QVariant &v, const bool upper=false)
QString	formatAssignValueLike (const QString &fieldName, int t, const QVariant &v, const bool upper=false)
QString	formatValueLike (int t, const QVariant &v, const bool upper=false)
QString	formatValue (FLFieldMetaData *fMD, const QVariant &v, const bool upper=false)
QString	formatAssignValue (FLFieldMetaData *fMD, const QVariant &v, const bool upper=false)
QString	formatAssignValue (const QString &fieldName, FLFieldMetaData *fMD, const QVariant &v, const bool upper=false)
QString	formatAssignValue (const QString &fieldName, int t, const QVariant &v, const bool upper=false)
QString	formatValue (int t, const QVariant &v, const bool upper=false)
FLTableMetaData *	metadata (QDomElement *mtd, bool quick=false)
FLFieldMetaData *	metadataField (QDomElement *field, bool v=true, bool ed=true)
FLRelationMetaData *	metadataRelation (QDomElement *relation)
FLParameterQuery *	queryParameter (QDomElement *parameter)
FLGroupByQuery *	queryGroup (QDomElement *group)
FLTableMetaData *	createSystemTable (const QString &n)
void	loadTables ()
void	cleanupMetaData ()
bool	isSystemTable (const QString &n)
QString	storeLargeValue (FLTableMetaData *mtd, const QString &largeValue)
QVariant	fetchLargeValue (const QString &refKey) const
Métodos protegidos
	FLManager (FLSqlDatabase *db)
Amigas
class	FLSqlDatabase

---

Descripción detallada

Esta clase sirve como administrador de la base de datos.

Encargada de abrir los formularios u obtener sus definiciones (ficheros .ui). Tambien mantiene los metadatos de todas la tablas de la base de datos, ofreciendo la posibilidad de recuperar los metadatos mediante objetos FLTableMetaData de una tabla dada.

Autor:

InfoSiAL S.L.

---

Documentación del constructor y destructor

FLManager::FLManager

(

FLSqlDatabase *

db

)

[protected]

constructor

FLManager::FLManager

(

)

[explicit]

constructor

FLManager::~FLManager

(

)

destructor

---

Documentación de las funciones miembro

FLAction * FLManager::action

(

const QString &

n

)

Obtiene la definici�n de una acci�n a partir de su nombre.

Este m�todo busca en los [id_modulo].xml la acci�n que se le pasa como nombre y construye y devuelve el objeto FLAction correspondiente. NO SE HACEN CHEQUEOS DE ERRORES SINT�CTICOS EN EL XML.

Parámetros:

n	Nombre de la accion

Devuelve:

Un objeto FLAction con la descripcion de la accion

bool FLManager::alterTable

(

const QString &

n

)

Modifica la estructura o metadatos de una tabla, preservando los posibles datos que pueda contener.

Seg�n la definici�n existente en un momento dado de los metadatos en el fichero .mtd, este m�todo reconstruye la tabla con esos metadatos sin la p�rdida de informaci�n o datos, que pudieran existir en ese momento en la tabla.

Parámetros:

n	Nombre de la tabla a reconstruir

Devuelve:

TRUE si la modificaci�n tuvo �xito

bool FLManager::alterTable	(	const QString &	mtd1,
		const QString &	mtd2,
		const QString &	key = QString::null
	)

Esta funci�n es esencialmente igual a la anterior, se proporciona por conveniencia.

Modifica la estructura de una tabla dada, preservando los datos. La nueva estructura y la vieja se pasan en cadenas de caracteres con la descripcion XML.

Parámetros:

n	Nombre de la tabla a reconstruir
mtd1	Descripcion en XML de la vieja estructura
mtd2	Descripcion en XML de la nueva estructura
key	Clave sha1 de la vieja estructura

Devuelve:

TRUE si la modificaci�n tuvo �xito

bool FLManager::checkMetaData	(	FLTableMetaData *	tmd1,
		FLTableMetaData *	tmd2
	)

Esta funci�n es esencialmente igual a la anterior, se proporciona por conveniencia.

bool FLManager::checkMetaData	(	const QString &	mtd1,
		const QString &	mtd2
	)		[inline]

Esta funci�n es esencialmente igual a la anterior, se proporciona por conveniencia.

Compara los metadatos de dos tablas, la definici�n en XML de esas dos tablas se pasan como dos cadenas de caracteres.

Parámetros:

mtd1	Cadena de caracteres con XML que describe la primera tabla
mtd2	Cadena de caracteres con XML que describe la primera tabla

Devuelve:

TRUE si las dos descripciones son iguales, y FALSE en caso contrario

bool FLManager::checkMetaData

(

const QString &

n

)

Comprueba si los metadatos definidos actualmente para una tabla en un fichero .mtd, difieren de los que tiene actualmente esa tabla en la base de datos (difieren con la copia que se tiene actualmente de ellos).

Cuando se realizan modificaciones en la definici�n de una tabla, es probable que esa tabla ya exista en la base de datos. Con este m�todo podemos determinar posteriormente si lo metadatos definidos actualmente difieren de los de la tabla existente en la base de datos.

Parámetros:

n	Nombre de la tabla a comprobar

Devuelve:

TRUE si los metadatos que hemos definido en FLManager::metadata() para una tabla (nuevos) son iguales a los metadatos de la tabla que tenemos en la base de datos (viejos), y FALSE en caso contrario

void FLManager::cleanupMetaData

(

)

Limpieza la tabla flmetadata, actualiza el cotenido xml con el de los fichero .mtd actualmente cargados

FLTableMetaData * FLManager::createSystemTable

(

const QString &

n

)

Crea una tabla del sistema.

Este m�todo lee directamente de disco el fichero con la descripci�n de una tabla del sistema y la crea en la base de datos. Su uso normal es para inicializar el sistema con tablas iniciales.

Parámetros:

n	Nombre de la tabla.

Devuelve:

Un objeto FLTableMetaData con los metadatos de la tabla que se ha creado, o 0 si no se pudo crear la tabla o ya exist�a

FLTableMetaData * FLManager::createTable

(

const QString &

n

)

Crea una tabla en la base de datos.

Parámetros:

n	Nombre de la tabla que se quiere crear

Devuelve:

Un objeto FLTableMetaData con los metadatos de la tabla que se ha creado, o 0 si no se pudo crear la tabla o ya exist�a

FLTableMetaData * FLManager::createTable

(

FLTableMetaData *

tmd

)

Crea una tabla en la base de datos.

Parámetros:

tmd	Metadatos de la tabla

Devuelve:

Un objeto FLTableMetaData con los metadatos de la tabla que se ha creado, o 0 si no se pudo crear la tabla o ya exist�a

bool FLManager::existsTable	(	const QString &	n,
		bool	cache = true
	)		const

Comprueba si existe la tabla especificada en la base de datos.

Parámetros:

n	Nombre de la tabla que se quiere comprobar si existe
cache	Si cierto consulta primero la cache de tablas, en caso contrario realiza una consulta a la base para obtener las tablas existentes

Devuelve:

TRUE si existe la tabla, FALSE en caso contrario

QVariant FLManager::fetchLargeValue

(

const QString &

refKey

)

const

Obtiene el valor de gran tama�o segun su clave de referencia.

Parámetros:

refKey

Clave de referencia. Esta clave se suele obtener mediante FLManager::storeLargeValue

Devuelve:

Valor de gran tama�o almacenado

void FLManager::finish

(

)

Acciones de finalizaci�n.

QString FLManager::formatAssignValue	(	FLFieldMetaData *	fMD,
		const QVariant &	v,
		const bool	upper = false
	)

QString FLManager::formatAssignValue	(	const QString &	fieldName,
		FLFieldMetaData *	fMD,
		const QVariant &	v,
		const bool	upper = false
	)

QString FLManager::formatAssignValue	(	const QString &	fieldName,
		int	t,
		const QVariant &	v,
		const bool	upper = false
	)

QString FLManager::formatAssignValueLike	(	const QString &	fieldName,
		FLFieldMetaData *	fMD,
		const QVariant &	v,
		const bool	upper = false
	)

QString FLManager::formatAssignValueLike	(	FLFieldMetaData *	fMD,
		const QVariant &	v,
		const bool	upper = false
	)

QString FLManager::formatAssignValueLike	(	const QString &	fieldName,
		int	t,
		const QVariant &	v,
		const bool	upper = false
	)

QString FLManager::formatValue	(	FLFieldMetaData *	fMD,
		const QVariant &	v,
		const bool	upper = false
	)

Devuelve el contenido del valor de de un campo formateado para ser reconocido por la base de datos actual, dentro de la clausura WHERE de SQL.

Este m�todo toma como parametros los metadatos del campo definidos con FLFieldMetaData. Adem�s de TRUE y FALSE como posibles valores de un campo l�gico tambi�n acepta los valores S� y No (o su traducci�n al idioma correspondiente). Las fechas son adaptadas al forma AAAA-MM-DD, que es el formato reconocido por PostgreSQL .

Parámetros:

fMD	Objeto FLFieldMetaData que describre los metadatos para el campo
v	Valor que se quiere formatear para el campo indicado
upper	Si TRUE convierte a may�sculas el valor (si es de tipo cadena)

QString FLManager::formatValue	(	int	t,
		const QVariant &	v,
		const bool	upper = false
	)

Este m�todo hace lo mismo que el anterior, y se suministra por conveniencia.

Parámetros:

t	Tipo de datos del valor
v	Valor que se quiere formatear para el campo indicado
upper	Si TRUE convierte a may�sculas el valor (si es de tipo cadena)

QString FLManager::formatValueLike	(	int	t,
		const QVariant &	v,
		const bool	upper = false
	)

Este m�todo hace lo mismo que el anterior, y se suministra por conveniencia.

Parámetros:

t	Tipo de datos del valor
v	Valor que se quiere formatear para el campo indicado
upper	Si TRUE convierte a may�sculas el valor (si es de tipo cadena)

QString FLManager::formatValueLike	(	FLFieldMetaData *	fMD,
		const QVariant &	v,
		const bool	upper = false
	)

Devuelve el contenido del valor de de un campo formateado para ser reconocido por la base de datos actual en condiciones LIKE, dentro de la clausura WHERE de SQL.

Este m�todo toma como parametros los metadatos del campo definidos con FLFieldMetaData. Adem�s de TRUE y FALSE como posibles valores de un campo l�gico tambi�n acepta los valores S� y No (o su traducci�n al idioma correspondiente). Las fechas son adaptadas al forma AAAA-MM-DD, que es el formato reconocido por PostgreSQL .

Parámetros:

fMD	Objeto FLFieldMetaData que describre los metadatos para el campo
v	Valor que se quiere formatear para el campo indicado
upper	Si TRUE convierte a may�sculas el valor (si es de tipo cadena)

void FLManager::init

(

)

Acciones de inicializaci�n.

bool FLManager::isSystemTable

(

const QString &

n

)

Para saber si la tabla dada es una tabla de sistema.

Parámetros:

n	Nombre de la tabla.

Devuelve:

TRUE si es una tabla de sistema

void FLManager::loadTables

(

)

Carga en la lista de tablas los nombres de las tablas de la base de datos

FLTableMetaData * FLManager::metadata	(	QDomElement *	mtd,
		bool	quick = false
	)

Crea un objeto FLTableMetaData a partir de un elemento XML.

Dado un elemento XML, que contiene la descripci�n de una tablas, construye y devuelve el objeto FLTableMetaData correspondiente. NO SE HACEN CHEQUEOS DE ERRORES SINT�CTICOS EN EL XML.

Parámetros:

mtd	Elemento XML con la descripci�n de la tabla
quick	Si TRUE no realiza chequeos, usar con cuidado

Devuelve:

Objeto FLTableMetaData que contiene la descrici�n de la relaci�n

FLTableMetaData * FLManager::metadata	(	const QString &	n,
		bool	quick = false
	)

Para obtener definicion de una tabla de la base de datos, a partir de un fichero XML.

El nombre de la tabla corresponde con el nombre del fichero mas la extensi�n ".mtd" que contiene en XML la descripci�n de la tablas. Este m�todo escanea el fichero y construye/devuelve el objeto FLTableMetaData correspondiente, adem�s realiza una copia de estos metadatos en una tabla de la misma base de datos para poder determinar cuando ha sido modificados y as�, si es necesario, reconstruir la tabla para que se adapte a la nuevos metadatos. NO SE HACEN CHEQUEOS DE ERRORES SINT�CTICOS EN EL XML.

IMPORTANTE :Para que estos m�todos funcionen correctamente, es estrictamente necesario haber creado la base de datos en PostgreSQL con codificaci�n UNICODE; "createdb -E UNICODE abanq".

Parámetros:

n	Nombre de la tabla de la base de datos de la que obtener los metadatos
quick	Si TRUE no realiza chequeos, usar con cuidado

Devuelve:

Un objeto FLTableMetaData con los metadatos de la tabla solicitada

FLFieldMetaData * FLManager::metadataField	(	QDomElement *	field,
		bool	v = true,
		bool	ed = true
	)

Crea un objeto FLFieldMetaData a partir de un elemento XML.

Dado un elemento XML, que contiene la descripci�n de un campo de una tabla construye y agrega a una lista de descripciones de campos el objeto FLFieldMetaData correspondiente, que contiene dicha definici�n del campo. Tambien lo agrega a una lista de claves compuesta, si el campo construido pertenece a una clave compuesta. NO SE HACEN CHEQUEOS DE ERRORES SINT�CTICOS EN EL XML.

Parámetros:

field	Elemento XML con la descripci�n del campo
v	Valor utilizado por defecto para la propiedad visible
ed	Valor utilizado por defecto para la propiedad editable

Devuelve:

Objeto FLFieldMetaData que contiene la descripci�n del campo

FLRelationMetaData * FLManager::metadataRelation

(

QDomElement *

relation

)

Crea un objeto FLRelationMetaData a partir de un elemento XML.

Dado un elemento XML, que contiene la descripci�n de una relaci�n entre tablas, construye y devuelve el objeto FLRelationMetaData correspondiente, que contiene dicha definici�n de la relaci�n. NO SE HACEN CHEQUEOS DE ERRORES SINT�CTICOS EN EL XML.

Parámetros:

relation

Elemento XML con la descripci�n de la relaci�n

Devuelve:

Objeto FLRelationMetaData que contiene la descripci�n de la relaci�n

FLSqlQuery * FLManager::query	(	const QString &	n,
		QObject *	parent = 0
	)

Para obtener una consulta de la base de datos, a partir de un fichero XML.

El nombre de la consulta corresponde con el nombre del fichero mas la extensi�n ".qry" que contiene en XML la descripci�n de la consulta. Este m�todo escanea el fichero y construye/devuelve el objeto FLSqlQuery. NO SE HACEN CHEQUEOS DE ERRORES SINT�CTICOS EN EL XML.

Parámetros:

n	Nombre de la consulta de la base de datos que se quiere obtener

Devuelve:

Un objeto FLSqlQuery que representa a la consulta que se quiere obtener

FLGroupByQuery * FLManager::queryGroup

(

QDomElement *

group

)

Crea un objeto FLGroupByQuery a partir de un elemento XML.

Dado un elemento XML, que contiene la descripci�n de un nivel de agrupamiento de una consulta, construye y devuelve el objeto FLGroupByQuery correspondiente. NO SE HACEN CHEQUEOS DE ERRORES SINT�CTICOS EN EL XML.

Parámetros:

group

Elemento XML con la descripci�n del nivel de agrupamiento de una consulta.

Devuelve:

Objeto FLGroupByQuery que contiene la descrici�n del nivel de agrupamiento

FLParameterQuery * FLManager::queryParameter

(

QDomElement *

parameter

)

Crea un objeto FLParameterQuery a partir de un elemento XML.

Dado un elemento XML, que contiene la descripci�n de una par�metro de una consulta, construye y devuelve el objeto FLParameterQuery correspondiente. NO SE HACEN CHEQUEOS DE ERRORES SINT�CTICOS EN EL XML.

Parámetros:

parameter

Elemento XML con la descripci�n del par�metro de una consulta

Devuelve:

Objeto FLParameterQuery que contiene la descrici�n del par�metro

QString FLManager::storeLargeValue	(	FLTableMetaData *	mtd,
		const QString &	largeValue
	)

Utilizado para almacenar valores grandes de campos en tablas separadas indexadas por claves SHA del contenido del valor.

Se utiliza para optimizar consultas que incluyen campos con valores grandes, como por ejemplo im�genes, para manejar en las consulta SQL la referencia al valor que es de tama�o constante en vez del valor en s�. Esto disminuye el tr�fico al reducir considerablemente el tama�o de los registros obtenidos.

Las consultas pueden utilizar una referencia y obtener su valor s�lo cuando se necesita mediante FLManager::fetchLargeValue().

Parámetros:

mtd	Metadatos de la tabla que contiene el campo
largeValue	Valor de gran tama�o del campo

Devuelve:

Clave de referencia al valor

---

Documentación de las funciones relacionadas y clases amigas

friend class FLSqlDatabase [friend]

---

La documentación para esta clase fue generada a partir de los siguientes ficheros:

• src/flbase/FLManager.h
• src/flbase/FLManager.cpp