ATLAS MANUAL DE USUARIO ARBOL ACCESIBLE

Transcripción

1 ATLAS MANUAL DE USUARIO ARBOL ACCESIBLE Versión 1.3 Área de Aplicaciones Especiales y Arquitectura de Software

2 Hoja de Control Título Documento de Referencia Responsable Manual de Usuario del NORMATIVA ATLAS Área de Aplicaciones Especiales y Arquitectura de Software Versión 1.3 Fecha Versión 27/02/2012 Registro de Cambios Versión Causa del Cambio Responsable del Cambio Fecha del Cambio 1.0 Versión inicial del documento 1.1 Actualizada captura del componente 1.2 Se modifica el nombre del Area 1.3 Error en el apartado 4.3, se corrige la etiqueta con la que se debe usar el componente en la página. Área de Integración y Arquitectura de Aplicaciones Área de Integración y Arquitectura de Aplicaciones Área de Aplicaciones Especiales y Arquitectura de Software Área de Aplicaciones Especiales y Arquitectura de Software 26/05/ /02/ /09/ /02/ de 13

3 Índice 1. INTRODUCCIÓN AUDIENCIA OBJETIVO CONOCIMIENTOS PREVIOS DESCRIPCIÓN INSTALACIÓN Y CONFIGURACIÓN INSTALACIÓN CONFIGURACIÓN Paso 1: Modificación del fichero web.xml Paso 2: Configuración del entorno de spring USO PASO 1: DEFINICIÓN DEL ESPACIO DE NOMBRES DE ETIQUETAS DE ATLAS PASO 2: CONFIGURACIÓN DE LA PÁGINA PASO 3: INSERCIÓN EN LA PÁGINA DE LA ETIQUETA DE ATLAS PASO 4: CREACIÓN DE LA CLASE DE SERVICIO PASO 5: CREACIÓN DE LA CLASE DE DAO RECOMENDACIONES Y BUENAS PRÁCTICAS EJEMPLO DE USO PREGUNTAS MÁS FRECUENTES ENLACES RELACIONADOS de 13

4 1. INTRODUCCIÓN Este documento contiene el manual de uso del componente Árbol Accesible del framework Atlas. En él se incluye información sobre cómo utilizar dicho componente en una aplicación Web, así como información acerca de la configuración de los parámetros fundamentales del componente AUDIENCIA OBJETIVO Este documento está orientado a toda aquella persona que esté desarrollando una aplicación Web basada en el Framework Atlas y necesite utilizar componentes de presentación en su aplicación Web CONOCIMIENTOS PREVIOS Para un completo entendimiento del documento, el lector deberá tener conocimientos previos sobre las siguientes tecnologías: Java Server Faces (JSF) Facelets Spring Framework Hibernate Para saber más sobre dichas tecnologías, consultar el apartado de este documento, Enlaces Relacionados. 2. DESCRIPCIÓN Este componente sirve para mostrar un conjunto de datos organizados jerárquicamente en forma de árbol. Los nodos de este árbol se pueden desplegar o replegar. Cuando se despliega un nodo, su contenido será obtenido mediante AJAX a través de un parámetro del componente que consistirá en el servicio de Spring correspondiente. El componente Árbol Accesible cumple la normativa de accesibilidad Doble A. La apariencia visual del componente es la siguiente. 4 de 13

5 3. INSTALACIÓN Y CONFIGURACIÓN En este apartado se incluye información sobre la instalación y la configuración del componente árbol accesible INSTALACIÓN El componente del árbol accesible ya viene instalado en el arquetipo Web, incluido con el módulo de componentes visuales. Por este motivo no es necesaria una instalación adicional si se parte del arquetipo CONFIGURACIÓN Una vez instalado el componente, se debe proceder a su configuración. La configuración afecta a los ficheros de configuración de Spring, puesto que es necesario crear un servicio de Spring para dar respuesta a un tipo de árbol dado. En los siguientes pasos se muestra la configuración detallada del componente: Paso 1: Modificación del fichero web.xml Nota: En el fichero web.xml del arquetipo web ya se encuentran estas líneas para habilitar el servlet, por lo que en principio este paso puede omitirse. Hay que añadir la referencia al Servlet necesario para el funcionamiento del componente, modificando el fichero web.xml de la aplicación (directorio src\main\webapp\web-inf) según el siguiente ejemplo: web.xml <servlet> <description>definicion del Servlet para el componente Tree</description> <servlet-name>nodosarbolservlet</servlet-name> <servlet-class> atlas.componentes.servlet.nodosarbolservlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>nodosarbolservlet</servlet-name> <url-pattern>/nodosarbolservlet</url-pattern> </servlet-mapping> Paso 2: Configuración del entorno de spring Debe verificarse que en el fichero de configuración de Spring se declare un bean que se encargue de dar respuesta a un tipo de árbol dado. Por ejemplo, si se quiere introducir en una página un árbol que tenga provincias y localidades de España, en su primer y segundo nivel respectivamente, entonces, habría crear un servicio con esta composición mediante una configuración que quedaría de la siguiente manera: applicationcontext-services.xml 5 de 13

6 <bean id="arbolaccprovmuniservice" class="atlas.componentes.service.tree.impl.treeaccserviceimpl"> <property name="nodesservicemap"> <map> <entry key="1" value-ref="provincianodesservice" /> <entry key="2" value-ref="municipionodescountservice" /> </map> </property> <property name="mostrarnumeronodoshijos" value="true" /> </bean> El usuario deberá definir los campos señalados en rojo en la figura anterior. A continuación se explican algunos de los valores de esta configuración: Parámetro Descripción Atributo id Atributo value-ref Atributo value Identificador del servicio de Spring. Se pasará como parámetro al componente en la etiqueta identificadorarbol Identificadores de los servicios de Spring que darán respuesta a cada petición de obtención de los elementos para cada nivel. Valor booleano para la propiedad mostrarnumeronodoshijos, para que se muestren o no el número de hijos de un nodo dado. A su vez, es necesario definir en la configuración los servicios de Spring que darán respuesta a la petición de los elementos de un determinado nivel. Las clases correspondientes deben implementar la interfaz atlas.componentes.service.tree.nodesservice y la interface atlas.componentes.service.tree.nodescountservice, el segundo interface es obligatorio sólo en el caso de activar el booleano en mostrarnumeronodoshijos y querer mostrar el número de hijos en ese nivel que representa el servicio. Estos servicios, además, estarán relacionados con las clases de acceso a datos que serán en realidad las que realizarán las peticiones a la base de datos, ficheros XML, o cualquier otro sistema. A continuación se presenta un ejemplo de configuración del servicio que da respuesta a la petición de las provincias de España para el ejemplo anterior: applicationcontext-services.xml <bean id="provincianodesservice" class="atlas.samples.services.provincianodesservice"> <property name="provinciasucadao"> <ref bean="provinciasucadao" /> </property> </bean> El usuario deberá definir los campos señalados en rojo en la figura anterior. A continuación se explican algunos de los valores de esta configuración: Parámetro Descripción 6 de 13

7 Atributo id Atributo ref Identificador del bean que corresponde con un nivel del árbol. Dao asociado al bean, con el que se accederá a los datos. 7 de 13

8 4. USO Una vez instalado el módulo de componentes puede procederse a su utilización. Para ello deben realizarse los pasos indicados en los siguientes apartados: 4.1. Paso 1: Definición del espacio de nombres de etiquetas de Atlas Es necesario crear un fichero xhtml y establecer la definición del espacio de nombres para las etiquetas de componentes de Atlas. Un ejemplo de cabecera de fichero xhtml es la siguiente: Fichero.xhtml <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" " <html xmlns=" xml:lang="es" xmlns:ui=" xmlns:h=" xmlns:f=" xmlns:atlas=" Paso 2: Configuración de la página Para usar el componente hay que definir una parte de javascript necesaria para la librería dhtmlgoodies de javascript que implementa el ábol accesible. Aparecen en otro color los valores que deben ser introducidos. Por ejemplo, los valores de los identificadores de los componentes Árbol Accesibles separados por comas. En este caso, el único elemento es provincias_tree porque en nuestro ejemplo sólo hay un árbol. fichero.js <script type="text/javascript"> var idoffoldertrees = ['provincias_tree']; var imagefolder = 'img/'; // Path to images var folderimage = 'arbolacc_folder.gif'; var plusimage = 'arbolacc_plus.gif'; var minusimage = 'arbolacc_minus.gif'; var useajaxtoloadnodesdynamically = true; var ajaxrequestfile = 'nodosarbolservlet'; var initexpandednodes = ''; var contextmenuactive = false; var ajaxobjectarray = new Array(); var treeulcounter = 0; var nodeid = 1; window.onload = inittree; </script> Asimismo, será necesario incluir este fichero de javascript dentro de la página xhtml en la que queramos utilizar el árbol: Fichero.xhtml <script type="text/javascript" src="js/fichero.js"/> 8 de 13

9 4.3. Paso 3: Inserción en la página de la etiqueta de Atlas Es necesario introducir una etiqueta atlas:arbol que será la que forme el árbol en la página. A continuación se muestra un ejemplo para introducir un árbol del tipo definido en el ejemplo de la sección de Configuración de este documento. Fichero.xhtml <atlas:arbolaccesible identificadorarbol="provincias_tree" servicioparaobtenernodos="arbolaccprovmuniservice"/> Los atributos del componente son los siguientes: Nombre atributo Obligatorio Descripción identificadorarbol SI Identificador del componente en la página. Sirve para ser invocado desde javascript con la librería de javascript que implementa el componente dhtml_goodies. Es un parámetro obligatorio servicioparaobtenernodos SI Identificador, del fichero de configuración de Spring, correspondiente al servicio de Spring encargado de dar respuesta al componente para la obtención de los elementos del árbol. Es un parámetro obligatorio 4.4. Paso 4: Creación de la clase de servicio Es necesario crear la clase de servicio de Spring para obtener los datos para un nivel dado. En este ejemplo se muestra el aspecto de la clase para obtener los municipios de España: MunicipioNodesCountService.java 9 de 13

10 public class MunicipioNodesCountService implements NodesService, NodesCountService { private MunicipioDAO municipiodao; public List<? extends Node> getnodes() throws DataAccessException { return municipiodao.findmunicipiosall(); public List<? extends Node> getnodes(object clave) throws DataAccessException { return municipiodao.findmunicipiosdeprovincia(clave); public MunicipioDAO getmunicipiosucadao() { return municipiodao; public void setmunicipiodao(municipiodao municipiodao) { this.municipiodao = municipiodao; public long getcount(object clave) { return this.getmunicipiosucadao().countprovmunicipio((string)clave); 4.5. Paso 5: Creación de la clase de DAO Es necesario crear una clase de acceso a datos para obtener los datos para un determinado nivel bajo las condiciones de filtrar por una cierta clave o bien sin filtrar por clave, como respuesta a una petición desde un método de la clase de servicio NodesService. En el siguiente ejemplo se muestra el detalle de la clase que accede a los datos de municipios de España, como respuesta a métodos de la clase MunicipioNodesCountService, que es la correspondiente al servicio que se definió en el ejemplo de configuración del fichero de Spring, para obtener los municipios. MunicipioDAOImpl.java 10 de 13

11 public class MunicipioDAOImpl extends HibernateDaoSupport implements MunicipioDAO { public List<Municipio> findmunicipiosall() { List<Municipio> lista = new ArrayList<Municipio>(); ---- Código para recuperar los municipios return lista; public long countprovmunicipio(object clave) { List<Municipio> list = this.findmunicipiosdeprovincia(clave); return list.size(); public List<Municipio> findmunicipiosdeprovincia(final Object clave) throws DataAccessException{ List<Municipio> lista = new ArrayList<Municipio>(); Código para recuperar los municipios que están en la provincia indicada por el parámetro clave return lista; La forma en la que está implementado el DAO puede variar pero debe devolver aquellos elementos que esperan los métodos correspondientes del servicio que lo utiliza. Observar que los objetos devueltos por las búsquedas deben de implementar el interface atlas.componentes.service.tree.node, indicando el nombre a mostrar, la clave de ordenación y un método de comparación entre nodos Recomendaciones y buenas prácticas No es recomendado para el bueno uso del componente crear árboles que tienen un número elevado de elementos en cualquiera de sus niveles, puesto que puede afectar a la ergonomía del mismo y al rendimiento del componente Ejemplo de Uso Se puede ver un ejemplo de dicho componente en la aplicación de demostración de componentes, bajo la siguiente secuencia de navegación: Inicio > Árbol Jerárquico > Árbol accesible 11 de 13

12 5. PREGUNTAS MÁS FRECUENTES En este apartado se incluyen una lista de preguntas más frecuentes sobre el componente. Pregunta: Dónde puedo encontrar información general sobre los componentes? Respuesta: En la aplicación de demostración de los componentes del Framework Atlas Pregunta: Cómo se ha implementado el componente en su capa de presentación? Respuesta: El árbol accesible se implementó como un Custom Component de Faces, que da respuesta a una etiqueta mediante un objeto que hereda de UIOutput del API de Faces. Además se emplea en el HTML que construye este componente la librería dhtml_goodies, que accede a un Servlet mediante peticiones Ajax. 12 de 13

13 6. ENLACES RELACIONADOS Producto Ajax4JSF Barbecue Commons BeanUtils Commons Configurations Facelets Hibernate Hibernate Annotations JAXB Jcaptcha JPA JSF JSFUnit Log4J MyFaces Core RichFaces Spring Spring Security Tomahawk Velocity URL commons.apache.org/beanutils/ jcaptcha.sourceforge.net/ de 13