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.georeferencing.swing;

import java.awt.Color;

import java.awt.geom.Rectangle2D;

import org.gvsig.fmap.dal.coverage.store.RasterDataStore;

/**

 * Data model for options to georeferencing. This a shared object to read 

 * and write properties selected by the user

 * @author Nacho Brodin nachobrodin@gmail.com

 */

public interface GeoreferencingOptionsDataModel {

        public void reset();

        /**

         * Obtiene la capa que ha sido abierta por el usuario 

         * @return Obtiene la capa que ha sido abierta por el usuario o null si no 

         * hay abierta ninguna.

         */

        public RasterDataStore getDataStore();

        /**

         * Gets the extent in pixel coordinates, that means (0, 0, width, height)

         * @return

         */

        public Rectangle2D getRasterExtent();

        /**

         * Obtiene la vista seleccionada

         * @return

         */

        public String getSelectedView();

        /**

         * Obtiene el tipo de georreferenciaci?n seleccionada

         * @return entero con el tipo de georreferenciaci?n. Es una constante contenida en la 

         * clase georreferencing.

         */

        public int getType();

        /**

         * Obtiene el nombre del fichero de salida

         * @return Fichero de salida

         */

        public String getOutFile();

        /**

         * Obtiene el tipo de algoritmo seleccionado

         * @return entero con el tipo de algoritmo. Es una constante definida 

         * en la clase georreferencing. 

         */

        public int getAlgorithm();

        /**

         * Obtiene el grado del algoritmo si este es polinomial

         * @return entero con el grado del algoritmo. 

         */

        public int getDegree();

        /**

         * Obtiene el m?todo de interpolaci?n del algoritmo si este es polinomial

         * @return entero con el m?todo de interpolaci?n 

         */

        public int getInterpolationMethod();

        /**

         * Obtiene el tama?o de celda en X.

         * @return double con el tama?o de celda. 

         */

        public double getXCellSize();

        /**

         * Asigna el tama?o de celda en X.

         * @param cellSize

         */

        public void setXCellSize(double cellSize);

        /**

         * Obtiene el tama?o de celda en Y.

         * @return double con el tama?o de celda. 

         */

        public double getYCellSize();

        /**

         * Asigna el tama?o de celda en Y.

         * @param cellSize

         */

        public void setYCellSize(double cellSize);

        /**

         * Asigna el m?todo de interpolaci?n

         * @param interpolationMethod

         */

        public void setInterpolationMethod(int interpolationMethod);

        /**

         * Asigna el nombre del fichero de salida

         * @param interpolationMethod

         */

        public void setOutFile(String out);

        /**

         * Asigna el grado del algoritmo cuando es polinomial

         * @param optiondegree

         */

        public void setDegree(int optiondegree);

        /**

         * Asigna el algoritmo

         * @param alg

         */

        public void setAlgorithm(int alg);

        /**

         * Asigna el color de fonfo

         * @param c

         */

        public void setBackGroundColor(Color c);

        /**

         * Obtiene el color de fondo

         * @return

         */

        public Color getBackgroundColor();

        /**

         * Asigna el color del texto

         * @param c

         */

        public void setTextColor(Color c);

        /**

         * Obtiene el color del texto

         * @return

         */

        public Color getTextColor();

        /**

         * Obtiene el control para selecci?n de umbral de error

         * @return JButton

         */

        public double getThresholdError();

        /**

         * Asigna el control para selecci?n de umbral de error

         * @return JButton

         */

        public void setThresholdError(double threshold);

        /**

         * Sets the type of georeferencing selected

         * @param type

         */

        public void setType(int type);

        /**

         * Sets the data store

         * @param store

         */

        public void setDataStore(RasterDataStore store);

        /**

         * Sets the selected view

         * @param v

         */

        public void setSelectedView(String v);

        /**

         * Asigna el flag que dice si los errores se escriben en el fichero CSV

         * @param true para escribirlos en el fichero y false para no hacerlo

         */

        public void setAddErrorsCSV(boolean addErrorsCSV);

        /**

         * Consulta si est? activo el flag de centrar las vistas autom?ticamente sobre

         * el punto que est? seleccionado en la tabla.

         * @return true para centrar autom?ticamente y false para no hacerlo

         */

        public boolean isCenterView();

        /**

         * Asigna el flag que dice si se centran las vistas autom?ticamente sobre

         * el punto que est? seleccionado en la tabla.

         * @return true para centrar autom?ticamente y false para no hacerlo

         */

        public void setCenterView(boolean centerView);

        /**

         * Asigna el flag que dice si se muestra el n?mero del punto en la vista

         * @param true para mostrarlo y false para no hacerlo

         */

        public void setShowNumber(boolean showNumber);

        /**

         * Consulta el flag que informa si se muestra el n?mero del punto en la vista

         * @return true si se muestra y false si no

         */

        public boolean isShowNumber();

        /**

         * Obtiene el umbral de error a partir del cual se iluminan en rojo en la tabla

         * @return double con el valor del umbral

         */

        public double getThreshold();

        /**

         * Consulta si los errores se escriben en el fichero CSV

         * @return true si se escriben en el fichero y false si no se hace

         */

        public boolean isAddErrorsCSV();

        /**

         * Asigna el umbral de error a partir del cual se iluminan en rojo en la tabla

         * @param double con el valor del umbral

         */

        public void setThreshold(double threshold);

        /**

         * Gets the list of points. This list contains the list of geopoints and 

         * graphic points.

         * @return

         */

        public GCPList getGCPList();

}