Referencia de la Clase cursor2

#include <postgresiface2.h>

Diagrama de colaboración para cursor2:

[leyenda]
Lista de todos los miembros.

Métodos públicos

 cursor2 (QString nombre, PGconn *conn1, QString SQLQuery)
 Constructor, inicializa la estructura y realiza la consulta.
 ~cursor2 ()
 Destructor, elimina la memoria ocupada.
int numregistros ()
 Devuelve el número de registros del cursor.
QString valor (int posicion, int registro=-1)
 Devuelve el valor de una determinada posición del query.
QString valor (QString campo, int registro=-1)
 Devuelve el valor de una determinada posición del query.
int siguienteregistro ()
 Avanza el puntero de recorrido en forma de cola una posición.
int registroanterior ()
 Retrocede el puntero de recorrido en forma de cola una posición.
int primerregistro ()
 Establece la posición del puntero de recorrido de cola al primer registro.
int ultimoregistro ()
 Establece la posición del puntero de recorrido de cola en el último registro.
int regactual ()
 Devuelve la posición del registro actual.
void cerrar ()
 Libera la memoria que se ha ocupado en las consultas.
QString nomcampo (int)
 Devuelve el nombre del campo de una columna determinada del query.
int numcampo (QString)
 Devuelve el número de columna que tiene una columna referenciada por el nombre.
int numcampos ()
 Devuelve el número total de columnas que tiene el query.
bool eof ()
 Indica que se ha alcanzado el primer registro del query.
bool bof ()
 Indica que se ha alcanzado el último registro del query.
bool esultimoregistro ()
 Informa sobre si el registro actual es el ultimo registro del query.
bool esprimerregistro ()
 Informa sobre si el registro actual es el primer registro del query.

Atributos privados

QString nomcursor
 El nombre del cursor, (OBSOLETE).
PGresult * result
 Estructura en la que se almacena el resultado.
PGconn * conn
 Estructura en la que se almacenan los datos de conexión.
int registroactual
 Para recorrer un query simulamos una cola, esta variable global indica el registro en que nos encontramos situados.
int nregistros
 Indica el numero de registros que tiene el query. (La componente vertical del query).
int ncampos
 Indica el número de campos que tiene el query. (La componente horizontal del query).

Descripción detallada

Esta clase provee toda la interacción necesaria con las consultas de base de datos Se carga normalmente a partir de la clase postgresiface2 con el método cargacursor Y crea las estructuras necesarias para recorrer un recordset de postgres


Documentación del constructor y destructor

cursor2::cursor2 QString  nombre,
PGconn *  conn1,
QString  SQLQuery
 

Constructor, inicializa la estructura y realiza la consulta.

Constructor de la clase Realiza la consulta en la base de datos y almacena el resultado en las variables de clase para poder ser manupuladas. Tambi� almacena en variables globales algunos resultados para poder acelerar las consultas (nregistros y ncampos). Si todo falla (y en funci� de la configuraci�) Da un mensaje de alerta o no.

Parámetros:
nombre Nombre que obtendr�el query (OBSOLETO)
conn1 Conexi� con la base de datos (Inicializada en postgresiface2
SQLQuery Query en formato SQL a realizar en la base de datos.

Gráfico de llamadas para esta función:

cursor2::~cursor2  ) 
 

Destructor, elimina la memoria ocupada.

Destructor de clase, antes de destruirse limpia los posibles buffers intermedios

Gráfico de llamadas para esta función:


Documentación de las funciones miembro

bool cursor2::bof  ) 
 

Indica que se ha alcanzado el último registro del query.

Devuelve:
Devuelve TRUE si el registro est�en la posici� inicial, o si est�vacio

void cursor2::cerrar  ) 
 

Libera la memoria que se ha ocupado en las consultas.

Limpia los buffers intermedios que puedan estar chupando memoria

bool cursor2::eof  ) 
 

Indica que se ha alcanzado el primer registro del query.

Devuelve:
Devuelve TRUE si el registro est�en la posici� final, o si est�vacio

bool cursor2::esprimerregistro  ) 
 

Informa sobre si el registro actual es el primer registro del query.

Devuelve:
devuelve TRUE si es el primer registro a consear e el query.

bool cursor2::esultimoregistro  ) 
 

Informa sobre si el registro actual es el ultimo registro del query.

Devuelve:
devuelve TRUE si es el ltimo registro a considerar

QString cursor2::nomcampo int  campo  ) 
 

Devuelve el nombre del campo de una columna determinada del query.

Devuelve:
Devuelve el nombre del campo de una posici� determinada.
Parámetros:
campo Posici� de la que se quiere que devuelva el nombre.

int cursor2::numcampo QString  campo  ) 
 

Devuelve el número de columna que tiene una columna referenciada por el nombre.

Dado un campo esta funci� devuelve devuelve la posici� que le corresponde, y si no le corresponde ninguno devuelve -1

Parámetros:
campo Nombre del campo.
Devuelve:
Devuelve la posici� si el nombre del campo existe, y si no devuelve -1
Tareas Pendientes:
Tal vez deber� crearse una estructura intermedia que indexe los nombres con las posiciones para hacer la bsqueda m� r�ida, pero al ser el nmero de registros siempre muy reducido seguramente no arreglariamos nada de nada.

Gráfico de llamadas para esta función:

int cursor2::numcampos  ) 
 

Devuelve el número total de columnas que tiene el query.

Devuelve:
Devuelve el nmero de campos de la consulta

int cursor2::numregistros  ) 
 

Devuelve el número de registros del cursor.

Devuelve:
Devuelve el nmero de registros de la consulta.

int cursor2::primerregistro  ) 
 

Establece la posición del puntero de recorrido de cola al primer registro.

Devuelve:
Devuelve la posici� del primer registro de la tabla de registros

int cursor2::regactual  )  [inline]
 

Devuelve la posición del registro actual.

int cursor2::registroanterior  ) 
 

Retrocede el puntero de recorrido en forma de cola una posición.

Devuelve:
Devuelve la posici� anterior al registro que se est�recorriendo

int cursor2::siguienteregistro  ) 
 

Avanza el puntero de recorrido en forma de cola una posición.

Devuelve:
Devuelve la posici� siguiente al registro que se est�recorriendo

int cursor2::ultimoregistro  ) 
 

Establece la posición del puntero de recorrido de cola en el último registro.

Devuelve:
Devuelve el ltimo registro de la tabla de registros

QString cursor2::valor QString  campo,
int  registro = -1
 

Devuelve el valor de una determinada posición del query.

Esta funci� devuelve el valor del campo especificado (por nombre) del registro pasado, si se pasa como registro -1 se devuelve el registro actual.

Parámetros:
campo Nombre del campo a devolver
registro El registro del que se quiere devolver el campo. Si vale -1 entonces se usa el recorrido en forma de lista de campos para hacerlo.
Devuelve:
El valor de la posici�.

Gráfico de llamadas para esta función:

QString cursor2::valor int  posicion,
int  registro = -1
 

Devuelve el valor de una determinada posición del query.

Esta funcion devuelve el valor del campo posicion del registro pasado, si se pasa -1 como registro se devuelve el registro actual

Parámetros:
posicion El nmero de campo del que se quiere la posici�.
registro El registro del que se quiere devolver el campo. Si vale -1 entonces se usa el recorrido en forma de lista de campos para hacerlo.
Devuelve:
El valor de la posici�.


Documentación de los datos miembro

PGconn* cursor2::conn [private]
 

Estructura en la que se almacenan los datos de conexión.

int cursor2::ncampos [private]
 

Indica el número de campos que tiene el query. (La componente horizontal del query).

QString cursor2::nomcursor [private]
 

El nombre del cursor, (OBSOLETE).

int cursor2::nregistros [private]
 

Indica el numero de registros que tiene el query. (La componente vertical del query).

int cursor2::registroactual [private]
 

Para recorrer un query simulamos una cola, esta variable global indica el registro en que nos encontramos situados.

PGresult* cursor2::result [private]
 

Estructura en la que se almacena el resultado.


La documentación para esta clase fué generada a partir de los siguientes archivos:
Generado el Sat May 21 00:05:00 2005 para BulmaGes por  doxygen 1.4.2