Referencia de la Clase FLFieldMetaData

#include <FLFieldMetaData.h>

Diagrama de herencias de FLFieldMetaData

Lista de todos los miembros.

Tipos públicos
enum	specialType { Serial = 100, Unlock = 200, Check = 300 }
typedef QPtrList < FLRelationMetaData >	FLRelationMetaDataList
Métodos públicos
	FLFieldMetaData (const QString &n, const QString &a, bool aN, bool iPK, int t, int l=0, bool c=false, bool v=true, bool ed=false, int pI=4, int pD=0, bool iNX=false, bool uNI=false, bool coun=false, const QVariant &defValue=QVariant(), bool oT=false, const QString &rX=QString::null, bool vG=true, bool gen=true, bool iCK=false)
	~FLFieldMetaData ()
QString	name () const
void	setName (const QString &n)
QString	alias () const
bool	allowNull () const
bool	isPrimaryKey () const
bool	isCompoundKey () const
int	type () const
int	length () const
bool	calculated () const
void	setCalculated (bool c)
bool	editable () const
void	setEditable (bool ed)
bool	visible () const
bool	visibleGrid () const
bool	generated () const
void	setVisible (bool v)
void	setVisibleGrid (bool v)
int	partInteger () const
int	partDecimal () const
bool	isCounter () const
bool	isIndex () const
bool	isUnique () const
void	addRelationMD (FLRelationMetaData *r)
void	setRelationList (FLRelationMetaDataList *rl)
FLRelationMetaDataList *	relationList () const
FLRelationMetaData *	relationM1 () const
void	setAssociatedField (FLFieldMetaData *r, const QString &f)
void	setAssociatedField (const QString &rName, const QString &f)
FLFieldMetaData *	associatedField () const
QString	associatedFieldFilterTo () const
QString	associatedFieldName () const
QVariant	defaultValue ()
bool	outTransaction ()
QString	regExpValidator ()
QStringList	optionsList ()
void	setOptionsList (const QString &ol)
bool	isCheck () const
bool	hasOptionsList () const
void	setMetadata (FLTableMetaData *mtd)
FLTableMetaData *	metadata () const
Métodos públicos estáticos
static QVariant::Type	flDecodeType (int fltype)
Amigas
class	FLTableMetaData
class	FLTableMetaDataPrivate

---

Descripción detallada

Mantiene la descripcion/metadatos de una campo de una tabla.

Esta clase solo tiene sentido cuando es parte de un objeto FLTableMetaData

Autor:

InfoSiAL S.L.

---

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

typedef QPtrList< FLRelationMetaData > FLFieldMetaData::FLRelationMetaDataList

Tipo de datos lista de relaciones

---

Documentación de las enumeraciones miembro de la clase

enum FLFieldMetaData::specialType

Constantes de tipos especiales no contemplados en QVariant

Valores de enumeraciones:

Serial	Tipo SERIAL o autoincremento
Unlock	Tipo de campo unlock: por Andr�s Ot�n Urbano
Check	Tipo selector de registro

---

Documentación del constructor y destructor

FLFieldMetaData::FLFieldMetaData	(	const QString &	n,
		const QString &	a,
		bool	aN,
		bool	iPK,
		int	t,
		int	l = 0,
		bool	c = false,
		bool	v = true,
		bool	ed = false,
		int	pI = 4,
		int	pD = 0,
		bool	iNX = false,
		bool	uNI = false,
		bool	coun = false,
		const QVariant &	defValue = QVariant(),
		bool	oT = false,
		const QString &	rX = QString::null,
		bool	vG = true,
		bool	gen = true,
		bool	iCK = false
	)

constructor.

Parámetros:

n	Nombre del campo
a	Alias del campo, utilizado en etiquetas de los formularios
aN	TRUE si permite nulos (NULL), FALSE si los permite (NOT NULL)
iPK	TRUE si es clave primaria, FALSE si no es clave primaria, ser clave primaria implica ser Indice y �nico
t	Tipo del campo
l	Longitud del campo en caracteres, siempre que se de tipo cadena de caracteres
c	Indica si el campo es calculado
v	Indica si el campo es visible
ed	Indica si el campo es editable
pI	Indica el n�mero de d�gitos de la parte entera
pD	Indica el n�mero de decimales
iNX	TRUE si el campo es �ndice
uNI	TRUE si el campo determina registros �nicos
coun	Indica si es un contador. Para referencias autom�ticas
defValue	Valor por defecto para el campo
oT	Indica si las modificaciones en el campo son fuera de transaccion
rX	Expresion regular utilizada como mascara de validacion
vG	Indica si el campo es visible en la rejilla de la tabla
gen	Indica si el campo es generado.
iCK	Indica si es clave compuesta

FLFieldMetaData::~FLFieldMetaData

(

)

desctructor

---

Documentación de las funciones miembro

void FLFieldMetaData::addRelationMD

(

FLRelationMetaData *

r

)

A�ade una relacion con otra tabla para este campo.

A�ade un nuevo objeto FLRelationMetaData, a la lista de relaciones para este campo.

Hay que notar que para un campo solo puede existir una sola relacion del tipo M1 (muchos a uno), por lo que en el caso de que se quieran a�adir varias relaciones de este tipo para el campo solo se tendr� en cuenta la primera. Relaciones del tipo 1M (uno a muchos) pueden existir todas las que sean necesarias. Ver FLRelationMetaData::Cardinality.

Parámetros:

r	Objeto FlRelationMetaData con la definicion de la relacion a a�adir

QString FLFieldMetaData::alias

(

)

const [inline]

Obtiene el alias del campo.

Devuelve:

Alias del campo

bool FLFieldMetaData::allowNull

(

)

const [inline]

Obtiene si permite nulos.

Devuelve:

TRUE si permite nulos, FALSE en caso contrario

FLFieldMetaData * FLFieldMetaData::associatedField

(

)

const [inline]

Devuelve el campo asociado para este campo.

Ver FLFieldMetaData::associatedField_

Devuelve:

Objeto FLFieldMetaData que define el campo asociado a este, o 0 si no hay campo asociado

QString FLFieldMetaData::associatedFieldFilterTo

(

)

const [inline]

Devuelve el nombre del campo que hay que filtrar seg�n el campo asociado.

Ver FLFieldMetaData::associatedFieldFilterTo_

Devuelve:

Nombre del campo de la tabla for�nea M-1, al que hay que aplicar el filtro seg�n el valor del campo asociado

QString FLFieldMetaData::associatedFieldName

(

)

const [inline]

Devuelve el nombre del campo asociado este.

Ver FLFieldMetaData::associatedField_

Devuelve:

Nombre del campo asociado

bool FLFieldMetaData::calculated

(

)

const [inline]

Obtiene si el campo es calculado.

Devuelve:

TRUE si el campo es calculado, FALSE en caso contrario

QVariant FLFieldMetaData::defaultValue

(

)

[inline]

Devuelve el valor por defecto para el campo.

Devuelve:

Valor que se asigna por defecto al campo

bool FLFieldMetaData::editable

(

)

const [inline]

Obtiene si el campo es editable.

Devuelve:

TRUE si el campo es editable, FALSE en caso contrario

QVariant::Type FLFieldMetaData::flDecodeType

(

int

fltype

)

[static]

Obtiene el tipo del campo convertido a un tipo equivalente de la clase QVariant

bool FLFieldMetaData::generated

(

)

const [inline]

Devuelve:

TRUE si el campo es generado, es decir, se incluye en las consultas

bool FLFieldMetaData::hasOptionsList

(

)

const [inline]

Obtiene si el campo tiene lista de opciones

bool FLFieldMetaData::isCheck

(

)

const [inline]

Obtiene si el campo es de tipo Check

bool FLFieldMetaData::isCompoundKey

(

)

const [inline]

Obtiene si es clave compuesta.

Devuelve:

TRUE si es clave compuesta, FALSE en caso contrario

bool FLFieldMetaData::isCounter

(

)

const [inline]

Obtiene si el campo es contador.

Devuelve:

TRUE si el campo es una referencia con contador

bool FLFieldMetaData::isIndex

(

)

const [inline]

Obtiene si el campo es �ndice.

Devuelve:

TRUE si el campo es �ndice, FALSE en caso contrario

bool FLFieldMetaData::isPrimaryKey

(

)

const [inline]

Obtiene si es clave primaria.

Devuelve:

TRUE si es clave primaria, FALSE en caso contrario

bool FLFieldMetaData::isUnique

(

)

const [inline]

Obtiene si el campo determina registros �nicos.

Devuelve:

TRUE si el campo determina registros �nicos, FALSE en caso contrario

int FLFieldMetaData::length

(

)

const [inline]

Obtiene la longitud del campo.

Devuelve:

La longitud del campo

FLTableMetaData * FLFieldMetaData::metadata

(

)

const [inline]

Obtiene el objeto FLTableMetaData al que pertenece

QString FLFieldMetaData::name

(

)

const [inline]

Obtiene el nombre del campo.

Devuelve:

Nombre del campo

QStringList FLFieldMetaData::optionsList

(

)

[inline]

Devuelve la lista de opciones para el campo

Devuelve:

Lista de opciones del campo

bool FLFieldMetaData::outTransaction

(

)

[inline]

Devuelve si el campo se modifica fuera de transaccion, ver FLFieldMetaData::outTransaction_.

Devuelve:

TRUE si el campo se modifica fuera de transaccion, FALSE en caso contrario

int FLFieldMetaData::partDecimal

(

)

const [inline]

Obtiene el n�mero de d�gitos de la parte decimal.

Devuelve:

El n�mero de d�gitos de la parte decimal del campo

int FLFieldMetaData::partInteger

(

)

const [inline]

Obtiene el n�mero de d�gitos de la parte entera.

Devuelve:

El n�mero de d�gitos de la parte entera del campo

QString FLFieldMetaData::regExpValidator

(

)

[inline]

Devuelve la expresion regular que sirve como mascara de validacion para el campo.

Devuelve:

Cadena de caracteres que contiene una expresion regular, utilizada como mascara para validar los valores introducidos en el campo

FLFieldMetaData::FLRelationMetaDataList * FLFieldMetaData::relationList

(

)

const [inline]

Para obtener la lista de definiciones de las relaciones.

No incluye la relacion M1

Devuelve:

Objeto con la lista de deficiones de la relaciones del campo

FLRelationMetaData * FLFieldMetaData::relationM1

(

)

const [inline]

Para obtener la relacion muchos a uno para este campo.

No incluida en relationList()

Devuelve:

Objeto FLRelationMetaData con la descripcion de la relacion muchos a uno para este campo

void FLFieldMetaData::setAssociatedField	(	FLFieldMetaData *	r,
		const QString &	f
	)		[inline]

Establece un campo asociado para este campo, y el nombre del campo de la tabla for�nea que se debe utilizar para filtrar seg�n el valor del campo asociado.

Ver FLFieldMetaData::associatedField_ Ver FLFieldMetaData::associatedFieldFilterTo_

Parámetros:

r	Objeto FLFieldMetaData que define el campo que se quiere asociar a este
f	Nombre del campo a aplicar el filtro

void FLFieldMetaData::setAssociatedField	(	const QString &	rName,
		const QString &	f
	)		[inline]

Sobrecargada por conveniencia

Parámetros:

r	Nombre del campo que se quiere asociar a este
f	Nombre del campo a aplicar el filtro

void FLFieldMetaData::setCalculated

(

bool

c

)

[inline]

Establece si el campo es calculado.

Parámetros:

c	Valor TRUE si se quiere poner el campo como calculado, FALSE en caso contrario

void FLFieldMetaData::setEditable

(

bool

ed

)

[inline]

Establece si el campo es editable.

Parámetros:

ed	Valor TRUE si se quiere que el campo sea editable, FALSE en caso contrario

void FLFieldMetaData::setMetadata

(

FLTableMetaData *

mtd

)

[inline]

Establece el objeto FLTableMetaData al que pertenece

void FLFieldMetaData::setName

(

const QString &

n

)

Establece el nombre para el campo

Parámetros:

n	Nombre del campo

void FLFieldMetaData::setOptionsList

(

const QString &

ol

)

Establece la lista de opciones para el campo

Parámetros:

ol	Cadena de texto con la opciones para el campo separada por comas, p.e. "opcion1,opcion2,opcion3"

void FLFieldMetaData::setRelationList

(

FLRelationMetaDataList *

rl

)

Asigna una lista de relaciones, a la lista de relaciones del campo.

La lista de relaciones del tipo FLRelationMetaDataList, ya construida, es asignada como la lista de relaciones del campo, en el caso de que ya exista una lista de relaciones para el campo, esta es destruida y sobreescrita por la nueva. La lista pasada a este m�todo pasa a ser propiedad del campo, y �l es el encargado de borrarla, por lo tanto no se debe borrar esta lista fuera de la clase. Si la lista que se pretende asignar es nula o vac�a este m�todo no hace nada.

Parámetros:

rl	Lista de relaciones

void FLFieldMetaData::setVisible

(

bool

v

)

[inline]

Establece si el campo es visible.

Parámetros:

v	Valor TRUE si se quiere poner el campo como visible, FALSE en caso contrario

void FLFieldMetaData::setVisibleGrid

(

bool

v

)

[inline]

Establece si el campo es visible en la rejilla de la tabla.

Parámetros:

v	Valor TRUE si se quiere poner el campo como visible, FALSE en caso contrario

int FLFieldMetaData::type

(

)

const [inline]

Obtiene el tipo del campo.

Devuelve:

El tipo del campo

bool FLFieldMetaData::visible

(

)

const [inline]

Obtiene si el campo es visible.

Devuelve:

TRUE si el campo es visible, FALSE en caso contrario

bool FLFieldMetaData::visibleGrid

(

)

const [inline]

Obtiene si el campo es visible en la rejilla de la tabla.

Devuelve:

TRUE si el campo es visible en la rejilla de la tabla, FALSE en caso contrario

---

Documentación de las funciones relacionadas y clases amigas

friend class FLTableMetaData [friend]

friend class FLTableMetaDataPrivate [friend]

---

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

• src/flbase/FLFieldMetaData.h
• src/flbase/FLFieldMetaData.cpp