| gvSIG desktop 1

/* 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.dataset;

import java.io.IOException;

import java.lang.reflect.Constructor;

import java.lang.reflect.InvocationTargetException;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.Map;

import java.util.Set;

import java.util.TreeMap;

import org.gvsig.raster.RasterLibrary;

import org.gvsig.raster.dataset.io.features.WriteFileFormatFeatures;

import org.gvsig.raster.shared.Extent;

import org.gvsig.raster.util.RasterUtilities;

import org.gvsig.raster.util.extensionPoints.ExtensionPoint;

import org.gvsig.raster.util.extensionPoints.ExtensionPoints;

import org.gvsig.raster.util.extensionPoints.ExtensionPointsSingleton;

/**

 * Clase abstracta de la que heredan los drivers de escritura. Tiene los

 * m?todos abstractos que debe implementar cualquier driver de escritura

 * y las funcionalidades y opciones soportadas comunes a todos ellos.

 * 

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

 */

public abstract class GeoRasterWriter {

        public static final int MODE_FILEWRITE = 1;

        public static final int MODE_DATAWRITE = 2;

    public static TreeMap                 fileFeature = new TreeMap();

    protected String                         outFileName = null;

    protected String                         inFileName = null;

    protected int                                 sizeWindowX = 0;

    protected int                                 sizeWindowY = 0;

    protected int                                 ulX = 0;

    protected int                                 ulY = 0;

    protected IDataWriter                 dataWriter = null;

    protected int                                 nBands = 0;

    protected String                         ident = null;

    protected String                         driver = null;

    protected Params                        driverParams = null;

    protected Extent                        extent = null;

    protected int                                percent = 0;

    protected int                                 dataType = IBuffer.TYPE_BYTE;

    /**

     * Carga los par?metros comunes a todos los drivers en el objeto WriterParams.

     */

    /*public void loadParams() {

            driverParams.clear();

            driverParams.setParam(        "blocksize", 

                                                            String.valueOf(RasterLibrary.blockHeight), 

                                                            Params.CHOICE, 

                                                            new String[]{ "1", "8", "16", "32", "64", "128", "256", "512", "1024"});

            driverParams.setParam(        "georef", 

                                                                "true", 

                                                                Params.CHECK, 

                                                                null);

    }*/

    /**

     * Obtiene la lista de extensiones registradas

     * @return Lista de extensiones registradas o null si no hay ninguna

     */

    public static String[] getDriversExtensions(){

            ExtensionPoints extensionPoints = ExtensionPointsSingleton.getInstance();

            ExtensionPoint extensionPoint = (ExtensionPoint)extensionPoints.get("RasterWriter");

                if(extensionPoint == null)

                        return null;

            String[] list = new String[extensionPoint.size()];

            Set values = extensionPoint.entrySet();

            int i = 0;

            for (Iterator it = values.iterator(); it.hasNext(); ) {

            list[i] = (String)((Map.Entry)it.next()).getKey();

            i++;

        }

            return list;

    }

    /**

     * Obtiene la lista de extensiones de ficheros sobre los que se puede salvar en un determinado

     * tipo de datos. Como par?metro de la funci?n se especifica el tipo de datos sobre el que se

     * desea consultar.

     * Este m?todo consulta para cada driver registrado que extensiones soportan un tipoi

     * @return Lista de extensiones registradas que soportan el tipo de datos pasado por par?metro.

     */

    public static ArrayList getExtensionsSupported(int dataType, int bands) throws RasterDriverException {

            ExtensionPoints extensionPoints = ExtensionPointsSingleton.getInstance();

            ExtensionPoint extensionPoint = (ExtensionPoint)extensionPoints.get("RasterWriter");

                if(extensionPoint == null)

                        return null;

                Set values = extensionPoint.entrySet();

            ArrayList result = new ArrayList();

            for (Iterator it = values.iterator(); it.hasNext(); ) {

                    Map.Entry entry = ((Map.Entry)it.next());

                    String ext = (String)entry.getKey();

            Class writerClass = (Class)entry.getValue();

            Class [] args = {String.class};

                    try {

                            Constructor hazNuevo = writerClass.getConstructor(args);

                            Object [] args2 = {ext};

                            GeoRasterWriter grw = (GeoRasterWriter) hazNuevo.newInstance(args2);

                            if(grw.isSupportedThisExtension(ext, dataType, bands))

                                    result.add(ext);

                    } catch (SecurityException e) {

                            throw new RasterDriverException("Error SecurityException in open");

                    } catch (NoSuchMethodException e) {

                            throw new RasterDriverException("Error NoSuchMethodException in open");

                    } catch (IllegalArgumentException e) {

                            throw new RasterDriverException("Error IllegalArgumentException in open");

                    } catch (InstantiationException e) {

                            throw new RasterDriverException("Error InstantiationException in open");

                    } catch (IllegalAccessException e) {

                            throw new RasterDriverException("Error IllegalAccessException in open");

                    } catch (InvocationTargetException e) {

                            throw new RasterDriverException("Error in open");

                    }

        }

            return result;

    }

    /**

     * Obtiene la lista de tipos de driver

     * @return Lista de tipos de driver registradas o null si no hay ninguno

     */

    public static String[] getDriversType(){

            if (fileFeature.size() == 0)

                    return null;

            String[] list = new String[fileFeature.size()];

            Set values = fileFeature.entrySet();

            int i = 0;

            for (Iterator it=values.iterator(); it.hasNext(); ) {

            list[i] = ((WriteFileFormatFeatures)((Map.Entry)it.next()).getValue()).getDriverName();

            i++;

        }

            return list;

    }

    /**

     * Obtiene el tipo de driver a partir de la extensi?n

     * @param ext        Extensi?n

     * @return        Tipo

     */

    public static String getDriverType(String ext){

            return ((WriteFileFormatFeatures)fileFeature.get(ext)).getDriverName();

    }

    /**

     * Devuelve el n?mero de drivers soportados

     * @return N?mero de drivers soportados

     */

    public static int getNDrivers() {

            ExtensionPoints extensionPoints = ExtensionPointsSingleton.getInstance();

            ExtensionPoint extensionPoint = (ExtensionPoint)extensionPoints.get("RasterWriter");

        return extensionPoint.size();

    }

    /**

     * Devuelve el n?mero de tipos de driver registrados

     * @return N?mero de tipos de driver soportados

     */

    public static int getNTypes() {

        return fileFeature.size();

    }

    /**

     * Devuelve el identificador del driver

     * @return        Identificador del driver

     */

    public String getIdent() {

        return ident;

    }

    /**

     * Obtiene el nombre del driver.

     * @return        Nombre del driver

     */

    public String getDriverName() {

        return driver;

    }

    /**

     * 

     * @return

     */

    public String getDriverType() {

        return driver;

    }

    /**

     * Asigna el porcentaje de incremento. Esto es usado por el driver para actualizar

     * la variable percent

     * @param percent

     */

    public void setPercent(int percent) {

            this.percent = percent;

    }

    /**

     * Porcentaje de escritura completado.

     * @return Entero con el porcentaje de escritura.

     */

    public int getPercent() {

                return percent;

        }

    /**

         * Factoria para obtener escritores de los distintos tipos de raster.

         * 

         * @param fName Nombre del fichero.

         * @return GeoRasterWriter, o null si hay problemas.

         */

        public static GeoRasterWriter getWriter(String fName) throws NotSupportedExtensionException, RasterDriverException {

                String ext = RasterUtilities.getExtensionFromFileName(fName);

                GeoRasterWriter grw = null;

                ExtensionPoints extensionPoints = ExtensionPointsSingleton.getInstance();

            ExtensionPoint extensionPoint = (ExtensionPoint)extensionPoints.get("RasterWriter");

            if(extensionPoint.get(ext) == null) 

                        return grw;

                Class clase = (Class) extensionPoint.get(ext);

                Class [] args = {String.class};

                try {

                        Constructor hazNuevo = clase.getConstructor(args);

                        Object [] args2 = {fName};

                        grw = (GeoRasterWriter) hazNuevo.newInstance(args2);

                } catch (SecurityException e) {

                        throw new RasterDriverException("Error SecurityException in open");

                } catch (NoSuchMethodException e) {

                        throw new RasterDriverException("Error NoSuchMethodException in open");

                } catch (IllegalArgumentException e) {

                        throw new RasterDriverException("Error IllegalArgumentException in open");

                } catch (InstantiationException e) {

                        throw new RasterDriverException("Error InstantiationException in open");

                } catch (IllegalAccessException e) {

                        throw new RasterDriverException("Error IllegalAccessException in open");

                } catch (InvocationTargetException e) {

                        throw new NotSupportedExtensionException("Error in open");

                }

                return grw;

        }

        /**

         * Factoria para obtener escritores de los distintos tipos de raster.

         * 

         * @param fName Nombre del fichero.

         * @return GeoRasterWriter, o null si hay problemas.

         */

        public static GeoRasterWriter getWriter(IDataWriter dataWriter, 

                                                                                     String outFileName, 

                                                                                     int nBands,

                                                                                     Extent ex,

                                                                                     int outSizeX,

                                                                                     int outSizeY,

                                                                                     int dataType,

                                                                                     Params params) throws NotSupportedExtensionException, RasterDriverException {

                String ext = outFileName.toLowerCase().substring(outFileName.lastIndexOf('.')+1);

                GeoRasterWriter grw = null;

                ExtensionPoints extensionPoints = ExtensionPointsSingleton.getInstance();

            ExtensionPoint extensionPoint = (ExtensionPoint)extensionPoints.get("RasterWriter");

            if(extensionPoint.get(ext) == null) 

                        return grw;

                Class clase = (Class) extensionPoint.get(ext);

                Class [] args = {IDataWriter.class, String.class, Integer.class, Extent.class, 

                                                Integer.class, Integer.class, Integer.class, Params.class};

                try {

                        Constructor hazNuevo = clase.getConstructor(args);

                        Object [] args2 = {dataWriter, outFileName, new Integer(nBands), ex, 

                                                                new Integer(outSizeX), new Integer(outSizeY), new Integer(dataType), params};

                        grw = (GeoRasterWriter) hazNuevo.newInstance(args2);

                } catch (SecurityException e) {

                        throw new RasterDriverException("Error SecurityException in open");

                } catch (NoSuchMethodException e) {

                        throw new RasterDriverException("Error NoSuchMethodException in open");

                } catch (IllegalArgumentException e) {

                        throw new RasterDriverException("Error IllegalArgumentException in open");

                } catch (InstantiationException e) {

                        throw new RasterDriverException("Error InstantiationException in open");

                } catch (IllegalAccessException e) {

                        throw new RasterDriverException("Error IllegalAccessException in open");

                } catch (InvocationTargetException e) {

                        throw new NotSupportedExtensionException("Error in open");

                }

                return grw;

        }

        /**

     * Obtiene los par?metros del driver.

     * @return WriterParams

     */

    public Params getParams() {

                return driverParams;

        }

    /**

     * Asigna los par?metros del driver modificados por el cliente.

     * @param Params

     */

    public void setParams(Params params) {

                this.driverParams = params;

        }

    /**

     * Asigna propiedades al driver a partir de un vector de

     * strings donde cada elemento tiene la estructura de

     * propiedad=valor.

     * @param props        Propiedades

     */

    //public abstract void setProps(String[] props);

    /**

     * Realiza la funci?n de compresi?n a partir de un GeoRasterFile.

     * @throws IOException

     */

    public abstract void fileWrite() throws IOException;

    /**

     * Realiza la funci?n de compresi?n a partir de los datos pasados por el cliente.

     * @throws IOException

     */

    public abstract void dataWrite() throws IOException;

    /**

     * Cierra el driver

     */

    public abstract void writeClose();

    /**

     * Cancela el grabado de datos

     */

    public abstract void writeCancel();

    /**

     * M?todo que pregunta si la extensi?n pasada por par?metro est? soportada 

     * con el tipo y n?mero de bandas indicadas.

     * @param dataType Tipo de dato

     * @param bands N?mero de bandas

     * @param extensi?n

     * @return true si est? soportada y false si no lo est?

     */

        public boolean isSupportedThisExtension(String ext, int dataType, int bands) {

                WriteFileFormatFeatures features = (WriteFileFormatFeatures)fileFeature.get(ext);

                if(features == null)

                        return false;

                int bandsSupported = features.getNBandsSupported();

                if(bandsSupported != -1 && bandsSupported < bands)

                        return false;

                int[] dt = features.getDataTypesSupported();

                for (int i = 0; i < dt.length; i++)

                        if(dataType == dt[i])

                                return true;

                return false;

        }

}