Colecciones

¿Qué es una colección?

Una colección es un componente de ODL que se define a nivel de contenedores, tanto en definiciones de tipo, como en definiciones de sistema. Permiten almacenar objetos de igual o distinto tipo, y para cada definición de colección se generará una tabla en la base de datos. Además, es posible definir varias colecciones en una misma definición de contenedor.

Es un componente importante, ya que para poder crear objetos en un centro, es necesario que sus correspondientes definiciones estén incluídas en al menos una colección.

Siempre que definamos una colección en un contenedor, no podremos declararla como una definición de tipo, sino que tendremos que definirla como una instancia. Podremos declarar un tipo de colección, pero nunca en un contenedor. Esto nos servirá para declarar nuevas definiciones a partir de él.

Como hemos dicho, la definición de una colección genera una tabla en la base de datos. Para su creación, será necesario indicar el nombre de la tabla. Esto lo hacemos utilizando el atributo nombre_tabla, que acepta una ristra como valor. El nombre de la tabla tendrá que estar siempre precedido del prefijo TC$:

[Definición] es contenedor
    [Contenido] es coleccion     //Declaración como instancia. Se creará la colección.
        -nombre_tabla = "TC$NOMBRE";
        ...
        ...
        ...
    fin
fin

tipo [Definición] es coleccion     //Declaración como tipo, fuera de la definición de un contenedor. No se crea ninguna colección.
    -nombre_tabla = "TC$NAME";          //Se utilizará para definir otras colecciones.
    ...
    ...
    ...
fin 

Declaraciones de contenido

A la hora de definir una colección, es necesario declarar el contenido que tendrá la colección. Es decir, se especificarán todas las definiciones de contenedor correspondientes a los tipos objetos que queramos almacenar en la colección.

Para ello, utilizaremos la palabra reservada contiene, de manera que incluiremos un contiene por cada definición de contenedor.

Su sintaxis sería la siguiente:

...
contiene [Definición de contenedor]
...

Declaraciones de columna

Como hemos dicho, una colección genera una tabla en la base de datos del centro, pero también habrá que especificar las columnas que se crearán en ella.

Con la palabra reservada columna seguida de un nombre, detallaremos dichas columnas. El nombre especificado hará referencia al título de la columna a nivel de egExplorer, no de la base de datos. Para especificar el nombre de la columna en la base de datos utilizaremos el atributo columna_bd.nombre. Ambos nombres no tienen por qué coincidir, el nombre de la columna en la tabla puede ser distinto al del listado en el egExplorer.

Además, también es necesario indicar el campo que almacenará cada una de las columnas. El atributo origen nos permite asignarle una expresión que especifique la definición de un campo, que tendrá que estar incluído en la definición de contenedor que contenga la colección.

...
columna [Nombre de la columna]
    -columna_bd.nombre = "NOMBRE";
    -origen = [Formulario].[Campo];
...

NOTA: En caso de que la colección contenga objetos de distinto tipo, los campos que se especifiquen en las columnas con el atributo origen tendrán que estar definidos en los contenedores. Es decir, la ruta tendrá que ser exactamente igual en todas las definiciones de contenedor.

Sintaxis

Una vez sabemos los elementos necesarios que hay que incluir para una correcta definición de colección, veamos una sintaxis completa con un ejemplo concreto.

tipo [Expediente] es contenedor
    [Datos generales] es formulario
        [Nº de expediente] es timbre
            -certificado.valor = [&Valor_secuencia];
            -certificado.secuencia.nombre = "STR$EXPEDIENTE"; 
            -certificado.secuencia.longitud = 5; 
        [Fecha de alta] es fecha
        [Tipo de solicitud] es texto
            -edicion.seleccion = verdadero;
            -edicion.valores = $matriz("Solicitud_1","Solicitud_2","Solicitud_3");
            -edicion.desplegable = verdadero;
   fin
fin

[Expedientes] es contenedor
    [Contenido] es coleccion
        -nombre_tabla = "TC$EXPEDIENTES";

        contiene [Expediente]   //Esta colección almacenará objetos de tipo Expediente

        columna [Número de expediente]
            -columna_bd.nombre = "NUMERO_EXPEDIENTE";
            -origen = [Datos generales].[Nº expediente];

        columna [Fecha de creación]
            -columna_bd.nombre = "FECHA";
            -origen = [Datos generales].[Fecha de alta];

        columna [Tipo de solicitud]
            -columna_bd.nombre = "TIPO_SOLICITUD";
            -origen = [Datos generales].[Tipo de solicitud];
    fin
fin