Catálogos

¿Qué es un catálogo?

Un catálogo es un componente de ODL que se define como instancia en las definiciones de contenedor, tanto en definiciones de sistema como en definiciones de tipo contenedor. También es posible definir un tipo de catálogo para definir otros a partir de èl, pero en estos casos, su definición no se realizará bajo el dominio de ningún contenedor, sino que será una definición independiente de cualquier otra.

¿Para qué sirve?

Los catálogos se utilizan para obtener listas de objetos mediante sentencias SQL, aunque, a diferencia de las colecciones, no almacenan ningún objeto, ni crean ninguna tabla en la base de datos, y tampoco es posible crear ni acceder a los objetos que se listan (salvo una excepción). Simplemente, se ejecutará la sentencia SQL al abrir el catálogo que hayamos declarado y eso nos devolverá una lista con la información seleccionada. Esto nos va a permitir crear listas con información que provenga de diferentes tablas del sistema, aprovechando las posibilidades de las sentencias SQL.

La excepción a la que hemos hecho mención, tiene mucho que ver con las propiedades RRC, DRC y Name de un objeto, ya que, sólo en caso de incluir estos campos en la sentencia SQL, podríamos acceder a los objetos que indiquen ese RRC, DRC y Name.

Sintaxis

Definición de tipo

tipo [Nombre] es catalogo
    -descripcion = "Descripción"
    -sentencia = "SELECT ... FROM ..."
fin

Definición como instancia

tipo [Contenedor] es contenedor          //requiere la creación de un objeto tipo Contenedor
    ...
    ...              //otras definiciones
    ...
    [Nombre] es catalogo
        -sentencia = "SELECT ... FROM ..."
    fin
    ...
    ...              //otras definiciones
    ...
fin

o

[Contenedor] es contenedor           //catálogo incluído en una definición de sistema
    ...
    ...              //otras definiciones
    ...
    [Nombre] es catalogo
        -sentencia = "SELECT ... FROM ..."
    fin
    ...
    ...              //otras definiciones
    ...
fin

Creación de vistas

Cuando un centro se encuentra en explotación, es posible que sea necesario cambiar en algún momento las sentencias SQL incluídas en las definiciones de catálogos para obtener otros resultados que se requieran. De forma que tendremos que ir al código correspondiente, variar la sentencia SQL y actualizar el diccionario de dicho centro para reflejar los cambios realizados.

Con el fin de evitar cambios en el código fuente del centro, hacemos uso de las vistas en la base de datos.

Podríamos definir una vista como una tabla lógica, donde se reflejan los datos que seleccionamos de las distintas tablas de la base de datos. No es un concepto físico, es decir, no se realiza una copia física de los datos obtenidos, de manera que si hay modificaciones en las tablas, éstos serán aplicados a aquellas vistas que se vean afectadas.

Por tanto, la utilización de vistas nos permite abstraer el modelo de la base de datos subyacente, de forma que en vez de modificar la sentencia SQL de un catálogo por ejemplo, modificaremos la vista de la manera que nos convenga. Por tanto, la petición SQL del catálogo, tendremos que hacerla, no sobre las tablas, sino sobre la vista o vistas creadas.

Las vistas a crear tendremos que definirlas en ficheros .sql que almacenaremos en la carpeta Installation del modelo. Además, el nombre del fichero tendrá que ir siempre precedido de los caracteres TV$.

Al instalar un centro, los ficheros que se incluyan en dicha carpeta serán ejecutados, por lo que las sentencias incluídas en los .sql serán ejecutadas y por consiguiente, las vistas serán creadas. En caso de modificar alguna vista, se deberá actualizar el centro para que vuelva a ejecutar la sentencia modificada.

Habrá que tener en cuenta también el gestor de la BBDD que utiliza el centro, ya que pueden tener distintas formas de tratar las vistas. Por ejemplo, Oracle no permite la actualización de vistas, mientras que SQL Server sí.

Atributos

Atributos genéricos de la definición de un componente

Atributo	Tipo	Valor por defecto	Observaciones
ayuda	Texto		Marcador en la ayuda del centro.
descripcion	Texto	[Nombre]	Comentario sobre el componente.
etiqueta	Texto	[Nombre]	Etiqueta del componente.
orden	Entero	0	Indica la prioridad del componente al ordenarlo sobre el recurso.
visible	Lógico	Verdadero	Indica si el componente es visible.

Atributos de la definición de catálogo

Atributo	Tipo	Valor por defecto	Observaciones
sentencia	Texto		Sentencia SQL.

Ejemplo

Para mostrar un ejemplo de cómo crear un catálogo haciendo uso de las vistas, utilizaremos el sistema de información creado en la serie de artículos "Construir una aplicación paso a paso".

Concretamente, nos centraremos en la Tarea E donde se muestra cómo crear un catálogo, aunque en este caso, hace uso de una exportación previa. La sentencia SQL del catálogo se lanza sobre la tabla TR$ENTRADAS creada en la exportación.

Por tanto, recomendamos echar un vistazo a dicho artículo antes de continuar con el ejemplo.

Una vez visto el artículo, y utilizando la exportación declarada, vamos a crear un catálogo que realice la misma operación pero haciendo uso de una vista.

Por tanto, crearemos una vista que realice la misma petición que el catálogo de la Tarea E. La vista la crearemos para SQL Server:

CREATE VIEW TV$DOCUMENTOS_ENTRADAS AS

SELECT

          ENTRADAS.RRC, ENTRADAS.DRC, ENTRADAS.NAME, ENTRADAS.REMITENTE AS ""Remitente"", 
          ENTRADAS.FECHA_PRESENTACION AS ""Fecha de presentación"",
          DOCUMENTOS.NOMBRE AS ""Documento""

FROM

          TR$ENTRADAS ENTRADAS,
          TR$ENTRADAS#DOCUMENTOS DOCUMENTOS 

WHERE

          ENTRADAS.RRC = DOCUMENTOS.RRC

Se creará en la base de datos una vista cuya información obtenida será igual que la del catálogo definido en la Tarea E. Ahora sólo faltaría modificar la sentencia SQL del catálogo para que lance la petición sobre la vista:

[Registro de documentación] es contenedor
    [Documentación] es catalogo
        -sentencia = "SELECT * FROM TV$DOCUMENTOS_ENTRADAS";
    fin
fin

De esta manera, hemos conseguido abstraer el código de las posibles modificaciones que se pudieran dar para la obtención de datos.

Si fuera necesario realizar algún cambio, se haría en la vista, y la sentencia SQL del catálogo no haría falta modificarla.

Como ya hemos dicho, el código que crea la vista la guardaremos en un fichero .sql. Este fichero lo almacenaremos en la carpeta Installation de nuestro modelo para que al instalarlo se ejecute y se cree la vista.