Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.tools.app.basic.tool.enhanced.ui;

import java.util.ArrayList;

import java.util.List;

import org.gvsig.andami.PluginServices;

import org.gvsig.fmap.dal.coverage.RasterLocator;

import org.gvsig.fmap.dal.coverage.datastruct.Params;

import org.gvsig.fmap.dal.coverage.exception.FilterManagerException;

import org.gvsig.fmap.dal.coverage.exception.FilterTypeException;

import org.gvsig.fmap.dal.coverage.grid.RasterFilter;

import org.gvsig.fmap.dal.coverage.grid.RasterFilterList;

import org.gvsig.fmap.dal.coverage.grid.RasterFilterListManager;

import org.gvsig.gui.beans.imagenavigator.ImageUnavailableException;

import org.gvsig.raster.fmap.layers.FLyrRaster;

import org.gvsig.raster.swing.RasterSwingLibrary;

import org.gvsig.raster.swing.preview.DataSourcePreview;

import org.gvsig.raster.swing.preview.PreviewRenderProcess;

import org.gvsig.raster.tools.app.basic.RasterToolsUtil;

import org.gvsig.raster.tools.app.basic.raster.bean.previewbase.ParamStruct;

/**

 * Procesado de la imagen para la previsualizaci?n. Para poder usar esta clase despu?s de instanciarla

 * habr? que asignarle un valor a showFiltersSelected aunque por defecto est? a true por lo que se

 * visualizaran los cambios sin problemas, asigna una lista de filtros inicial (que ya tenga el raster

 * aplicado) con setFilterStatus y asignar los filtros que queramos aplicar con addNewParam (una llamada

 * por cada filtro).

 * 

 * 19/02/2008

 * @author Nacho Brodin nachobrodin@gmail.com

 */

public class PreviewFiltering implements PreviewRenderProcess {

        private boolean                  showFiltersSelected     = true;

        private List<ParamStruct>        paramsList              = new ArrayList<ParamStruct>();

        private List<RasterFilter>       filtersInit             = new ArrayList<RasterFilter>();

        private boolean                  showPreview             = true;        

        private boolean                  saveLayerFilters        = true;

        public PreviewFiltering(boolean saveLayerFilters) {

                this.saveLayerFilters = saveLayerFilters;

        }

        /**

         * Flag de selecci?n de activaci?n y desactivaci?n

         * @param show

         */

        public void showFiltersSelected(boolean show) {

                this.showFiltersSelected = show;

        }

        /**

         * Obtiene la lista de par?metros

         * @return the paramsList

         */

        public List<ParamStruct> getParamsList() {

                return paramsList;

        }

        /**

         * Asigna la lista de par?metros

         * @param params

         */

        public void setParamsList(List<ParamStruct> params) {

                this.paramsList = params;

        }

        /**

         * Asigna el arrayList de filtros inicial. Esto hace que aplique los filtros que ya

         * existen en el raster. Estos pueden ser obtenidos del render de la capa de la forma

         * lyr.getRender().getFilterList().getStatusCloned().  

         * @param params Lista de filtros aplicados.

         */

        public void setFilterStatus(List<RasterFilter> filtersInit) {

                this.filtersInit = filtersInit;

        }

        /**

         * Devuelve el arrayList de filtros inicial

         * @return

         */

        public List<RasterFilter> getFilterStatus() {

                return filtersInit;

        }

        /**

         * A?adir un nuevo Params a la lista de Params que podemos manejar. Un Params

         * equivale a un filtro cargado. El hecho de trabajar con Params y no con

         * filtros, simplifica totalmente el panel. Sin tener que depender de los

         * filtros nada m?s que para el momento de dibujado o guardado.

         * @param name

         * @param params

         * @param classFilter

         */

        public void addNewParam(String name, Params params, Class<?> classFilter) {

                ParamStruct param = new ParamStruct();

                param.setFilterName(name);

                param.setFilterParam(params);

                param.setFilterClass(classFilter);

                paramsList.add(param);

        }

        /**

         * Procesa la imagen con la lista de filtros si el flag showFilterSelected est? a true.

         * Esta funci?n llama a addFilter por cada filtro a?adido pero es applyFilters la encargada

         * de construir la lista. 

         */

        public void process(DataSourcePreview rendering) throws ImageUnavailableException {

                if(!showPreview)

                        throw new ImageUnavailableException(RasterToolsUtil.getText(this, "panel_preview_not_available"));

                if(!(rendering.getSource() instanceof FLyrRaster))

                        return;

                FLyrRaster lyr = (FLyrRaster)rendering.getSource();

                lyr.getRender().getFilterList().clear();

                if (showFiltersSelected) {

                        RasterFilterList filterList = lyr.getRender().getFilterList();

                        filterList.setInitDataType(lyr.getDataStore().getDataType()[0]);

                        List<ParamStruct> listFilterUsed = null;

                        if(saveLayerFilters)

                                listFilterUsed = applyAllFilters(lyr);

                        else

                                listFilterUsed = applySelectedFilters(null);

                        ArrayList<Exception> exc = new ArrayList<Exception>();

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

                                try {

                                        RasterFilterListManager filterManager = filterList.getManagerByFilterClass(((ParamStruct) listFilterUsed.get(i)).getFilterClass());

                                        Class<?> c = ((ParamStruct) listFilterUsed.get(i)).getFilterClass();

                                        Params p = ((ParamStruct) listFilterUsed.get(i)).getFilterParam();

                                        filterManager.addFilter(c, p);

                                } catch (FilterTypeException e) {

                                        exc.add(e);

                                } catch (FilterManagerException e) {

                                        exc.add(e);

                                }

                        }

                        if(exc.size() != 0) {

                                RasterSwingLibrary.messageBoxError(PluginServices.getText(this, "error_adding_filters"), this, exc);

                                exc.clear();

                        }

                }

        }

        /**

         * Aqui se seleccionan que filtros se van a aplicar y se devuelven en forma

         * de ArrayList tanto para el dibujado como cuando aceptan o aplican el panel.

         * @param layerRaster

         * @return

         */

        public List<ParamStruct> applyAllFilters(FLyrRaster layerRaster) {

                List<ParamStruct> listFilterUsed = new ArrayList<ParamStruct>();

                int initDataType = layerRaster.getRender().getFilterList().getInitDataType();

                RasterFilterList filterList = RasterLocator.getManager().createEmptyFilterList(initDataType);

                filterList.setEnv(layerRaster.getRender().getFilterList().getEnv());

                filterList.setInitDataType(initDataType);

                List<Class<?>> registeredFilters = filterList.getRegisteredFilterList();

                if(filtersInit == null)

                        return listFilterUsed;

                // Conservamos filtros ya existentes

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

                        RasterFilter obj = null;

                        for (int j = 0; j < registeredFilters.size(); j++) {

                                Class<?> classFilter = (Class<?>) registeredFilters.get(j);

                                try {

                                        obj = (RasterFilter) classFilter.newInstance();

                                        if (obj.getName().equals(((RasterFilter) filtersInit.get(i)).getName()))

                                                break;

                                } catch (InstantiationException e) {

                                        RasterSwingLibrary.messageBoxError("error_creando_filtro", this, e);

                                } catch (IllegalAccessException e) {

                                        RasterSwingLibrary.messageBoxError("error_creando_filtro", this, e);

                                }

                        }

                        // Si no encontramos el filtro apropiado, nos olvidamos de el

                        if (obj == null)

                                continue;

                        // Si no es visible tenemos que conservar el filtro

                        try {

                                Params params = (Params) ((RasterFilter) filtersInit.get(i)).getUIParams(((RasterFilter) filtersInit.get(i)).getName()).clone();

                                // A?ado el parametro RenderBands a los parametros del filtro

                                int[] renderBands = layerRaster.getRender().getRenderColorInterpretation().buildRenderBands();

                                String rgb = renderBands[0] + " " + renderBands[1] + " " + renderBands[2];

                                params.setParam("RenderBands", rgb, 0, null);

                                ParamStruct newParam = new ParamStruct();

                                newParam.setFilterClass(obj.getClass());

                                newParam.setFilterName(((RasterFilter) filtersInit.get(i)).getName());

                                newParam.setFilterParam(params);

                                listFilterUsed.add(newParam);

                        } catch (CloneNotSupportedException e) {

                        }

                }

                // Metemos los filtros seleccionados en listFilterUsed

                listFilterUsed = applySelectedFilters(listFilterUsed);

                return listFilterUsed;

        }

        /**

         * Gets the list of filters selected for the preview (without the layer filters). If a list of filters is

         * assigned, this method will replace the filter if exists in the list. 

         * @param listFilterUsed

         * @return

         */

        public List<ParamStruct> applySelectedFilters(List<ParamStruct> listFilterUsed) {

                if(listFilterUsed == null)

                        return getParamStructListCopy();

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

                        // En caso de existir el filtro, lo reemplazamos

                        boolean finded = false;

                        for (int j = 0; j < listFilterUsed.size(); j++) {

                                if (((ParamStruct) listFilterUsed.get(j)).getFilterName().equals(((ParamStruct) paramsList.get(i)).getFilterName())) {

                                        listFilterUsed.set(j, paramsList.get(i));

                                        finded = true;

                                        break;

                                }

                        }

                        if (!finded)

                                listFilterUsed.add(paramsList.get(i));

                }

                return listFilterUsed;

        }

        private List<ParamStruct> getParamStructListCopy() {

                List<ParamStruct> p = new ArrayList<ParamStruct>();

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

                        p.add(paramsList.get(i).clone());

                }

                return p;

        }

        /**

         * Obtiene el flag que informa de si se est? mostrando la previsualizaci?n o no.

         * En caso de no mostrarse se lanza una excepci?n ImageUnavailableExcepcion con el 

         * mensaje "La previsualizaci?n no est? disponible para este panel"

         * @return

         */

        public boolean isShowPreview() {

                return showPreview;

        }

        /**

         * Asigna el flag para mostrar u ocultar la preview. En caso de no mostrarse se lanza una 

         * excepci?n ImageUnavailableExcepcion con el mensaje "La previsualizaci?n no est? disponible para

         * este panel"

         * @param showPreview

         */

        public void setShowPreview(boolean showPreview) {

                this.showPreview = showPreview;

        }

}