Application: gvSIG desktop

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2006 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 */

package org.gvsig.raster.grid.filter;

import java.util.ArrayList;

import java.util.TreeMap;

import org.gvsig.raster.dataset.IBuffer;

/**

 * Esta clase representa la lista de filtros que debe ser manejada desde el

 * RasterFilterListManager.

 * @author Nacho Brodin (nachobrodin@gmail.com)

 *

 */

public class RasterFilterList {

        public final static int                         UNDEFINED = -1;

        public final static int                         ADD_END = 0;

        public final static int                         ADD_END_AND_DELETE = 1;

        public final static int                         MODIFY_LAST = 2;

    private IBuffer                 rasterBuf = null;

    private int                                typeFilter = -1;

    private TreeMap                        params = new TreeMap();

    //Pila de objetos Filter (Contiene un RasterFilter)

    private ArrayList                list = new ArrayList();

    /**

     * A?ade un par?metro a la lista de filtros. Estos par?metros luego

     * pueden ser utilizados por los managers que se registren

     * @param key Nombre del par?metro que coincide con el nombre de la clase.

     * @param value Objeto

     */

    public void addParam(String key, Object value) {

            params.put(key, value);

    }

    /**

     * Obtiene un par?metro de la lista de filtros.

     * @param key Identificador del par?metro. Coincide con el nombre de la clase del par?metro.

     */

    public Object getParam(String key) {

            return params.get(key);

    }

    /**

     * A?ade un filtro al final de la lista

     * @param filter        filtro a?adido

     */

    public void add(RasterFilter filter) {

        list.add(filter);

    }

    /**

     * Elimina un filtro a partir de su nombre

     * @param name Nombre del filtro a eliminar

     */

    public void remove(String name) {

            for (int i = list.size() - 1; i >= 0; i--){

                if(((RasterFilter)list.get(i)).getName().equals(name))

                        list.remove(i);

        }

    }

    /**

     * Elimina un filtro concreto de la pila

     * @param type

     */

    public void remove(RasterFilter filter) {

        for (int i = list.size() - 1; i >= 0; i--) {

            if (((RasterFilter) list.get(i)).equals(filter))

                list.remove(i);

        }

    }

    /**

     * Elimina un filtro por clase. 

     * @param baseFilterClass

     */

    public void removeByClass(Class baseFilterClass) {

            for(int i = 0; i < lenght(); i++) {

                    if(baseFilterClass.isInstance(((RasterFilter) list.get(i)))) {

                            list.remove(i);

                            i --;

                    }

            }

    }

    /**

     * Devuelve el tipo de dato de retorno al aplicar la pila de filtros

     * @return

     */

    public int getOutDataType() {

            if(list.size() > 0)

                    return ((RasterFilter)list.get(list.size() - 1)).getOutRasterDataType();

            else

                    return rasterBuf.getDataType();

    }

    /**

     * Devuelve el raster resultado de la aplicacion de la pila de filtros

     * @return

     */

    public IBuffer getResult() {

          return rasterBuf;

    }

    /**

     * Devuelve true si el filtro 'a' est? por encima del 'b' en la lista y false si no lo est?

     * @param a  Nombre de filtro

     * @param b  Nombre de filtro

     * @return

     */

    private boolean isOnTop(String a, String b) {

        int posA = -1;

        int posB = -1;

        for (int i = 0; i < list.size(); i++) {

            if (list.get(i).equals(a)) 

                posA = i;

            if (list.get(i).equals(b))

                posB = i;

            if ((posA != -1) && (posB != -1))

                break;

        }

        if (posA < posB)

            return true;

        else

            return false;

    }

    /**

     * Dado un modo de inserci?n se obtiene el tipo de dato del filtro a introducir.

     * Se insertionMode es ADD_END quiere decir que se a?adir? al final de la lista

     * por lo que devuelve el tipo de la salida del ?ltimo filtro. Si es ADD_END_AND_DELETE

     * lo mismo y si es MODIFY_LAST quiere decir que buscar? si hay alguno de este tipo y 

     * si lo hay devuelve el tipo de dato del anterior filtro en la lista.

     * 

     * @param name        Nombre del filtro a insertar en la lista. Este debe corresponder con la variable

     * genericName definida para cada tipo de filtro

     * 

     * @param insertionMode Modo de inserci?n en la lista. Debe corresponder con alguna de las 

     * constantes definidas en RasterFilterList ADD_END, ADD_END_AND_DELETE, MODIFY_LAST o UNDEFINED

     * 

     */

    public int getDataTypeInFilter(String name, int insertionMode) {

            switch(insertionMode) {

            //Devuelve el tipo de salida del primer filtro que sea != del q se quiere insertar

            case ADD_END_AND_DELETE: 

                            for(int i = list.size() - 1; i >= 0; i--) {

                                    if(((RasterFilter) list.get(i)).getName().compareTo(name) != 0) 

                                            return ((RasterFilter) list.get(i)).getOutRasterDataType();

                            }

                            return getInitDataType();

            //Devuelve el tipo del filtro anterior al ?ltimo que coincide con el tipo pasado. Si no existe

            //devolver? el tipo de salida del ?ltimo filtro de la lista

            case MODIFY_LAST:

                    for(int i = list.size() - 1; i >= 0; i--) {

                                if(((RasterFilter) list.get(i)).getName().compareTo(name) == 0) {

                                        if(i > 0)

                                                return ((RasterFilter) list.get(i - 1)).getOutRasterDataType();

                                        else

                                                return getInitDataType();

                                }

                    }

            //Devuelve el tipo de salida del ?ltimo filtro de la lista

            case ADD_END: 

                            if(list.size() == 0)

                                    return getInitDataType();

                            else

                                    return ((RasterFilter) list.get(list.size() - 1)).getOutRasterDataType();

            }

            return getInitDataType(); 

    }

    /**

     * Obtiene la cantidad de filtros en la lista

     * @return N?mero de filtros apilados

     */

    public int lenght() {

        return list.size();

    }

    /**

     * Obtiene el filtro apilado de la posici?n i o null si el indice es incorrecto

     * @param i        Posici?n a acceder en la pila

     * @return        Filtro

     */

    public RasterFilter get(int i) {

            if(i >= list.size() || i < 0)

                    return null;

        return ((RasterFilter) list.get(i));

    }

    /**

     * Obtiene el filtro apilado de nombre name o null si no existe

     * @param i       Nombre del filtro buscado

     * @return        Filtro

     */

    public RasterFilter get(String name) {

            for (int i = list.size() - 1; i >= 0; i--){

                    if(((RasterFilter) list.get(i)).getName().equals(name))

                            return ((RasterFilter) list.get(i));

            }

            return null;

    }

    /**

     * Obtiene el filtro apilado que corresponde con el nombre

     * @param name        Nombre de filtro

     * @return      Filtro en caso de que exista un filtro apilado de ese tipo

     * o null si no hay ninguno.

     */

    public RasterFilter getByName(String name) {

            for(int i = 0; i < lenght(); i++) {

                    if(((RasterFilter) list.get(i)).getName().equals(name))

                            return ((RasterFilter) list.get(i));

            }

        return null;

    }

    /**

     * Obtiene el primer filtro de la lista que es instancia de la clase pasada por 

     * par?metro 

     * @param baseFilterClass Filtro base

     * @return RasterFilter

     */

    public RasterFilter getFilterByBaseClass(Class baseFilterClass) {

            for(int i = 0; i < lenght(); i++) {

                    if(baseFilterClass.isInstance(((RasterFilter) list.get(i))))

                            return ((RasterFilter) list.get(i));

            }

            return null;

    }

    /**

     * Obtiene el tipo del filtro de la pila de la posici?n i

     * @param i Posici?n a acceder en la pila

     * @return tipo de filtro

     */

    public String getName(int i) {

        return ((RasterFilter) list.get(i)).getName();

    }

    /**

     * Elimina todos los filtros de la pila

     */

    public void clear() {

        list.clear();

    }

    /**

     * Sustituye un filtro de una posici?n de la pila por otro

     * @param filter

     * @param i

     */

    public void replace(RasterFilter filter, String name) {

            for (int i = list.size() - 1; i >= 0; i--)  {

                    if(((RasterFilter) list.get(i)).getName().equals(name)){

                            list.remove(i);

                            list.add(i, filter);

                    }

            }

    }

    /**

     * Sustituye un filtro de una posici?n de la pila por otro

     * @param filter

     * @param i

     */

    public void replace(RasterFilter filter, int i) {

            list.remove(i);

            list.add(i, filter);

    }

    /**

     * Asigna el raster de entrada inicial

     * @param raster

     */

    public void setInitRasterBuf(IBuffer raster) {

            rasterBuf = (IBuffer) raster;

            typeFilter = rasterBuf.getDataType();

    }

    /**

     * Devuelve el tipo de datos inicial de la lista

     * @return Tipo de dato del raster inicial

     */

    public int getInitDataType() {

        return typeFilter;

    }

    /**

     * M?todo que devuelve true si el tipo de filtro pasado por par?metro est? en la

     * pila y false si no lo est?.

     * @param type        Tipo de par?metro a comprobar

     * @return true si est? en la pila y false si no lo est?

     */

    public boolean isActive(String name) {

        for (int i = list.size() - 1; i >= 0; i--) {

            if (((RasterFilter) list.get(i)).getName().equals(name))

                return true;

        }

        return false;

    }

    /**

     * M?todo que devuelve true si el tipo de filtro pasado por par?metro est? en la

     * pila y false si no lo est?.

     * @param filter        Tipo de filtro a comprobar

     * @return true si est? en la pila y false si no lo est?

     */

    public boolean isActive(RasterFilter filter) {

        for (int i = list.size() - 1; i >= 0; i--) {

            if (((RasterFilter) list.get(i)).equals(filter)) {

                return true;

            }

        }

        return false;

    }

    /**

     * Aplica los filtros de la pila sobre el buffer correspondiente

     * @param dataType

     */

    private void executeFilterByDataType(int dataType) {

        for (int i = list.size() - 1; i >= 0; i--) {

            RasterFilter filter = ((RasterFilter) list.get(i));

            //System.err.println("SACANDO FILTRO "+i+"  "+filter.toString());

            filter.addParam("raster", rasterBuf);

            filter.execute();

            if (filter.getResult("raster") != null)

                    this.rasterBuf = (IBuffer) filter.getResult("raster");            

        }

    }

    /**

     * Aplica los filtros sobre un RasterBuf

     * @return IBuffer de salida

     */

    public IBuffer execute() {

            if(rasterBuf == null)

                    return null;

        executeFilterByDataType(rasterBuf.getDataType());

        return rasterBuf;

    }

    /**

     *Muestra el contenido de la pila de filtros para depuraci?n

     */

    public void show() {

        System.out.println("--------------------------------------------");

        for (int i = list.size() - 1; i >= 0; i--) {

            System.out.println("FILTRO:" + i + " NAME:" +

                               ((RasterFilter) list.get(i)).getName() + " FIL:" +

                               ((RasterFilter) list.get(i)).toString());

        }

    }

}