miércoles 30 de julio de 2008

Aplicaciones Java (VI): Salida de consola

A veces es conveniente poder escribir trazas para saber lo que está haciendo nuestro programa en cada momento, por ejemplo:

10:24:25 - Descargando fichero "342314.png"
10:24:29 - Descargando fichero "342315.png"
10:24:40 - Descargando fichero "342316.png"
...

En aplicaciones de consola (las que ejecutamos por línea de comandos), crear trazas de este tipo es trivial:

System.out.println("Fichero descargado");

Sin embargo, en aplicaciones gráficas no veremos el intérprete de comandos, y por tanto no podremos acceder a la salida de consola.

Una opción es escribir en un fichero de log, para lo que podemos utilizar una librería del estilo de log4j. Sin embargo, un fichero de log es más problemático para aplicaciones que queremos ejecutar desde la web, sin instalar nada, y no está integrado en el interfaz de la aplicación, sino que hay que acceder a él por separado.

Vamos a crear una clase que nos permitirá, con el mismo código, escribr trazas en stdout, o en un componente de tipo JTextArea.

Esta clase tendrá el modificador final, de modo que no será necesario instanciarla. De este modo, desde cualquier punto de nuestro programa, podremos ejecutar:

Console.println("Fichero descargado");

Que como vemos es muy sencillo y limpio.

En nuestra aplicación únicamente tendremos que crear el JTextArea y asignarlo al objeto Console.

JTextArea consoleOutput = new JTextArea(20, 40);
consoleOutput.setEditable(false);
Console.useJTextComponent(consoleOutput);

Si no reasignamos la salida de la consola a un JTextArea, la salida por defecto será stdout.

Esta es la implementación de la clase Console:

package org.dreamcoder.SwingSample;

import javax.swing.text.PlainDocument;
import javax.swing.text.JTextComponent;
import java.io.PrintStream;

public final class Console
{
 private static final long  serialVersionUID = 3;
 
 private static JTextComponent textField;
 private static PrintStream    stream = System.out; // by default we will output to stdout

    private Console()
    {
        throw new AssertionError("I am a static class. Don't instantiate me.");
    }
    
 public static void useJTextComponent(JTextComponent newTextArea)
 {
  textField = newTextArea;
 }

 public static void usePrintStream(PrintStream newStream)
 {
  stream = newStream;
 }

 public static void println(String str)
 {
        if (textField != null)
        {
            PlainDocument doc = (PlainDocument)textField.getDocument();
            
            try {
                doc.insertString(doc.getLength(), str+"\n", null);
            } catch (javax.swing.text.BadLocationException e) {}

            textField.setCaretPosition(doc.getLength());
        }
        else
        {
            stream.println(str);
        }
    }
}

Vemos en la implementación del método println que puede funcionar de 2 modos: con un stream (como System.out o un fichero, y con un componente que contenga texto). Para este último modo, obtenemos el documento (PlainDocument) correspondiente al componente, y trabajaremos con este documento. El documento es la parte del componente que contiene los datos, independientemente de la representación gráfica.

A partir de esta clase, si nuestra aplicación lo requiere podemos crear una variación que nos permita instanciar diferentes objetos de esta clase, cada uno escribiendo en un JTextArea o PrintStream diferente. Por ejemplo, podríamos tener 2 consolas distintas basadas en un JTextArea, y una tercera salida que escriba en stdout o en un fichero, socket, etc.

Material

El código fuente mostrando el uso de estos componentes se puede descargar bajo licencia GPLv3:
Download

Ejecutar ejemplo, como applet o como Java Web Start (recomendado):
Start Applet Launch via Java Web Start

jueves 24 de julio de 2008

Aplicaciones Java (V): Creación de una interfaz multiidioma

Supongamos que queremos implementar la interfaz de nuestro programa de modo que se pueda elegir el idioma. La opción que presentamos a continuación nos va a permitir implementar este cambio de idioma sin tener que hardcodear cada una de las posibles combinaciones de componentes e idiomas en el código.

La clave la tenemos en utilizar un objeto del tipo Properties. Ésta es una clase de Java que nos permitirá, por medio de su método getProperty, acceder a un fichero de texto que contiene pares propiedad - valor. El nombre de la propiedad y su valor pueden estar separados por dos puntos ":", igual "=", espacios " ", tabuladores, o una combinación de varios de estos símbolos. Veamos a continuación el fichero languages.cfg utilizado en el ejemplo. Utilizaremos este fichero desde un objeto Properties.

languages.ES.Menu.Tools:        Herramientas
languages.ES.Menu.Language:     Idioma
languages.ES.Menu.Help:         Ayuda
languages.ES.Menu.About:        Acerca de
languages.ES.Label.label:       Etiqueta
languages.ES.Button.boton:      Botón
languages.ES.Table.tabla.0:     primera columna
languages.ES.Table.tabla.1:     segunda columna
languages.ES.Table.tabla.2:     tercera columna

languages.EN.Menu.Tools:        Tools
languages.EN.Menu.Language:     Language
languages.EN.Menu.Help:         Help
languages.EN.Menu.About:        About
languages.EN.Label.label:       Label
languages.EN.Button.boton:      Button
languages.EN.Table.tabla.0:     first column
languages.EN.Table.tabla.1:     second column
languages.EN.Table.tabla.2:     third column

Observamos que para cada componente, hemos definido una propiedad para cada idioma, que sólo cambia en el segundo token (ES/EN). Esto nos permitirá implementar una función para traducir la interfaz, tal que le pasemos el idioma, y buscaremos automáticamente el conjunto de propiedades correspondientes al idioma seleccionado.

En primer lugar cargaremos el fichero con las traducciones en el objeto Properties. Intentaremos leer el fichero del filesystem (mediante FileReader), y si no encontramos el fichero, intentaremos leerlo desde dentro del fichero jar (Class.getResourceAsStream).

A continuación leeremos la propiedad correspondiente getProperty("languages."+language+"."+tipo_compomente+"."+nombre_componente), y cambiaremos ese texto en el componente correspondiente.

private void translateInterface(String language)
{
    // read the properties file that will contain the strings for every language
    
    if (languagescfg == null)
    {
        languagescfg = new Properties();

        try {
            // We will try to open the file from a resource, in case it is embedded in a jar file
            InputStream is = this.getClass().getClassLoader().getResourceAsStream("languages.cfg");
            
            if (is != null)
                languagescfg.load(new InputStreamReader(is));
            else languagescfg.load(new FileReader("languages.cfg"));
        } catch (FileNotFoundException e)
        {        
            System.err.println("File or resource \"languages.cfg\" not found");
        } catch (IOException e)
        {
            System.err.println("Error while reading file \"languages.cfg\"");
        }
    }

    // menus
    toolsmenu.setText(languagescfg.getProperty("languages."+language+".Menu.Tools"));
    languagemenu.setText(languagescfg.getProperty("languages."+language+".Menu.Language"));
    helpmenu.setText(languagescfg.getProperty("languages."+language+".Menu.Help"));
    aboutitem.setText(languagescfg.getProperty("languages."+language+".Menu.About"));
    
    // labels
    label.setText(languagescfg.getProperty("languages."+language+".Label.label"));
            
    // buttons
    boton.setText(languagescfg.getProperty("languages."+language+".Button.boton"));
    
    // Headers de tablas
    tabla.getColumnModel().getColumn(0).setHeaderValue(languagescfg.getProperty("languages."+language+".Table.tabla.0"));
    tabla.getColumnModel().getColumn(1).setHeaderValue(languagescfg.getProperty("languages."+language+".Table.tabla.1"));
    tabla.getColumnModel().getColumn(2).setHeaderValue(languagescfg.getProperty("languages."+language+".Table.tabla.2"));
}

Finalmente sólo queda llamar al método translateInterface, tanto al final de la función que genera el interfaz (para asignar inicialmente los valores por defecto), como en la escucha de los eventos que saltarán cuando el usuario seleccione el idioma correspondiente desde el menú Herramientas->Idioma.

public void generaInterfaz()
{
    // creamos los componentes deseados
    // ...
    
    // Translations of the interface
    
    translateInterface("ES");
}

public void actionPerformed(ActionEvent event)
{
    Object source = event.getSource();
    if (source.getClass().getName().equals("javax.swing.JRadioButtonMenuItem"))
    {
        if (source == languageitemES)
        {
            translateInterface("ES");
        }
        else if (source == languageitemEN)
        {
            translateInterface("EN");
        }
    }
}

Material

El código fuente mostrando el uso de estos componentes se puede descargar bajo licencia GPLv3:
Download

Ejecutar ejemplo, como applet o como Java Web Start (recomendado):
Start Applet Launch via Java Web Start

Aplicaciones Java (IV): Swing: tablas y diálogos

Más formas para mostrar información: tablas y diálogos.

Tablas (JTable, DefaultTableModel)

La clase JTable nos permitirá crear matrices de celdas donde podremos insertar texto, botones, o cualquier otro componente.

final String[] columnNames = {"number", "string 1", "string 2"};
final Object[][] data = {};

JTable tabla = new JTable(new DefaultTableModel(data, columnNames));
root.add(new JScrollPane(tabla), BorderLayout.CENTER);

En el ejemplo anterior hemos utilizado el modelo de tabla "DefaultTableModel". Si queremos personalizar el comportamiento de la tabla, podemos crear una clase que herede de DefaultTableModel, sobreescribiendo algunos de sus métodos.

En el siguiente ejemplo utilizamos este método para hacer que trate la primera columna como objetos de tipo Integer, y las demás como String, frente al comportamiento por defecto que es tratar todas las columnas como objetos de tipo Object. Esto afecta por ejemplo a la ordenación de las columnas cuando hacemos una llamada a setAutoCreateRowSorter.

final String[] columnNames = {"number", "string 1", "string 2"};
final Object[][] data = {};

final class WordListTableModel extends DefaultTableModel
{
 private static final long serialVersionUID = 4;
 
    public WordListTableModel(Object[][] data, Object[] columnNames) {
        super(data, columnNames);
    }

    public Class getColumnClass(int columnIndex) {
     if (columnIndex == 0) return Integer.class;
     else return String.class;
    }
}

tabla = new JTable(new WordListTableModel(data, columnNames));
tabla.setAutoCreateRowSorter(true);
root.add(new JScrollPane(tabla), BorderLayout.CENTER);

Para añadir datos a una tabla podemos utilizar el método addRow:

Object[] row = {Integer.valueOf(123), "any value", "botón pulsado"};
((DefaultTableModel)tabla.getModel()).addRow(row);

Diálogos (JDialog)

Los diálogos nos permitirán mostrar ventanas emergentes con información u opciones adicionales. Ejemplos sencillos de diálogos serían:

  • Diálogos de "Acerca de" con información sobre el programa, página web, autor, etc.
  • Un diálogo emergente que aparezca cuando ejecutamos una operación larga, y que incluya una barra de progreso y un botón para cancelar la operación.

Crearemos diálogos por medio de la clase JDialog. También hay otras formas de crearlos, como utilizando la clase JOptionPane.

Hay un problema a la hora de crear un diálogo desde un applet. El objeto raiz es de la clase JApplet, que no desciende de la clase Frame, necesario para poder crear un objeto JDialog. Para solucionarlo, utilizaremos el método getFrameForComponent de la clase JOptionPane, que nos permitirá obtener el objeto del tipo Frame del que es nieto el applet. En el caso de una aplicación, el objeto root ya es un Frame, con lo que getFrameForComponent devolverá el mismo objeto, de modo que podemos utilizar el mismo código para la ejecución como applet y como aplicación:

JDialog dialog = new JDialog(JOptionPane.getFrameForComponent(root), "botón pulsado!!!", Dialog.ModalityType.APPLICATION_MODAL);
dialog.add(new JLabel("line correctly added"));
dialog.pack();
dialog.setVisible(true);

Material

El código fuente mostrando el uso de estos componentes se puede descargar bajo licencia GPLv3:
Download

Ejecutar ejemplo, como applet o como Java Web Start (recomendado):
Start Applet Launch via Java Web Start

miércoles 23 de julio de 2008

Aplicaciones Java (III): Swing: botones, menús y eventos

Seguimos con los artículos sobre Swing. Pasamos a comentar algunos controles relacionados con la interactividad de nuestro programa: botones y menús, y eventos asociados.

Botones (JButton)

Por medio de la clase JButton crearemos botones a los que asociaremos determinadas acciones.

JButton botonsinusar = new JButton("boton sin usar");
root.add(botonsinusar, BorderLayout.EAST);

Es posible añadir imágenes a los botones. Para ello, utilizaremos el constructor de JButton que permite pasar una imagen como parámetro. Para la imagen del botón, podemos proporcionar un fichero gráfico propio que almacenaremos dentro de nuestro fichero jar, o gracias al método UIManager.getIcon, utilizar una imagen proporcionada por los componentes estándar de Java. En esta página podremos encontrar un listado con algunos de los gráficos incluidos en componentes estándar. Alguien conoce algún listado más exahustivo?

JButton boton = new JButton("texto boton", UIManager.getIcon("FileView.hardDriveIcon"));
root.add(boton, BorderLayout.SOUTH)

Menús (JMenuBar, JMenu, JMenuItem)

Por medio de las clases JMenuBar, JMenu, y JMenuItem/JRadioButtonMenuItem/JCheckBoxMenuItem, podremos fácilmente generar menús para nuestro programa con todas las características que podemos imaginar:

  • Atajos de teclado
  • Iconos
  • Submenús (menú que se abre cuando pones el ratón encima de una opción de otro menú)
  • Botones de radio, para seleccionar una entre múltiples opciones
  • Checkbox, para activar o desactivar una opción

En primer lugar crearemos un objeto del tipo JMenuBar, que es la barra de menú que colocaremos en el panel como un componente más (utilizando el layout correspondiente).

JMenuBar menubar = new JMenuBar();
root.add(menubar, BorderLayout.NORTH);

A este JMenuBar le añadiremos un JMenu, que es cada uno de los menús de una barra de menú (Archivo, Herramientas, Ayuda...).

JMenu toolsmenu = new JMenu("Tools");
menubar.add(toolsmenu);

Cada uno de estos menús puede tener una serie de elementos (JMenuItem, JRadioButtonMenuItem, JCheckBoxMenuItem) o contener menús anidados (un JMenu dentro de un JMenu).

JMenu languagemenu  = new JMenu("Language");
toolsmenu.add(languagemenu);

JMenuItem languageitemEN = new JRadioButtonMenuItem("English");
languagemenu.add(languageitemEN);

JMenuItem languageitemES = new JRadioButtonMenuItem("Español");
languagemenu.add(languageitemES);

JMenuItem aboutitem = new JMenuItem("Exit");
toolsmenu.add(aboutitem);

En el caso de los botones de radio, podremos definir un grupo de botones entre los que sólo será posible seleccionar una opción, utilizando la clase ButtonGroup.

ButtonGroup languagegroup = new ButtonGroup();
languagegroup.add(languageitemEN);
languagegroup.add(languageitemES);
languageitemES.setSelected(true);

Eventos (ActionListener)

Para escuchar los eventos, como los generados por los botones y menús, tendremos que crear una clase que implemente el interfaz ActionListener, creando el método actionPerformed, definido como abstracto. Este método será invocado cada vez que se produzca un evento de los que hemos seleccionado que queremos escuchar. En nuestro caso, la pulsación de botones y menús.

Para añadir la capacidad de escuchar eventos a nuestra clase deberemos añadir lo siguiente:

Para cada componente cuyos eventos queramos escuchar le diremos que será el objeto de la clase actual (this) quien escuchará ese evento. También se puede crear una clase independiente para escuchar estos eventos.

boton.addActionListener(this);
languageitemEN.addActionListener(this);
languageitemES.addActionListener(this);
aboutitem.addActionListener(this);

Utilizando el evento (de la clase clase ActionEvent) pasado como parámetro, podremos distinguir de qué tipo de evento se trata (source.getClass().getName()), identificar el componente concreto que generó el evento event.getSource(), y otra información (getActionCommand()).

Para cada clase que queramos que escuche eventos (en nuestro caso sólo en SwingSampleBase):

public class SwingSampleBase implements ActionListener
{    
    // constructor y otros métodos
    // [...]

    public void actionPerformed(ActionEvent event)
    {
        Object source = event.getSource();
        if (source.getClass().getName().equals("javax.swing.JMenuItem") ||
            source.getClass().getName().equals("javax.swing.JRadioButtonMenuItem"))
        {
            if (source == aboutitem)
            {
                lCenter.setText("selected About item");
            }
            else if (source == languageitemES)
            {
                lCenter.setText("selected Spanish language");
            }
            else if (source == languageitemEN)
            {
                lCenter.setText("selected English language");
            }
        }
        else // JButton
        {
            if (source == boton)
            {
                lCenter.setText("botón pulsado");
            }
        }
    }
}

Material

El código fuente mostrando el uso de estos componentes se puede descargar bajo licencia GPLv3:
Download

Ejecutar ejemplo, como applet o como Java Web Start (recomendado):
Start Applet Launch via Java Web Start

Aplicaciones Java (II): Swing: componentes básicos

En este post vamos a continuar comentando como crear una aplicacion Java con Swing. Concretamente, vamos a mostrar como utilizar varios de los componentes de Swing.

Paneles (JPanel)

Los paneles son los objetos donde colocaremos los componentes que creemos. Son el canvas donde posteriormente pintaremos. Crearemos los paneles normales utilizando la clase JPanel:

JPanel izquierda = new JPanel();
izquierda.add(new JLabel("etiqueta"));

Etiquetas (JLabel)

Probablemente el control más básico es la etiqueta (JLabel). Se trata de un recuadro de texto con el contenido que queramos.

root.add(new JLabel("Hola mundo!"));

Layouts (BorderLayout, BoxLayout, GridLayout)

El punto mas lioso de Swing, especialmente al principio, es la distribucion de los controles en la ventana. Para ello utilizaremos unos objetos llamados layouts. Estos objetos nos permitirán elegir dónde queremos ubicar cada componente.

Hay diferentes tipos de layouts. Algunos de los más básicos son:

BorderLayout

Divide el panel actual en 5 secciones (norte, sur, este, oeste, centro). Intentará dar más espacio a la sección central, con lo que es muy útil cuando tenemos por ejemplo un componente de texto que nos interesa mucho, y una serie de botones que queremos ubicar en la parte de arriba del panel.

root.setLayout(new BorderLayout());
root.add(new JLabel("este"), BorderLayout.EAST);

BoxLayout

Este layout ubicará los componentes uno al lado del otro en un mismo eje, en horizontal o vertical.

JPanel izquierda = new JPanel();
izquierda.setLayout(new BoxLayout(izquierda, BoxLayout.Y_AXIS));

izquierda.add(new JLabel("arriba"));
izquierda.add(new JLabel("centro"));
izquierda.add(new JLabel("abajo"));

GridLayout

Este layout divide la superficie en n·m celdas de igual tamaño.

JPanel gridpanel = new JPanel(new GridLayout(2, 2));
root.add(gridpanel, BorderLayout.SOUTH);
  
gridpanel.add(new JLabel("arriba izquierda"));
gridpanel.add(new JLabel("arriba derecha"));
gridpanel.add(new JLabel("abajo izquierda"));
gridpanel.add(new JLabel("abajo derecha"));

Otros layouts

Hay muchos otros layouts que nos permitirán distribuir de maneras más flexibles nuestros componentes. Se pueden consultar en la ayuda de Java al respecto.

Paneles con pestañas (JTabbedPane)

Un tipo especial de panel nos permitirá agregar varios paneles en el mismo espacio físico, que seleccionaremos por medio de pestañas (tabs).

JTabbedPane tabbedPane = new JTabbedPane();
root.add(tabbedPane, BorderLayout.CENTER);

JPanel tab1 = new JPanel(new BorderLayout());
tabbedPane.addTab("tab 1", tab1);

JPanel tab2 = new JPanel(new BorderLayout());
tabbedPane.addTab("tab 2", tab2);

Campos de texto (JTextArea) y scrolling (JScrollPane)

Utilizaremos el componente JTextArea para permitir al usuario introducir y modificar texto.

JTextArea text1 = new JTextArea(20, 30);
tab1.add(text1);
text1.append("Escribimos algo de texto\nQue aparecerá por defecto.");

Si además añadimos un objeto del tipo JScrollPane, cuando haya más texto que el espacio disponible aparecerá automáticamente una barra de desplazamiento.

JTextArea text2 = new JTextArea(20, 30);
tab2.add(new JScrollPane(text2));
text2.append("Este campo de texto estará oculto en la segunda pestaña, " +
      "y tendrá una barra de scroll.");

Fillers (Filler)

Éste es un componente puramente estético, que sirve para dejar espacio entre dos componentes.

tab3.add(new Filler(new Dimension(10, 10), new Dimension(10, 10), new Dimension(10, 10)));

Selección de un valor en una lista (JComboBox)

Para seleccionar un valor entre una lista predefinida, utilizaremos un componente de tipo JComboBox:

String[] colores = {"azul", "blanco", "rojo", "negro"};
root.add(new JComboBox(colores), BorderLayout.NORTH);

Material

El código fuente mostrando el uso de estos componentes se puede descargar bajo licencia GPLv3:
Download

Y gracias a las tecnologías Java Web Start y Applets comentadas en el artículo anterior, este ejemplo se puede ejecutar directamente sin instalar nada, sólamente pulsando uno de los siguientes botones:
Start Applet Launch via Java Web Start

martes 22 de julio de 2008

Aplicaciones Java (I): Applets y Java Web Start

Aplicaciones Java

Vamos a comentar una forma muy sencilla de desarrollar aplicaciones multiplataforma que se pueden ejecutar sin necesidad de instalar nada.

Para ello utilizaremos un conjunto de clases desarrolladas para programar interfaces: Swing. Gracias a Swing podremos crear ventanas, botones, campos de texto, selectores de fichero, y cualquier control que necesitemos para nuestra interfaz

Aplicaciones de escritorio, Aplicaciones Java Web Start y Applets

Tenemos 3 formas de ejecutar una aplicación desarrollada en Java, en función de cómo haya sido desarrollada.

Aplicaciones de escritorio

En este caso nos descargamos la aplicación a nuestra máquina local, generalmente en un fichero ".jar", o un zip conteniendo un fichero ".jar". Ejecutaremos la aplicación por medio del binario "java":
java -cp FICHERO_JAR NOMBRE_CLASE
java -cp SwingSample.jar org.dreamcoder.SwingSample.SwingSampleApp

También se puede ejecutar por medio de un script (unix shell script ".sh", DOS batch ".bat" o Windows command ".cmd", VBScript, etc), que lance el comando anterior.

Si el fichero jar se ha creado con la entrada correspondiente en el fichero META-INF/MANIFEST.MF, será posible ejecutar la aplicación directamente, pulsando el botón derecho y "Open with Sun Java * Runtime", o mediante la línea de comandos:
java -jar SwingSample.jar

Entrada del fichero MANIFEST.MF:
Main-Class: CLASE A INVOCAR QUE CONTIENE LA FUNCION MAIN
Main-Class: org.dreamcoder.SwingSample.SwingSampleApp

Applets

Con unos pequeños cambios en el código, y unas limitaciones por motivos de seguridad, podemos convertir nuestra aplicación de escritorio en un Applet. Esto quiere decir que la aplicación se ejecutará dentro de un navegador web, directamente desde Internet, sin instalar nada. Es muy cómodo para el usuario, pero puede haber diversos problemas entre el applet y el navegador web.

Para insertar un applet en nuestra página web deberemos incluir un código similar al siguiente:

<applet code="org.dreamcoder.SwingSample.SwingSampleApplet.class" width="100%" height="100%" archive="SwingSample.jar">Java Applet Support Required</applet>

Ejecutar aplicación como applet: Start Applet

Java Web Start

Éste es un nuevo modo de iniciar aplicaciones que se introdujo con Java 1.2 como un complemento que debías descargar por separado, y a partir de la versión 1.4 ya viene de serie con la instalación base.

La idea es similar a los applets, dado que desde una página web podremos directamente ejecutar nuestro programa. La principal diferencia consiste en que nuestro programa se ejecutará como un proceso independiente del navegador, aislándonos así de muchos problemas. A nuestra máquina se descargará un fichero jnlp, que es un pequeño fichero de texto que indica cómo ejecutar la aplicación.

Con este método se pueden ejecutar aplicaciones que hayan sido desarrolladas como aplicaciones de escritorio tanto como applets. Éste es el método actualmente recomendado por Sun.

Vemos aquí un ejemplo de un fichero jnlp que nos permitirá ejecutar una aplicación Java desde la web, utilizando Java Web Start:

<?xml version="1.0" encoding="utf-8"?>

<jnlp codebase="http://nightearth.com/dreamcoder/SwingSample/SwingSample_initial" href="SwingSample.jnlp">
 <information>
  <title>Swing sample JWS application</title>
  <vendor>dreamcoder.org</vendor>
  <description>Small application that doesn't do anything, just shows how to implement a multiplatform application</description>
  <homepage href="http://www.dreamcoder.org"/>
  <description kind="short">Swing sample JWS application</description>
  <offline-allowed/>
 </information>
 <resources>
  <jar href="SwingSample.jar" />
  <j2se version="1.4+" href="http://java.sun.com/products/autodl/j2se" />
 </resources>
 <application-desc main-class="org.dreamcoder.SwingSample.SwingSampleApp"/>
</jnlp>

Ejecutar aplicación vía Java Web Start: Launch via Java Web Start

Para ejecutar un applet via JWS sustituiremos el elemento application-desc por:

<applet-desc name="SwingSample" main-class="org.dreamcoder.SwingSample.SwingSampleApplet" width="768" height="576"></applet-desc>

Punto de entrada (JFrame, JApplet)

Dependiendo de si queremos desarrollar una aplicación o un applet, deberemos hacer uso de la clase JFrame o JApplet. En cuanto a la implementación, no hay muchas más diferencias. Para nuestros ejemplos, vamos a crear un wrapper de cada tipo, con lo que nuestra aplicación podrá ser ejecutada como applet, como aplición offline, o como aplicación online via Java Web Start, utilizando el mismo fichero jar.

SwingSampleApp.java

Utilizado para la ejecución como aplicación offline y Java Web Start.

package org.dreamcoder.SwingSample;

import javax.swing.JFrame;

public class SwingSampleApp
{
 public static void main(String[] args)
 {
  JFrame frame = new JFrame();
  new SwingSampleBase(frame);
  frame.pack();
 }
}

SwingSampleApplet.java

Utilizado para la ejecución como applet.

package org.dreamcoder.SwingSample;

import javax.swing.JApplet;

public class SwingSampleApplet extends JApplet
{
 private static final long serialVersionUID = 1;
 SwingSampleBase app;
 
 public void init()
 {
  if (app == null)
   app = new SwingSampleBase(this);
 }
}

SwingSampleBase.java

fichero principal de la aplicación, que será utilizado tanto desde el applet como desde la aplicación.

package org.dreamcoder.SwingSample;

import java.awt.Container;
import javax.swing.JLabel;

public class SwingSampleBase
{ 
 // Main element
 Container root;
 
 // Interface
 JLabel     lHolaMundo;

 public SwingSampleBase(Container providedRoot)
 {
  root = providedRoot;
  generaInterfaz();

  root.setVisible(true);
 }

 public void generaInterfaz()
 {
  root.add(new JLabel("Hola mundo!"));
 }
}

Descargar el código: Download

Esto es sólo el esqueleto, donde probamos los métodos para desarrollar y ejecutar una aplicación. En próximos posts le añadiremos contenido a la aplicacion.

Podríais comentar qué tal os funciona la aplicación, cuando intentáis ejecutarla como Applet, vía Java Web Start, o ejecutándola localmente, una vez descargada al disco duro? Así como Sistema Operativo, versión de la JVM (máquina virtual java) y navegador web. Gracias!!!

martes 8 de julio de 2008

WordFrequency (I): Obtener un listado de las palabras más frecuentes en un conjunto de webs

Introducción

Vamos a desarrollar paso a paso un pequeño programa cuya finalidad es extraer la lista de las palabras más usadas en un listado de páginas web.

La idea es extraer este listado, para enfocarnos a la hora de estudiar vocabulario de un nuevo idioma. O incluso sólo por curiosidad: lo podemos utilizar con un texto nuestro, a ver si repetimos una palabra demasiadas veces.

El lenguaje elegido es java versión 6.0, dado su carácter multiplataforma y su capacidad de ser ejecutado desde una página web como un applet, con lo que no es necesario descargar ni instalar nada para ejecutarlo.

El código fuente estará disponible con licencia GPL, lo que quiere decir que puedes utilizar este código donde quieras y como quieras, siempre que mantengas la referencia al autor original, y el programa que hagas con este código sea también GPL (también distribuyas el código fuente).

Para el desarrollo estoy utilizando el JDK de Sun, y el editor Eclipse, muy cómodo y potente. Todo software libre o gratuíto.

En lugar de mostrar todo el código fuente, vamos a mostrar sólo las partes más interesantes del programa: para cada funcionalidad principal, cómo se ha implementado.

Descargar una página web via http

Por medio de un objeto de la clase java.net.URLConnection obtendremos un stream que podremos utilizar para leer datos de forma estándar, por ejemplo llamando a br.readLine()

URL url = new URL(urlstring);
URLConnection connection = url.openConnection();
BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream()));

Parsear un documento html

Por medio de la clase javax.swing.text.html.HTMLEditorKit parsearemos el documento html en un objeto de tipo javax.swing.text.html.HTMLDocument, que nos permitirá navegar por sus elementos. En este caso seleccionaremos los elementos de tipo HTML.Tag.CONTENT, que es un alias que representa cualquier elemento html que contenga texto. Otros elementos interesantes pueden ser HTML.Tag.A, HTML.Tag.IMG, HTML.Tag.H1...

HTMLEditorKit htmlKit = new HTMLEditorKit();
HTMLDocument htmlDoc = (HTMLDocument) htmlKit.createDefaultDocument();
HTMLEditorKit.Parser parser = new ParserDelegator();
HTMLEditorKit.ParserCallback callback = htmlDoc.getReader(0);
parser.parse(br, callback, true);

// Iterate over all the text tags and insert an entry into the hash map or increase its number of occurrences 

for (HTMLDocument.Iterator iterator = htmlDoc.getIterator(HTML.Tag.CONTENT); iterator.isValid(); iterator.next())
{
    int startOffset = iterator.getStartOffset();
    int endOffset = iterator.getEndOffset();
    int length = endOffset - startOffset;
    String text = htmlDoc.getText(startOffset, length).trim();
}

Con este código, para cada elemento encontrado, habremos almacenado en la variable text el texto que contiene.

Esta clase HTMLDocument también permite acceder a los atributos de cada elemento, como el atributo src de un elemento A. Esto puede ser particularmente útil si queremos por ejemplo extraer las páginas web enlazadas desde una página web dada, o las imágenes que contiene:

for (HTMLDocument.Iterator iterator = htmlDoc.getIterator(HTML.Tag.A); iterator.isValid(); iterator.next())
{
    Object href = iterator.getAttributes().getAttribute( HTML.Attribute.HREF );
 
    if (href != null) // the 'A' element contains the 'href' attribute
    {
        System.out.println("Link found: \"" + href.toString() + "\"");
    }
}

Calcular la frecuencia de aparición de cada palabra

Creamos un objeto de tipo HashMap, que contiene pares "llave-valor", y cada llave es única; esto es, si hacemos hash.put("a", valor) y "a" ya existe, estamos modificando la anterior entrada de "a". La búsqueda (hash.get()) en esta estructura es muy rápida.

HashMap hash = new HashMap();

Para cada palabra encontrada, incrementaremos su valor asociado, que nos indicará el número de veces que esta palabra ha aparecido en la entrada.

// we insert or update the entry in the hashmap by 1
Integer in = (Integer)hash.get(palabra);
if (in == null) in = Integer.valueOf(1);
else in = Integer.valueOf(in.intValue() + 1);

hash.put(palabra, in);

Una vez hemos recopilado la frecuencia de aparición de cada palabra en esta estructura, podemos, por ejemplo, ordenar estos datos, insertándolos en una colección de tipo java.util.TreeSet y su especialmente útil iterador descendingIterator, que recorre el árbol en orden inverso. También utilizamos esta ordenación para seleccionar los 'n' elementos con valor más alto

// generate an ordered set with the most frequent words (at most maxRecords)
TreeSet orderedSet = new TreeSet();
 
Set s = hash.entrySet();
iter = s.iterator();
while (iter.hasNext())
{
    Map.Entry act = (Map.Entry)iter.next();
    orderedSet.add(new DataRecord((Integer)act.getValue(), (String)act.getKey()));
}
 
iter = orderedSet.descendingIterator();
DataRecord min = null;
i = maxRecords;
while ( iter.hasNext() && (i-- > 0) )
{
    min = (DataRecord)iter.next();
}
if (iter.hasNext())
    min = (DataRecord)iter.next();
 
return orderedSet.descendingSet().headSet(min, true);

Y ya sólo nos queda mostrar o almacenar los datos obtenidos.

Material

La implementación del programa comentado en este artículo se puede descargar bajo licencia GPLv3. El código comentado se encuentra dentro de la clase WordFrequencyCalculator.

Download

Y eso es todo por el momento. Cualquier duda o sugerencia que tengáis, dejadla en los comentarios. Y si realizáis cualquier mejora interesante al código, u os es útil de cualquier otra forma, por favor comentádmelo, por curiosidad.