Sidar, principal.
>>contenido
Fundación Sidar - Acceso Universal
Seminario SIDAR
Principal >> Aplicación: UAW >> Documentación de las clases java

uaw
Class Web

java.lang.Object
  |
  +--uaw.Web
Direct Known Subclasses:
WebMarcs, WebTidy

public abstract class Web
extends java.lang.Object

Un Web es un conjunto de Planes (páginas) relacionadas semánticamente por su contenido y sintácticamente por los vínculos hipertextuales entre ellas.

La clase abstracta Web es ejecutable y des de ella se realiza el último control de excepciones y se generan los informes del programa. Facilita a sus descendientes el proceso de un sitio web real a través de sus tres métodos principales:

  1. inicialitzar
  2. actualitzarWeb
  3. generarFitxersResultat

En Web disponemos también de dos listas, pendents y planes , que guardan los datos de lasPlanes antes y después de procesarlas, respectivamente.

Nota a los programadores

Los programadores encontraran ejemplos del código a incluir en las clases hijas en el archivo fuente de esta clase.

Version:
1.0, 2004/06
Author:
Mireia Ribera
See Also:
uaw.BaseWeb

UML data model
legend graphical representation



Field Summary
static Configuracio config
Campo que guarda la configuración de la herramienta actual, a efectos de poder consultar sus propiedades.
static java.lang.String nomEina
Campo que contiene el nombre de la herramienta actual, a efectos de poder mostrarlo en los informes.
protected static java.util.HashMap pendents
Planes pendientes de procesar, ordenadas por Plana.id.
protected static java.util.HashMap planes
Planes definitivas, ordenadas por Plana.id.
Constructor Summary
protected Web ()
Web parte del supuesto que BaseWeb ya esta inicializado y con datos;Web sólo comprueba que los datos de BaseWeb sean válidos.
Method Summary
void actualitzarWeb ()
Realiza el proceso de análisis y transformación de las páginas y apunta el trabajo realizado en el informe de actividad.
void esborrarPendents (Plana p)
Saca una página de entre las que estaban pendientes de procesar.
void esborrarPlanes (Plana p)
Saca una página de entre las que ya estaban procesadas.
static boolean existeixPlana (java.lang.Object id)
Indica si existe en el Web alguna página con identificador id.
boolean existeixPlana (Plana p)
Indica si la página p existe en el Web.
void generarFitxersResultat ()
Genera los ficheros del web resultado, equivalentes en contenido al web dado pero con alguna característica de usabilidad o accesibilidad mejorada (a concretar en las clases descendientes) y las guarda en local.
int getNumPlanes ()
Devuelve el nombre de páginas ya procesadas en el Web.
static Plana getPlana (java.lang.Object pid)
Devuelve la página correspondiente al identificador dado si existe, o nulo en caso contrario.
void inicialitzar ()
Inicia la escritura del informe de actividad.
static void putPendents (Plana p)
Añade una página al Web, en la lista de páginas pendientes, y en caso de que no tenga una UawURI asignada le asigna una automáticamente.
static void putPlanes (Plana p)
Añade una página al Web, a la lista de páginas definitivas.
protected void tractarDirectori (java.net.URI uInicial, boolean copiarXHTML, boolean esborrarResultat)
Procesa los ficheros del directorio que no son XHTML, y crea una copia en el web resultado, manteniendo la estructura de directorios.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

config

public static Configuracio config

Campo que guarda la configuración de la herramienta actual, a efectos de poder consultar sus propiedades.


nomEina

public static java.lang.String nomEina

Campo que contiene el nombre de la herramienta actual, a efectos de poderlo mostrar en el informe de actividad.


pendents

protected static java.util.HashMap pendents

Páginas pendientes de procesar, ordenadas por Plana.id.

Una misma página no puede pertenecer simultáneamente a planes y a pendents, son listas disjuntas.

La información que se guarda en cada página es la mínima necesaria para su proceso o identificación.


planes

protected static java.util.HashMap planes

Páginas definitivas, ordenadas por Plana.id.

Una misma página no puede pertenecer simultáneamente a planes y a pendents, son listas disjuntas.

La información que se guarda en cada página es la mínima necesario para su proceso o identificación.

Constructor Detail

Web

protected Web()
       throws UawException

Web parte del supuesto que BaseWeb ya esta inicializado y con datos; Web sólo comprueba que los datos de BaseWeb sean válidos.

Throws:
UawException - si los valores definidos en BaseWeb no son validos
Method Detail

existeixPlana

public static boolean existeixPlana(java.lang.Object id)

Indica si existe una página en el Web con identificador id.

Parameters:
id - el identificador de la página buscada

getPlana

public static Plana getPlana(java.lang.Object pid)

Devuelve la página correspondiente al identificador si existe, en caso contrario devuelve null.

Parameters:
pid - el identificador de la página buscada

putPendents

public static void putPendents(Plana p)
                        throws java.lang.IllegalArgumentException,
                               UawException

Añade una página al Web, a la lista de páginas pendientes, y si no tiene UawURI asignada le asigna una automáticamente.

Parameters:
p - La página a añadir
Throws:
java.lang.IllegalArgumentException - si p ya pertenecía al Web
UawException - si se han producido problemas en la asignación automática de la UawURI

putPlanes

public static void putPlanes(Plana p)
                      throws java.lang.IllegalArgumentException

Añade una página al Web, a la lista de páginas definitivas.

Parameters:
p - La página a añadir
Throws:
java.lang.IllegalArgumentException - si p ya pertenecía al Web

actualitzarWeb

public void actualitzarWeb()
                    throws UawException

Realiza el proceso de análisis y transformación de las páginas y apunta el trabajo realizado en el informe de actividad.

En esta clase abstracta en realidad lo único que se hace es crear una copia de todos los ficheros no XHTML del web original en el directorio resultado e introducir los ficheros XHTML en la lista de páginas pendientes sin realizar ningún tratamiento. Las clases descendientes deberán extender este método con tal de procesar las páginas.

UawException

esborrarPendents

public void esborrarPendents(Plana p)
                      throws java.lang.IllegalArgumentException

Borra la página p de las páginas pendientes de procesar.

Parameters:
p - La página a borrar.
Throws:
java.lang.IllegalArgumentException - si p no pertenecía a la lista de páginas pendientes.

esborrarPlanes

public void esborrarPlanes(Plana p)
                    throws java.lang.IllegalArgumentException

Borra la página p de la lista de páginas procesadas.

Parameters:
p - La página a borrar
Throws:
java.lang.IllegalArgumentException - si p no pertenecía a la lista de páginas procesadas.

existeixPlana

public boolean existeixPlana(Plana p)

Indica si la página p existe en el Web.

Parameters:
p - La página a buscar

generarFitxersResultat

public void generarFitxersResultat()
                            throws UawException

Genera los ficheros del web resultado, equivalentes en contenido al web dado pero con alguna característica de usabilidad o accesibilidad mejorada (a concretar en las clases hijas) y las guarda en local. Finaliza la escritura del informe de actividad.

UawException

getNumPlanes

public int getNumPlanes()

Devuelve el número de páginas ya procesadas en Web.


inicialitzar

public void inicialitzar()
                  throws UawException

Inicia la escritura del informe de actividad.

En las clases hijas se puede usar este método para otras inicializaciones necesarios, como por ejemplo inicializar el campo config con la configuración de la herramienta.

Throws:
UawException - si el análisis del fichero inicial ha dado problemas.

tractarDirectori

protected void tractarDirectori(java.net.URI uInicial,
                                boolean copiarXHTML,
                                boolean esborrarResultat)
                         throws java.lang.IllegalArgumentException,
                                java.lang.NullPointerException

Procesa los ficheros del directorio que no son XHTML y realiza una copia en el web resultado, manteniendo la estructura de directorios. Introduce la información del trabajo realizado en el informe de actividades. Opcionalmente guarda los ficheros XHTML en la lista de páginas pendientes.

Parameters:
uInicial - directorio raíz por donde empezar la copia
copiarXHTML - indica si incorporar los ficheros XHTML a la lista de páginas pendientes
Throws:
java.lang.NullPointerException - si uInicial es nulo.
java.lang.IllegalArgumentException - si uInicial no es correcto, no existe o no es un directorio.