Notes of the gvSIG 2.0 workshop

Estos son los apuntes que tomé sobre gvSIG 2.0 en las últimas Jornadas GvSIG.

Pre-Requisitos

  • Java
  • Eclipse
  • Ant (opcional)
  • Maven (opcional)
  • gvSIG (esto es recursivo :))

La principal ventaja de gvSIG 2.0 es que puedes crear un plugin sin saber cómo funciona gvSIG ni tener que compilarlo. Tenemos una instalación de gvSIG que despliega unos binarios que genera el workspace.. But we don’t have to change the source code. Unless, of course, something doesn’t work (bugs) or we have to add some new functionality to the core. Better if you don’t touch it, ask the developers and they will take care.

Creating the workspace

With the binary, there is a wizard which creates an Eclipse workspace with a default template. That leaves all set up but to compile our extension. It also includes a wizard to easily generate installables. These wizards are accessible through the application, at the application menu.

Org.gvsig.tools is the basic infrastructure library to develop plugins. The main functionality is focused on the registration of extension points, utilities to separate API, implementations, SPI (service provider), and monitoring tasks (which in version 1.0 used to freeze the application). This library also supports events, persistence, etc …

gvSIG Plugins

Una biblioteca es un fichero jar. Cuando nuestra aplicación contiene el archivo jar, org.gvsig.tools prepara e inicializa esta biblioteca dentro del núcleo. Las clases en la biblioteca implementan la interfaz Library (AbstractLibrary).

Los managers (PluginsManager) son el punto de entrada a las funcionalidades. Son como factorías (singletons) (al menos uno por librería) que levanta instancias de las funcionalidades incluídas dentro de la librería. También guarda la configuración del módulo.

Los locators (PluginsLocator) permiten registrar implementaciones de managers. Nos permiten recuperar la implementación de manager de un API en concreto. "Dame el manager de esta librería."

Un plugin es una pieza que aporta una funcionalidad: botones y barras de herramientas, opciones de menús, proveedores de datos y tipos de documentos. Andami no ha evolucionado mucho desde la versión 1.x. Andami es el marco para los complementos.

El plugin siempre tendrá al menos dos ficheros:

  • config.xml que indica las clases que implementan el plugin, las dependencias y los menús
  • package.info que indica la versión, el nombre, el build,... del plugin.

gvSIG Extensions

Una extensión (IExtension) es un conjunto de herramientas asociadas con un complemento dentro de una barra de herramientas o menú y funcionan en conjunto. Un grupo de plugins, puedes decir. La extensión que implementa ExclusiveUIExtension especifica qué herramientas son o no visibles, sin tocar el código del núcleo.

Para crear un nuevo complemento, utilizamos la herramienta de generación de menús de complementos disponibles en la versión de desarrollo. Esto genera el espacio de trabajo automáticamente e instala el complemento desde el cual generamos el complemento. Si no tienes una versión de desarrollo, tendrás que compilar gvSIG de los fuentes..

Conviene ir haciéndolo mientras se leen estos apuntes o puedes perderte.

440/5000 El complemento consta de dos proyectos de maven: org.gvsig.plugin y org.gvsig.plugin.app. org.gvsig.plugin proporciona la funcionalidad de la biblioteca independientemente de gvSIG (lógica de negocios). Puede tener dependencias de biblioteca, pero debe poder operar sin tener que abrir la aplicación. Es decir, no requiere nada de Andami, por ejemplo. En org.gvsig.plugin.app.mainplugin (dentro de org.gvsig.plugin.app) implementaremos la funcionalidad.

Los paquetes "api" deben contener interfaces y los paquetes "impl" deben contener implementaciones.

Ahora el espacio de trabajo está listo para trabajar con Eclipse si importamos el proyecto con el complemento de Maven. Si tomamos una plantilla adecuada para generar las fuentes de los complementos, se realiza casi todo el trabajo (excepto la lógica de negocios exacta de nuestro complemento).

Consejos Finales

Es importante tener un proyecto java para probar nuestro plugin con su propio main, sin tener que iniciar gvSIG. También se recomienda que la biblioteca tenga pruebas unitarias. Es decir, podemos hacer una aplicación con todo el poder de gvSIG, pero sin usar gvSIG en sí, es decir, como si fuera una poderosa biblioteca GIS. Conclusión: si lo hacemos bien, incluso podríamos usar nuestro complemento en otra aplicación sin aplicación ... como GoFleet.

Each plugin contains own installer, which created by a wizard inside the application.