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.fmap.dal.coverage.grid;

import java.util.Hashtable;

import java.util.TreeMap;

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

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

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

/**

 * Este interfaz es implementado por el ancestro de cualquier filtro o el propio filtro.

 * Contiene las operaciones necesarias para su ejecuci?n a trav?s de la pila de filtros.

 *

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

 */

public interface RasterFilter {

                public static String    RESULT_BUFFER          = "raster";

                public static String    RESULT_TRANSPARENCY    = "transparency";

                /**

                 * Acciones a realizar antes de la ejecuci?n del filtro

                 */

                public void pre() throws FilterAddException;

                /**

                 * Ejecuci?n de la funci?n process de todo el filtro.

                 * @throws ProcessInterruptedException

                 *

                 */

                public void execute() throws ProcessInterruptedException, FilterAddException;

                /**

                 * Procesa la posici?n x,y del raster

                 * @param x posici?n X

                 * @param y posici?n Y

                 */

                public void process(int x, int y);

                /**

                 * Acciones a realizar despu?s de la ejecuci?n del filtro

                 */

                public void post();

                /**

                 * Returns true if this filter is to conver the input buffer to RGB. This kind

                 * of filters will be in the top of the stack because all others need as input

                 * a RGB data buffer

                 * @return

                 */

                public boolean isToConvertToRGB();

                /**

                 * Par?metros pasados al filtro en forma de nombre de par?metro y objeto que

                 * representa al par?metro. Este puede ser cualquier tipo de variable u objeto.

                 *

                 * Par?metros obligatorios:

                 *         inRaster (IRaster)

                 * par?metros obligatorios (si se da el caso)

                 *         previousFilter (IRasterFilter)

                 *

                 * @param name

                 * @param value

                 */

                public void addParam(String name, Object value);

                /**

                 * Devuelve los resultados despues de la ejecuci?n del filtro.

                 * @param name

                 * @return

                 */

                public Object getResult(String name);

                /**

                 * Obtiene el tipo de datos de entrada al filtro

                 * @return Tipo de dato

                 */

                public int getInRasterDataType();

                /**

                 * Obtiene el tipo de datos de salida del filtro

                 * @return Tipo de dato

                 */

                public int getOutRasterDataType();

                /**

                 * Obtiene el grupo del filtro

                 * @return

                 */

                public String getGroup();

                /**

                 * Devuelve el nombre interno del filtro

                 * @return the fName

                 */

                public String getName();

                /**

                 * @param name the fName to set

                 */

                public void setName(String name);

                /**

                 * Obtiene el TreeMap con los par?metros del entorno

                 * @return TreeMap

                 */

                public TreeMap<String, Object> getEnv();

                /**

                 * Asigna el TreeMap con los par?metros del entorno

                 * @param env

                 */

                public void setEnv(TreeMap<String, Object> env);

                /**

                 * Obtiene un par?metro a partir de la clave

                 * @param name Par?metro

                 * @return Par?metro

                 */

                public Object getParam(String name);

                /**

                 * Gets the param list

                 * @return

                 */

                public Hashtable<String, Object> getParams();

                /**

                 * Gets the param list

                 * @param params

                 */

                public void setParams(Hashtable<String, Object> params);

                /**

                 * Devolver? un booleano indicando si es visible o no en el panel de filtros.

                 * @return

                 */

                public boolean isVisible();

                /**

                 * Obtener que datos puede tratar una interfaz con sus valores

                 * @param nameFilter. Cada tipo de filtro puede tener parametros distintos

                 * @return

                 */

                public Params getUIParams(String nameFilter);

                /**

                 * Gets the list of specific filter names. Each kind of filter can have a list

                 * of specific types. This function returns the names of this filters

                 * @return

                 */

                public String[] getNames();

                /**

                 * Gets the manager name

                 * @return

                 */

                public String getManagerName();

}