Mostrando las entradas con la etiqueta Programacion. Mostrar todas las entradas
Mostrando las entradas con la etiqueta Programacion. Mostrar todas las entradas

Scriptlets en el plugin de iReport en Netbeans

Trabajando con Scriptlets en el plugin de iReport en Netbeans


Tarde o temprano tenía que comenzar a escribir sobre lo que más me gusta: la programación. Así que teniendo la necesidad de hacer un reporte con parámetros opcionales en JasperReports,  los cuales tienen su pega  y uno que otro quebradero de cabeza. Y una cosa me llevó a la otra, para resolver el problema de los parámetros opcionales lo cual explico en Trabajando con parámetros opcionales en JasperReports llegué a tener que resolver lo que aquí nos ocupa, los famosos Scriplets, por lo que no estaría de más que también lo leyeran.


Primero que nada ¿Qué son los Scriptlets? … Bueno, básicamente son clases java que heredan de la clase JRDefaultScriptlet de la librería de JasperReports para que puedan ser reconocidas en un reporte y poder invocar sus métodos como si se tratara de cualquier variable o parámetro.


Ahora bien, el caso mío es que no estoy diseñando mi reporte en iReport directamente sino en el plugin de Netbeans, por lo que el proceso es un tantito diferente respecto al classpath del iReport que es lo que normalmente encontramos en los tutoriales de la red.


Mi necesidad era darle formato a un valor de la clase java.util.Date para ser usado en el query SQL del reporte, ya que el formato que devuelve el método .toString() de la clase no nos devuelve  exactamente el formato que necesitamos, por lo que hice el respectivo método que devuelva el formato  de la fecha personalizado a nuestro gusto.


El caso es que para poder invocar un método de nuestra clase dentro de un reporte de JasperReports, primero debemos compilar dicha clase en un .jar y luego asignarlo al classpath del plugin de Netbeans, así que manos a la obra.


Lo primero es crear un proyecto en Netbeans del tipo Librería de Clases Java y alojar nuestra clase ahí.



En mi caso nombré el proyecto como "ScriptletsJasper", pero le pueden llamar como quieran.



Ahora agregamos nuestra clase al proyecto, yo le llamé "FormatoScriptlet", pero nuevamente le pueden llamar como les parezca mejor, lo importante es que herede de JRDefaultScriptlet como ya habíamos dicho anteriormente y agregamos nuestro método dentro de ella.



Guardamos y compilamos el proyecto dándonos como resultado el .jar que necesitamos, en mi caso quedó "ScriptletsJasper.jar" en la carpeta "dist" del proyecto, el cual podemos copiar en la ubicación de nuestra preferencia.


Teniendo ya nuestra clase empaquetada en un .jar vamos a definir la ruta respectiva en el classpath del plugin de Netbeans (no en el classpath del IDE), para eso vamos al menú "Tools / Options" de Netbeans y en la ventana que se nos presenta seleccionamos "iReport" y luego la pestaña "Classpath", presionamos el botón "Add JAR" y seleccionamos el archivo .jar que habíamos creado.



Lo siguiente sería invocar nuestra clase dentro de un reporte, por lo que nos ponemos en ello inmediatamente. Nos vamos a las "Properties" del reporte donde vamos a modificar tres propiedades.



Seleccionamos "Scriptlet class" y escribimos el nombre de nuestra clase con la estructura de paquetes completa, es decir que si tenemos "org.paquete.clase" o "com.paquete.clase" debemos especificar toda la estructura.


Verificamos que en la propiedad "Language" esté seleccionado Java, y si no lo está … pues, lo hacemos.


Y por último necesitamos "Imports" para que el reporte reconozca nuestra clase. La seleccionamos y en la ventanita presionamos el botón "Add" y de nuevo especificamos el nombre de nuestra clase con su estructura de paquetes completa.



Con lo que hemos hecho hasta este momento veremos en la ventana "Report Inspector" en la sección "Scriptlets" del reporte, que se ha creado un ítem llamado "REPORT" y con la propiedad "Scriptlet Class" conteniendo el nombre de nuestra clase, además podemos ver el parámetro "REPORT_SCRIPTLET" con el tipo de dato FormatoScriptlet y es a través del cual invocaremos los métodos de nuestra clase.



Ahora ya estamos listos para usar nuestro método en cualquier lugar del reporte.


Basados en la guía mencionada anteriormente Trabajando con parámetros opcionales en JasperReports tomaré la línea de código en el "Default Value Expression" del parámetro opcional "WhereFechaInicial" para invocar el método en cuestión.


($P{FechaInicial} != null ? " AND FECHAGEN >= '" + $P{FechaInicial} + "'" : "") 


Dentro de esta línea tomamos el parámetro $P{FechaInicial} y lo sustituímos por lo siguiente:


$P{REPORT_SCRIPTLET}.getFecha($P{FechaInicial},"dd/MM/yyyy" 


Quedando de la siguiente manera:


($P{FechaInicial} != null ? " AND FECHAGEN >= '" +
 $P{REPORT_SCRIPTLET}.getFecha($P{FechaInicial},"dd/MM/yyyy") + "'" : "")


Si ejecutamos el reporte podremos comprobar que el método nos devuelve la fecha formateada con el patrón que le indicamos.


Espero que esta guía le pueda servir a más de alguno y que no pase todas las dificultades que yo pasé en su momento.

Leer más

Parámetros opcionales en JasperReports

Trabajando con parámetros opcionales en JasperReports


Teniendo la necesidad de hacer un reporte en JasperReports al cual se le puedan pasar parámetros opcionales, y no encontrando alguna guía en internet  que me dejara las cosas bien claras al respecto, he decidido hacer este remedo de tutorial ya sea para usarlo cuando necesite hacerlo de nuevo y que ya se me haya olvidado o para que le sirva a alguien que necesite hacer lo mismo. 


El requerimiento era que el reporte además de tener ciertos parámetros fijos también tuviera otros opcionales, es decir que el usuario los puede dejar vacíos cuando quiera o especificar unos y dejar otros en blanco indistintamente. 


Para trabajar parámetros normales en JasperReports basta que además de crearlos en la sección "Parameters" del reporte en la ventana "Report Inspector" le agreguemos el prefijo “$P” al nombre del parámetro o visualmente arrastrar con el mouse desde la lista de parámetros a nuestra línea de código del Editor de Expresiones.



Con lo que a mí me quedó un query del tipo: 


SELECT CODCIA, TIPODOC, NUMDOC, FECHAGEN, CANTIDAD
FROM INGRESOSBODEGA
WHERE CODCIA = $P{CodCia} AND TIPODOC = $P{TipoDoc}
AND FECHAGEN >= $P{FechaInicial} AND FECHAGEN <= $P{FechaFinal}


¿Pero qué pasa si queremos hacer que algunos de esos parámetros sean opcionales para el usuario? 


Bueno en teoría basta con agregar al prefijo del nombre, el carácter “!”  y con eso el reporte evaluará la expresión antes de ejecutar el query completo, por ejemplo, yo quiero hacer que los parámetros FechaInicial y FechaFinal sean opcionales: 


WHERE CODCIA = $P{CodCia} AND TIPODOC = $P{TipoDoc}
AND FECHAGEN >= $P!{FechaInicial} AND FECHAGEN <= $P!{FechaFinal}
 


Pero esto no funcionará porque si el usuario los deja vacíos, la expresión de los parámetros devolverá null y evidentemente el query fallará. 


¿Cómo lo solucionamos? 


Creando un parámetro de tipo String por cada parámetro que nos interese que sea opcional, y desmarcandole la propiedad "Use as a prompt" (Para el caso del parámetro  "FechaInicial" he creado WhereFechaInicial y para el parámetro "FechaFinal" he creado WhereFechaFinal).




Volviendo a nuestro query le sustituimos cada parámetro incluyendo toda la sentencia SQL:


Cambiamos " AND FECHAGEN >= $P{FechaInicial}" por "$P!{WhereFechaInicial}"
y " AND FECHAGEN <= $P{FechaFinal}" por "$P!{WhereFechaFinal}"


Quedando de la siguiente forma: 


WHERE CODCIA = $P{CodCia} AND TIPODOC = $P{TipoDoc}
$P!{WhereFechaInicial} $P!{WhereFechaFinal}


Nos vamos luego al Editor de Expresiones de los parámetros mencionados y ahí definimos el SQL respectivo que se evaluará antes que el query sea ejecutado. Seleccionamos el parámetro "WhereFechaInicial" y editamos su Default Value Expression con una sentencia IF ELSE donde evaluamos el parámetro "$P{FechaInicial}" para definir cuando el usuario lo deja vacío: 


($P{FechaInicial} != null ? " AND FECHAGEN >= '" + $P{FechaInicial + "'" : "")



Lo mismo hacemos con el parámetro "WhereFechaFinal": 


($P{FechaFinal} != null ? " AND FECHAGEN <= '" + $P{FechaFinal + "'" : "")
 


Con lo que hemos hecho el reporte devolverá en cada parámetro Wherexxxx la cadena de la porción SQL correspondiente si el usuario especifica un valor, caso contrario devolverá una cadena vacía. 


Hasta aquí todo perfecto para cualquier parámetro que no sea una fecha. Pero como nuestro caso es precisamente ese … parámetros de tipo fecha!


No nos funciona el query porque el método .toString() de los parámetros java.util.Date nos devuelve el formato “EEE, d MMM yyyy HH:mm:ss Z” (por temas del Locale y otras hierbas) y obviamente no es igual al formato que espera la base de datos, así que para resolverlo hemos tenido que crear una clase Java propia que tenga un método que devuelva la fecha formateada correctamente, eso se hace mediante Scriptlets que trato en la guía Trabajando con Scriptlets en el plugin de iReport en Netbeans de esa forma la expresión del parámetro “WhereFechaInicial” me quedó de la siguiente forma: 


($P{FechaInicial} != null ? " AND FECHAGEN >= '" +
$P{REPORT_SCRIPTLET}.getFecha($P{FechaInicial},"dd/MM/yyyy") + "'" : "")


Hago lo mismo con el parámetro “WhereFechaFinal”, compilo y ejecuto el reporte … Quedó perfecto! 


Espero que le sirva a más de alguno que necesite hacer lo mismo.


Actualización: Es muy importante que cuando se definan los parámetros opcionales queden después de los parámetros normales, pues de lo contrario, al momento de evaluar el valor default de los parámetros opcionales no estarán instanciados los parámetros normales y sus valores siempre serán nulos, por lo que el query no funcionará adecuadamente.

Leer más