Eneboo - Documentación para desarrolladores
Tipos públicos | Métodos públicos
Referencia de la Clase FLTableMetaData

#include <FLTableMetaData.h>

Diagrama de herencias de FLTableMetaData
QObject Qt Qt AQTableMD

Lista de todos los miembros.

Tipos públicos

typedef QDict< FLFieldMetaData > FLFieldMetaDataList

Métodos públicos

 FLTableMetaData (const QString &n, const QString &a, const QString &q=QString::null)
 ~FLTableMetaData ()
QString name () const
void setName (const QString &n)
void setAlias (const QString &a)
void setQuery (const QString &q)
QString alias () const
QString query () const
bool isQuery () const
void addFieldMD (FLFieldMetaData *f)
void removeFieldMD (const QString &fN)
void setCompoundKey (FLCompoundKey *cK)
QString primaryKey (bool prefixTable=false) const
QString fieldNameToAlias (const QString &fN) const
QString fieldAliasToName (const QString &aN) const
int fieldType (const QString &fN) const
bool fieldIsPrimaryKey (const QString &fN) const
bool fieldIsIndex (const QString &fN) const
bool fieldIsCounter (const QString &fN) const
bool fieldAllowNull (const QString &fN) const
bool fieldIsUnique (const QString &fN) const
QString fieldTableM1 (const QString &fN) const
QString fieldForeignFieldM1 (const QString &fN) const
FLRelationMetaData * relation (const QString &fN, const QString &fFN, const QString &fTN) const
int fieldLength (const QString &fN) const
int fieldPartInteger (const QString &fN) const
int fieldPartDecimal (const QString &fN) const
bool fieldCalculated (const QString &fN) const
bool fieldVisible (const QString &fN) const
FLFieldMetaData * field (const QString &fN) const
FLFieldMetaDataList * fieldList () const
QString fieldList (bool prefixTable) const
FLFieldMetaDataList * fieldListOfCompoundKey (const QString &fN) const
QString fieldsNames () const
QStringList fieldsNamesUnlock () const
bool concurWarn () const
void setConcurWarn (bool b=true)
bool detectLocks () const
void setDetectLocks (bool b=true)

Descripción detallada

Mantiene la definicion de una tabla.

Esta clase mantienen la definicion de ciertas caracteristicas de una tabla de la base de datos.

Adicionalmente puede ser utilizada para la definición de los metadatos de una consulta, ver FLTableMetaData::query().

Autor:
InfoSiAL S.L.

Documentación de los 'Typedef' miembros de la clase

Tipo de datos lista de campos


Documentación del constructor y destructor

FLTableMetaData::FLTableMetaData ( const QString &  n,
const QString &  a,
const QString &  q = QString::null 
)

constructor

Parámetros:
nNombre de la tabla a definir
aAlias de la tabla, utilizado en formularios
q(Opcional) Nombre de la consulta de la que define sus metadatos
FLTableMetaData::~FLTableMetaData ( )

destructor


Documentación de las funciones miembro

void FLTableMetaData::addFieldMD ( FLFieldMetaData *  f)

Añade la descripción de un campo a lista de descripciones de campos.

Parámetros:
fObjeto FLFieldMetaData con la descripción del campo a añadir
QString FLTableMetaData::alias ( ) const [inline]

Obtiene el alias asociado a la tabla

bool FLTableMetaData::concurWarn ( ) const [inline]
Devuelve:
El indicador FLTableMetaData::concurWarn_
bool FLTableMetaData::detectLocks ( ) const [inline]
Devuelve:
El indicador FLTableMetaData::detectLocks_
FLFieldMetaData * FLTableMetaData::field ( const QString &  fN) const

Obtiene los metadatos de un campo.

Parámetros:
fNNombre del campo
Devuelve:
Un objeto FLFieldMetaData con lainformación o metadatos de un campo dado
QString FLTableMetaData::fieldAliasToName ( const QString &  aN) const

Obtiene el nombre de un campo a partir de su alias.

Parámetros:
aNNombre del alias del campo
bool FLTableMetaData::fieldAllowNull ( const QString &  fN) const

Obtiene si un campo puede ser nulo

Parámetros:
fNNombre del campo
bool FLTableMetaData::fieldCalculated ( const QString &  fN) const

Obtiene si un campo es calculado.

Parámetros:
fNNombre del campo
QString FLTableMetaData::fieldForeignFieldM1 ( const QString &  fN) const

Obtiene el nombre del campo de la tabla foránea relacionado con el indicado mediante una relacion M1 (muchos auno).

Parámetros:
fNCampo de la relacion M1 de esta tabla, que se supone que esta relacionado con otro campo de otra tabla
Devuelve:
El nombre del campo foráneo relacionado con el indicado
bool FLTableMetaData::fieldIsCounter ( const QString &  fN) const

Obtiene si un campo es contador.

Parámetros:
fNNombre del campo
Autor:
Andrés Otón Urbano (baxas@eresmas.com)
bool FLTableMetaData::fieldIsIndex ( const QString &  fN) const

Obtiene si un campo es índice a partir de su nombre.

Parámetros:
fNNombre del campo
bool FLTableMetaData::fieldIsPrimaryKey ( const QString &  fN) const

Obtiene si un campo es clave primaria partir de su nombre.

Parámetros:
fNNombre del campo
bool FLTableMetaData::fieldIsUnique ( const QString &  fN) const

Obtiene si un campo es único a partir de su nombre.

Parámetros:
fNNombre del campo
int FLTableMetaData::fieldLength ( const QString &  fN) const

Obtiene la longitud de un campo a partir de su nombre.

Parámetros:
fNNombre del campo
FLTableMetaData::FLFieldMetaDataList * FLTableMetaData::fieldList ( ) const [inline]

Para obtener la lista de definiciones de campos.

Devuelve:
Objeto con la lista de deficiones de campos de la tabla
QString FLTableMetaData::fieldList ( bool  prefixTable) const

Para obtener una cadena con los nombres de los campos separados por comas.

Parámetros:
prefixTableSi es TRUE se añade un prefijo a cada campo con el nombre de la tabla; nombretabla.nombrecampo
Devuelve:
Cadena de caracteres con los nombres de los campos separados por comas
FLTableMetaData::FLFieldMetaDataList * FLTableMetaData::fieldListOfCompoundKey ( const QString &  fN) const

Obtiene la lista de campos de una clave compuesta, a partir del nombre de un campo del que se quiere averiguar si está en esa clave compuesta.

Parámetros:
fNNombre del campo del que se quiere averiguar si pertenece a una clave compuesta.
Devuelve:
Si el campo pertenece a una clave compuesta, devuelve la lista de campos que forman dicha clave compuesta, incluido el campo consultado. En el caso que el campo consultado no pertenezca a ninguna clave compuesta devuelve 0
QString FLTableMetaData::fieldNameToAlias ( const QString &  fN) const

Obtiene el alias de un campo a partir de su nombre.

Parámetros:
fNNombre del campo
int FLTableMetaData::fieldPartDecimal ( const QString &  fN) const

Obtiene el número de dígitos de la parte decimal de un campo a partir de su nombre.

Parámetros:
fNNombre del campo
int FLTableMetaData::fieldPartInteger ( const QString &  fN) const

Obtiene el número de dígitos de la parte entera de un campo a partir de su nombre.

Parámetros:
fNNombre del campo
QString FLTableMetaData::fieldsNames ( ) const [inline]

Obtiene una cadena de texto que contiene los nombres de los campos separados por comas.

El orden de los campos de izquierda a derecha es el correspondiente al orden en que se han añadido con el método addFieldMD() o addFieldName()

QStringList FLTableMetaData::fieldsNamesUnlock ( ) const [inline]

Lista de nombres de campos de la tabla que son del tipo FLFieldMetaData::Unlock

QString FLTableMetaData::fieldTableM1 ( const QString &  fN) const

Obtiene el nombre de la tabla foránea relacionada con un campo de esta tabla mediante una relacion M1 (muchos a uno).

Parámetros:
fNCampo de la relacion M1 de esta tabla, que se supone que esta relacionado con otro campo de otra tabla
Devuelve:
El nombre de la tabla relacionada M1, si hay relacion para el campo, o una cadena vacia sin el campo no está relacionado
int FLTableMetaData::fieldType ( const QString &  fN) const

Obtiene el tipo de un campo a partir de su nombre.

Parámetros:
fNNombre del campo
bool FLTableMetaData::fieldVisible ( const QString &  fN) const

Obtiene si un campo es visible.

Parámetros:
fNNombre del campo
bool FLTableMetaData::isQuery ( ) const [inline]

Obtiene si define los metadatos de una consulta

QString FLTableMetaData::name ( ) const [inline]

Obtiene el nombre de la tabla

Devuelve:
El nombre de la tabla que se describe

Reimplementado de QObject.

QString FLTableMetaData::primaryKey ( bool  prefixTable = false) const

Obtiene el nombre del campo que es clave primaria para esta tabla.

Parámetros:
prefixTableSi es TRUE se añade un prefijo con el nombre de la tabla; nombretabla.nombrecampo
QString FLTableMetaData::query ( ) const [inline]

Obtiene el nombre de la consulta de la que define sus metadatos.

El nombre corresponderá a la definición de una consulta mediante (fichero .qry). Si el nombre de la consulta está definido entonces el nombre de la tabla correponderá a la tabla principal de la consulta cuando esta referencie a varias tablas.

FLRelationMetaData * FLTableMetaData::relation ( const QString &  fN,
const QString &  fFN,
const QString &  fTN 
) const

Obtiene el objeto relación que definen dos campos.

Parámetros:
fNNombre del campo de esta tabla que forma parte de la relación
fFNNombre del campo foráneo a esta tabla que forma parte de la relación
fTNNombre de la tabla foránea
Devuelve:
Devuelve un objeto FLRelationMetaData con la información de la relación, siempre y cuando esta exista. Si no existe devuelve 0
void FLTableMetaData::removeFieldMD ( const QString &  fN)

Elimina la descripción de un campo de la lista de descripciones de campos.

Parámetros:
fNNombre del campo a eliminar
void FLTableMetaData::setAlias ( const QString &  a) [inline]

Establece el alias

Parámetros:
aAlias
void FLTableMetaData::setCompoundKey ( FLCompoundKey *  cK) [inline]

Establece la clave compuesta de esta tabla.

Parámetros:
cKObjeto FLCompoundKey con la descripción de la clave compuesta
void FLTableMetaData::setConcurWarn ( bool  b = true) [inline]

Establece el indicador FLTableMetaData::concurWarn_

void FLTableMetaData::setDetectLocks ( bool  b = true) [inline]

Establece el indicador FLTableMetaData::detectLocks_

void FLTableMetaData::setName ( const QString &  n)

Establece el nombre de la tabla

Parámetros:
nNombre de la tabla
void FLTableMetaData::setQuery ( const QString &  q) [inline]

Establece el nombre de la consulta

Parámetros:
qNombre de la consulta

La documentación para esta clase fue generada a partir de los siguientes ficheros:
 Todo Clases Namespaces Archivos Funciones Variables 'typedefs' Enumeraciones Valores de enumeraciones Propiedades Amigas 'defines'