org.gvsig.fmap.dal.coverage.grid

Interface RasterFilterList

All Superinterfaces:

Disposable, Persistent

All Known Implementing Classes:

DefaultRasterFilterList

public interface RasterFilterList
extends Persistent, Disposable

Operaciones definidas sobre la lista de filtros

Method Summary

Modifier and Type	Method and Description
void	add(RasterFilter filter) Añade un filtro al final de la lista
void	add(RasterFilter filter, int pos) Añade un filtro en la lista en la posición indicada.
void	addEnvParam(String key, Object value) Añade un parámetro a la lista de filtros.
void	addFilterListListener(FilterListChangeListener listener) Asigna un listener a la lista que será informado cuando cambie un filtro o posición en la lista.
void	clear() Elimina todos los filtros de la pila
void	controlTypes() Controla que los tipos de entrada y salida de los filtros sean los correctos
RasterFilter	createEmptyFilter(String nameFilter) Builds an instance of a filter from its class name.
Params	createEmptyFilterParams() Builds a new filter parameter object
Buffer	execute() Aplica los filtros sobre un RasterBuf
RasterFilter	get(int i) Obtiene el filtro apilado de la posición i o null si el indice es incorrecto
RasterFilter	get(String name) Obtiene el filtro apilado de nombre name o null si no existe
RasterFilter	getByName(String name) Obtiene el filtro apilado que corresponde con el nombre
TreeMap<String,Object>	getEnv() Obtiene el TreeMap con los parámetros
Object	getEnvParam(String key) Obtiene un parámetro de la lista de filtros.
RasterFilter	getFilterByBaseClass(Class<?> baseFilterClass) Obtiene el primer filtro de la lista que es instancia de la clase pasada por parámetro
Class<?>	getFilterClassByID(String id) Gets a filter class searching in the register managers by its identifier
int	getInitDataType() Devuelve el tipo de datos inicial de la lista
RasterFilterListManager	getManagerByClass(Class<?> clase) Gets the manager using its class
RasterFilterListManager	getManagerByFilterClass(Class<?> c) Gets a specific manager using its ID
RasterFilterListManager	getManagerByID(String id) Gets a specific manager using its ID
String	getName(int i) Obtiene el tipo del filtro de la pila de la posición i
int	getOutDataType() Devuelve el tipo de dato de retorno al aplicar la pila de filtros
int	getPercent()
int	getPosition(Class<?> c) Devuelve la posición en la lista de una clase de filtro concreta
List<Class<?>>	getRegisteredFilterList() Gets the registered list of filters
List<Class<?>>	getRegisteredFilterListByDataType(int dataType) Gets the registered list of filters
Buffer	getResult() Devuelve el raster resultado de la aplicacion de la pila de filtros
List<RasterFilter>	getStatusCloned() Obtiene el estado actual de los filtros, el ArrayList devuelto es una clonación del original, asi no compartiran datos.
Transparency	getTransparency() Gets the transparency object and the color interpretation of the result.
boolean	isActive(RasterFilter filter) Método que devuelve true si el tipo de filtro pasado por parámetro está en la pila y false si no lo está.
boolean	isActive(String name) Método que devuelve true si el tipo de filtro pasado por parámetro está en la pila y false si no lo está.
int	lenght() Obtiene la cantidad de filtros en la lista
boolean	move(Class<?> filter, int position) Move un filtro determinado a la posición especificada.
void	popStatus() Recupera un estado guardado con antelación mediante el método pushStatus()
void	pushStatus() Guarda el estado de la lista de filtros en una pila, que se podrá ir recuperando con popStatus()
void	remove(Class<?> baseFilterClass) Elimina un filtro por clase.
void	remove(String name) Elimina un filtro a partir de su nombre
void	removeAll() Removes all filters
void	replace(RasterFilter filter, int i) Sustituye un filtro de una posición de la pila por otro
void	replace(RasterFilter filter, String name) Sustituye un filtro de una posición de la pila por otro
void	resetPercent()
void	setEnv(TreeMap<String,Object> env) Asigna el TreeMap con los parámetros del entorno
void	setInitDataType(int dt) Asigna el tipo de dato inicial
void	setInitRasterBuf(Buffer raster) Asigna el raster de entrada inicial
void	setStatus(List<RasterFilter> newArray) Define el estado actual de los filtros

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Method Detail

addFilterListListener

void addFilterListListener(FilterListChangeListener listener)

Asigna un listener a la lista que será informado cuando cambie un filtro o posición en la lista.

Parameters:

listener - FilterListListener

addEnvParam

void addEnvParam(String key,
                 Object value)

Añade un parámetro a la lista de filtros. Estos parámetros luego pueden ser utilizados por los managers que se registren

Parameters:

key - Nombre del parámetro que coincide con el nombre de la clase.

value - Objeto

getEnvParam

Object getEnvParam(String key)

Obtiene un parámetro de la lista de filtros.

Parameters:

key - Identificador del parámetro. Coincide con el nombre de la clase del parámetro.

controlTypes

void controlTypes()
           throws FilterTypeException

Controla que los tipos de entrada y salida de los filtros sean los correctos

Throws:

FilterTypeException

add

void add(RasterFilter filter)
  throws FilterTypeException

Añade un filtro al final de la lista

Parameters:

filter - filtro añadido

Throws:

FilterTypeException

replace

void replace(RasterFilter filter,
             String name)
      throws FilterTypeException

Sustituye un filtro de una posición de la pila por otro

Parameters:

filter -

i -

Throws:

FilterTypeException

add

void add(RasterFilter filter,
         int pos)
  throws FilterTypeException

Añade un filtro en la lista en la posición indicada.

Parameters:

filter - filtro añadido

pos - posición

Throws:

FilterTypeException

removeAll

void removeAll()

Removes all filters

remove

void remove(String name)
     throws FilterTypeException

Elimina un filtro a partir de su nombre

Parameters:

name - Nombre del filtro a eliminar

Throws:

FilterTypeException

remove

void remove(Class<?> baseFilterClass)
     throws FilterTypeException

Elimina un filtro por clase.

Parameters:

baseFilterClass -

Throws:

FilterTypeException

getOutDataType

int getOutDataType()

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

Returns:

getResult

Buffer getResult()

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

Returns:

lenght

int lenght()

Obtiene la cantidad de filtros en la lista

Returns:

Número de filtros apilados

get

RasterFilter get(int i)

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

Parameters:

i - Posición a acceder en la pila

Returns:

Filtro

get

RasterFilter get(String name)

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

Parameters:

i - Nombre del filtro buscado

Returns:

Filtro

getByName

RasterFilter getByName(String name)

Obtiene el filtro apilado que corresponde con el nombre

Parameters:

name - Nombre de filtro

Returns:

Filtro en caso de que exista un filtro apilado de ese tipo o null si no hay ninguno.

getFilterByBaseClass

RasterFilter getFilterByBaseClass(Class<?> baseFilterClass)

Obtiene el primer filtro de la lista que es instancia de la clase pasada por parámetro

Parameters:

baseFilterClass - Filtro base

Returns:

RasterFilter

getName

String getName(int i)

Obtiene el tipo del filtro de la pila de la posición i

Parameters:

i - Posición a acceder en la pila

Returns:

tipo de filtro

clear

void clear()

Elimina todos los filtros de la pila

replace

void replace(RasterFilter filter,
             int i)

Sustituye un filtro de una posición de la pila por otro

Parameters:

filter -

i -

move

boolean move(Class<?> filter,
             int position)

Move un filtro determinado a la posición especificada.

Parameters:

filter - Filtro a mover

position - Posición a asignar

Returns:

Devuelve true si el filtro existia y lo ha movido y false si no lo ha hecho.

setInitRasterBuf

void setInitRasterBuf(Buffer raster)

Asigna el raster de entrada inicial

Parameters:

raster -

getInitDataType

int getInitDataType()

Devuelve el tipo de datos inicial de la lista

Returns:

Tipo de dato del raster inicial

setInitDataType

void setInitDataType(int dt)

Asigna el tipo de dato inicial

Parameters:

dt -

isActive

boolean isActive(String name)

Método que devuelve true si el tipo de filtro pasado por parámetro está en la pila y false si no lo está.

Parameters:

type - Tipo de parámetro a comprobar

Returns:

true si está en la pila y false si no lo está

isActive

boolean isActive(RasterFilter filter)

Método que devuelve true si el tipo de filtro pasado por parámetro está en la pila y false si no lo está.

Parameters:

filter - Tipo de filtro a comprobar

Returns:

true si está en la pila y false si no lo está

getPosition

int getPosition(Class<?> c)

Devuelve la posición en la lista de una clase de filtro concreta

Parameters:

c - Clase a buscar en la lista

Returns:

posición en la lista

execute

Buffer execute()
        throws ProcessInterruptedException,
               FilterAddException

Aplica los filtros sobre un RasterBuf

Returns:

IBuffer de salida

Throws:

ProcessInterruptedException

FilterAddException

resetPercent

void resetPercent()

getPercent

int getPercent()

pushStatus

void pushStatus()

Guarda el estado de la lista de filtros en una pila, que se podrá ir recuperando con popStatus()

getStatusCloned

List<RasterFilter> getStatusCloned()

Obtiene el estado actual de los filtros, el ArrayList devuelto es una clonación del original, asi no compartiran datos.

Returns:

setStatus

void setStatus(List<RasterFilter> newArray)

Define el estado actual de los filtros

Parameters:

newArray -

popStatus

void popStatus()

Recupera un estado guardado con antelación mediante el método pushStatus()

getEnv

TreeMap<String,Object> getEnv()

Obtiene el TreeMap con los parámetros

Returns:

TreeMap

setEnv

void setEnv(TreeMap<String,Object> env)

Asigna el TreeMap con los parámetros del entorno

Parameters:

env -

createEmptyFilterParams

Params createEmptyFilterParams()

Builds a new filter parameter object

Returns:

Params

createEmptyFilter

RasterFilter createEmptyFilter(String nameFilter)
                        throws FilterTypeException

Builds an instance of a filter from its class name.

Parameters:

strPackage - package and class name

Returns:

Filtro instanciado

Throws:

FilterTypeException

getManagerByID

RasterFilterListManager getManagerByID(String id)
                                throws FilterManagerException

Gets a specific manager using its ID

Returns:

Throws:

FilterManagerException

getManagerByFilterClass

RasterFilterListManager getManagerByFilterClass(Class<?> c)
                                         throws FilterManagerException

Gets a specific manager using its ID

Returns:

Throws:

FilterManagerException

getManagerByClass

RasterFilterListManager getManagerByClass(Class<?> clase)

Gets the manager using its class

Parameters:

clase -

Returns:

getRegisteredFilterList

List<Class<?>> getRegisteredFilterList()

Gets the registered list of filters

Returns:

getRegisteredFilterListByDataType

List<Class<?>> getRegisteredFilterListByDataType(int dataType)

Gets the registered list of filters

Returns:

getFilterClassByID

Class<?> getFilterClassByID(String id)

Gets a filter class searching in the register managers by its identifier

Parameters:

id -

Returns:

getTransparency

Transparency getTransparency()

Gets the transparency object and the color interpretation of the result. Mostly, filters returns ARGB images but sometimes the filter can alterate the transparency configuration and the color interpretation. For instance, when a color table is applied or a alpha band is added by the filter.

Returns: