Software Design Description. Versión /Enero/2012 TBA. Christian R. Lemus G. Pontificia Universidad Javeriana

Transcripción

1 Software Design Description Versión /Enero/2012 TBA Christian R. Lemus G. Pontificia Universidad Javeriana i

2 1 Tabla de contenido 1 Tabla de contenido Introducción Propósito Alcance Referencias Resumen del documento Diagrama de despliegue Diseño Arquitectural Diseño de estructura de datos Diagrama de casos de uso Diseño lógico de la aplicación Diseño Detallado

3 2 Tabla de ilustraciones Ilustración 1: Diagrama de Despliegue y componentes... 4 Ilustración 2: Diagrama de Componentes... 5 Ilustración 3: Modelo de datos XML para la documentación de componentes BPMN... 5 Ilustración 4: Modelo de datos XML para la documentación de la simulación de pantallas... 6 Ilustración 5: Diagrama de Casos de Uso TBA... 6 Ilustración 6: Diagrama de Clases... 8 Ilustración 7: Diagrama de secuencia - Documentación de Actividad

4 3 Introducción TBA es una herramienta, que se desarrollará como una extensión a JDeveloper, para apoyar el diseño de procesos de negocio, las características propias del producto son: La posibilidad de documentar cada componente de un diagrama BPMN, con el fin de refinar la comunicación con los desarrolladores de software. La posibilidad de documentar las pantallas que se simulan en el proceso de validación de pantallas de modo que la generación de dichas pantallas en tiempo de ejecución se facilite. La inclusión de la guía metodológica en los archivos de ayuda del IDE para referencia en cualquier momento. La generación de dicha documentación en archivos XML un estándar ampliamente usado por la comunidad de desarrolladores en el mundo. La integración de la documentación del diseño BPMN y la facilidad de hacer una consulta sin tener que cambiar de ambiente, es un valor agregado a la comodidad del usuario, y a la eficiencia de este también. 3.1 Propósito Este documento busca realizar una descripción juiciosa del proceso de diseño de la herramienta TBA. 3.2 Alcance La metodología de diseño utilizada es aquel presentado en el SWEBOK[1] donde se define inicialmente el diseño arquitectural, que comprende el diseño descompuesto y organizado en componentes, para luego realizar el diseño detallado que abarca el comportamiento especifico de dichos componentes. 3.3 Referencias [1] A. Abran, Guide to the software engineering body of knowledge, 2004o ed. Los Alamitos Calif.: IEEE Computer Society, [2] «CVS - Open Source Version Control». [Online]. Available: [Accessed: 27-Ene-2012]. [3] «tutorial1-cvs-4up.pdf (objeto application/pdf)».. [4] «Beginner Guide to Building JDeveloper Extensions». [Online]. Available: [Accessed: 27-Ene-2012]. [5] «The Apache Xerces Project - xerces.apache.org». [Online]. Available: [Accessed: 27-Ene-2012]. [6] «Welcome to The Apache Software Foundation!» [Online]. Available: [Accessed: 27-Ene-2012]. [7] «Java Communications API». [Online]. Available: [Accessed: 27-Ene- 2012]. 3

5 [8] «How to use Model-View-Controller (MVC)». [Online]. Available: [Accessed: 28-Ene-2012]. 3.4 Resumen del documento < Describe the contents and organization of the rest of this document. Since there is already a Table of Contents, this overview will be less formal but more informative. Describe the remaining sections. > 4 Diagrama de despliegue El diagrama de despliegue provee una vista física del sistema, el diagrama resultante es bastante simple, pues en términos de comunicación TBA no es complejo, así que de una vez se presenta la vista de componentes en este diagrama, cabe anotar que se asume que los usuarios del sistema están usando un sistema de versiones concurrente (CVS[2]), dado que este es el escenario más común en el desarrollo de software distribuido, asi que el diagrama de despliegue refleja también el despliegue de un sistema de versiones concurrentes[3]. Ilustración 1: Diagrama de Despliegue y componentes TBA incluye dos artefactos en formato XML, que añade a los archivos fuentes de un proyecto, de modo que la sincronización los cambios al diseño concurrente lo realiza el servidor CSV 5 Diseño Arquitectural En esta sección se presentaran los componentes de terceros que se utilizaron para la integración con el IDE y los componentes que se utilizaron para facilitar la generación de archivos XML de modo que fuera transparente el manejo de cadenas. 4

6 Ilustración 2: Diagrama de Componentes Es poco lo que hay que decir de este diagrama, JDeveloper Extends[4] es la interfaz que presta JDeveloper para la creación de extensiones al IDE, Xerces[5] es un proyecto de Apache[6] para la generación de analizadores XML, que en conjunto con Javax[7] parte del API de comunicaciones de java, permiten la persistencia de la documentación del diseño de procesos de negocio. 6 Diseño de estructura de datos. Esta sección del documento de diseño presenta la estructura de los archivos generados para guardar la documentación, en relación a los formatos propuestos en la guía metodológica. Ilustración 3: Modelo de datos XML para la documentación de componentes BPMN 5

7 Ilustración 4: Modelo de datos XML para la documentación de la simulación de pantallas 7 Diagrama de casos de uso El diagrama de casos de uso ya fue presentado en el documento de visión y especificación de requerimientos, contiene las diferentes funcionalidades que debe ofrecer la herramienta TBA. Ilustración 5: Diagrama de Casos de Uso TBA 6

8 8 Diseño lógico de la aplicación Ya entrando en más detalle de la implementación de la herramienta, a continuación se presenta el diagrama de clases de TBA, la arquitectura de software usada en este desarrollo fue MVC (Model-View-Controller)[8], de modo que la gestión de los archivos quedara en el paquete del Modelo, la comunicación con el IDE en el del Controlador y el uso de swing para la interfaz grafica quedara aislada en el paquete de la Vista. El siguiente diagrama de clases comprende las clases desarrolladas en este proyecto, se omite un componente, el archivo extension.xml el cual define el modo en el cual es IDE se comunicará con la extensión aquí desarrollada, en este archivo se define, en que componentes del IDE estará disponible cada componente de la extensión, asi como las Clases controladoras de los eventos del IDE, estas clases que se añaden al extension.xml están localizadas en el paquete Controller 7

9 Ilustración 6: Diagrama de Clases 8

10 En este diagrama de clases se omiten los atributos de la vista debido a la gran extensión de estos para cada componente grafico, también se puede observar que el paquete Modelo respeta la definición del modelo de datos XML facilitando así su abstracción. 9 Diseño Detallado Todos los procesos tanto de documentación son similares, tanto si son para documentar componentes BPMN, como si son para documentar los componentes de las pantallas de simuladas. El proceso inicia con una interacción con el IDE, para luego generar la vista adecuada, una se interactúa con la vista, la información brindada pasa de nuevo al controlador, que posteriormente da orden al modelo de persistir los datos. Ilustración 7: Diagrama de secuencia - Documentación de Actividad De este diagrama se pueden inferir el resto de interacciones con el las diferentes vistas para la documentación. 9