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.util;

import java.awt.geom.AffineTransform;

import java.io.BufferedOutputStream;

import java.io.BufferedReader;

import java.io.DataOutputStream;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.io.FileOutputStream;

import java.io.FileReader;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.text.NumberFormat;

import java.util.ArrayList;

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

import org.gvsig.fmap.dal.coverage.util.FileUtils;

import org.gvsig.fmap.dal.coverage.util.PropertyEvent;

import org.gvsig.fmap.dal.coverage.util.PropertyListener;

/**

 * Utilities for files, directories and file names 

 *

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

 */

public class DefaultFileUtils implements FileUtils {

        /**

         * Copia de ficheros

         * @param pathOrig Ruta de origen

         * @param pathDst Ruta de destino.

         */

        public void copyFile(String pathOrig, String pathDst) throws FileNotFoundException, IOException {

                InputStream in;

                OutputStream out;

                if (pathOrig == null || pathDst == null) {

                        System.err.println("Error en path");

                        return;

                }

                File orig = new File(pathOrig);

                if (!orig.exists() || !orig.isFile() || !orig.canRead()) {

                        System.err.println("Error copying the file:" + pathOrig + " <Source Exists:" + orig.exists() + " Source is file:" + orig.isFile() + " Source can be read:" + orig.canRead());

                        return;

                }

                File dest = new File(pathDst);

                String file = new File(pathOrig).getName();

                if (dest.isDirectory())

                        pathDst += file;

                in = new FileInputStream(pathOrig);

                out = new FileOutputStream(pathDst);

                byte[] buf = new byte[1024];

                int len;

                while ((len = in.read(buf)) > 0)

                        out.write(buf, 0, len);

                in.close();

                out.close();

        }

        /**

         * Crea un fichero de georeferenciaci?n (world file) para un dataset

         * determinado

         * @param fileName Nombre completo del fichero de raster

         * @param Extent

         * @param pxWidth Ancho en p?xeles

         * @param pxHeight Alto en p?xeles

         * @return

         * @throws IOException

         */

        public void createWorldFile(String fileName, Extent ext, int pxWidth, int pxHeight) throws IOException {

                File tfw = null;

                String extWorldFile = ".wld";

                if (fileName.endsWith("tif"))

                        extWorldFile = ".tfw";

                if (fileName.endsWith("jpg") || fileName.endsWith("jpeg"))

                        extWorldFile = ".jpgw";

                tfw = new File(fileName.substring(0, fileName.lastIndexOf(".")) + extWorldFile);

                // Generamos un world file para gdal

                DataOutputStream dos = new DataOutputStream(new BufferedOutputStream(new FileOutputStream(tfw)));

                dos.writeBytes((ext.getMax().getX() - ext.getMin().getX()) / (pxWidth - 1) + "\n");

                dos.writeBytes("0.0\n");

                dos.writeBytes("0.0\n");

                dos.writeBytes((ext.getMin().getY() - ext.getMax().getY()) / (pxHeight - 1) + "\n");

                dos.writeBytes("" + ext.getMin().getX() + "\n");

                dos.writeBytes("" + ext.getMax().getY() + "\n");

                dos.close();

        }

        /**

         * Crea un fichero de georeferenciaci?n (world file) para un dataset

         * determinado

         * @param fileName Nombre completo del fichero de raster

         * @param AffineTransform

         * @param pxWidth Ancho en p?xeles

         * @param pxHeight Alto en p?xeles

         * @return

         * @throws IOException

         */

        public void createWorldFile(String fileName, AffineTransform at, int pxWidth, int pxHeight) throws IOException {

                File tfw = null;

                String extWorldFile = ".wld";

                if (fileName.endsWith("tif"))

                        extWorldFile = ".tfw";

                if (fileName.endsWith("jpg") || fileName.endsWith("jpeg"))

                        extWorldFile = ".jpgw";

                tfw = new File(fileName.substring(0, fileName.lastIndexOf(".")) + extWorldFile);

                // Generamos un world file para gdal

                DataOutputStream dos = new DataOutputStream(new BufferedOutputStream(new FileOutputStream(tfw)));

                dos.writeBytes(at.getScaleX() + "\n");

                dos.writeBytes(at.getShearX() + "\n");

                dos.writeBytes(at.getShearY() + "\n");

                dos.writeBytes(at.getScaleY() + "\n");

                dos.writeBytes("" + at.getTranslateX() + "\n");

                dos.writeBytes("" + at.getTranslateY() + "\n");

                dos.close();

        }

        /**

         * Formatea en forma de cadena un tama?o dado en bytes. El resultado ser? una

         * cadena con GB, MB, KB y B

         * @param size tama?o a formatear

         * @return cadena con la cantidad formateada

         */

        public String formatFileSize(long size) {

                double bytes = size;

                double kBytes = 0.0;

                double mBytes = 0.0;

                double gBytes = 0.0;

                if (bytes >= 1024.0) {

                        kBytes = bytes / 1024.0;

                        if (kBytes >= 1024.0) {

                                mBytes = kBytes / 1024.0;

                                if (mBytes >= 1024.0)

                                        gBytes = mBytes / 1024.0;

                        }

                }

                String texto = "";

                NumberFormat numberFormat = NumberFormat.getNumberInstance();

                numberFormat.setMinimumFractionDigits(0);

                do {

                        if (gBytes > 0) {

                                numberFormat.setMaximumFractionDigits(2 - (int) Math.log10(gBytes));

                                texto = numberFormat.format(gBytes) + " GB";

                                break;

                        }

                        if (mBytes > 0) {

                                numberFormat.setMaximumFractionDigits(2 - (int) Math.log10(mBytes));

                                texto = numberFormat.format(mBytes) + " MB";

                                break;

                        }

                        if (kBytes > 0) {

                                numberFormat.setMaximumFractionDigits(2 - (int) Math.log10(kBytes));

                                texto = numberFormat.format(kBytes) + " KB";

                                break;

                        }

                        if (bytes != 0) {

                                numberFormat.setMaximumFractionDigits(0);

                                texto = numberFormat.format(bytes) + " bytes";

                                break;

                        }

                } while (false);

                numberFormat.setMaximumFractionDigits(0);

                return texto + " (" + numberFormat.format(bytes) + " bytes)";

        }

        /**

         * Obtiene la extensi?n del fichero a partir de su nombre.

         * @param file Nombre o ruta del fichero

         * @return Cadena con la extensi?n que representa el tipo de fichero. Devuelve

         *         null si no tiene extension.

         */

        public String getExtensionFromFileName(String file) {

                return file.substring(file.lastIndexOf(".") + 1).toLowerCase();

        }

        /**

         * Obtiene el nombre de fichero sin la extensi?n.

         * @param file Nombre o ruta del fichero

         * @return Cadena con la extensi?n que representa el tipo de fichero. Si no

         *         tiene extensi?n devuelve el mismo fichero de entrada

         */

        public String getNameWithoutExtension(String file) {

                if (file == null)

                        return null;

                int n = file.lastIndexOf(".");

                if (n != -1)

                        return file.substring(0, n);

                return file;

        }

        /**

         * Obtiene el nombre de fichero sin la extensi?n ni la ruta.

         * @param file Ruta del fichero

         * @return Cadena que representa el nombre del fichero sin extensi?n ni path de directorios

         */

        public String getFileNameFromCanonical(String file) {

                if (file == null)

                        return null;

                int n = file.lastIndexOf(".");

                if (n != -1)

                        file = file.substring(0, n);

                n = file.lastIndexOf(File.separator);

                if(n != -1)

                        file = file.substring(n + 1, file.length());

                return file;

        }

        /**

         * Obtiene el ?ltimo trozo de la cadena a partir de los caracteres que

         * coincidan con el patr?n. En caso de que el patr?n no exista en la cadena

         * devuelve esta completa

         * @param string

         * @param pattern

         * @return

         */

        public String getLastPart(String string, String pattern) {

                int n = string.lastIndexOf(pattern);

                if (n > 0)

                        return string.substring(n + 1, string.length());

                return string;

        }

        /**

         * Obtiene la codificaci?n de un fichero XML

         * @param file Nombre del fichero XML

         * @return Codificaci?n

         */

        public String readFileEncoding(String file) {

                FileReader fr;

                String encoding = null;

                try {

                        fr = new FileReader(file);

                        BufferedReader br = new BufferedReader(fr);

                        char[] buffer = new char[100];

                        br.read(buffer);

                        StringBuffer st = new StringBuffer(new String(buffer));

                        String searchText = "encoding=\"";

                        int index = st.indexOf(searchText);

                        if (index > -1) {

                                st.delete(0, index + searchText.length());

                                encoding = st.substring(0, st.indexOf("\""));

                        }

                        fr.close();

                } catch (FileNotFoundException ex) {

                        ex.printStackTrace();

                } catch (IOException e) {

                        e.printStackTrace();

                }

                return encoding;

        }

        /**

         * Obtiene el nombre del fichero RMF a partir del nombre del fichero. Si el

         * nombre del fichero tiene una extensi?n esta llamada sustituir? la extensi?n

         * existente por .rmf. Si el fichero pasado no tiene extensi?n esta llamada

         * a?adir? .rm al final.

         * @param fileName Nombre del fichero raster de origen

         * @return Nombre del fichero rmf asociado al raster.

         */

        public String getRMFNameFromFileName(String fileName) {

                return getNameWithoutExtension(fileName) + ".rmf";

        }

        /**

         * Recursive directory delete.

         * @param f

         */

        private void deleteDirectory(File f) {

                File[] files = f.listFiles();

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

                        if (files[i].isDirectory())

                                deleteDirectory(files[i]);

                        files[i].delete();

                }

        }

        //******* Servicio de directorios temporales **************

        /**

         * Directorio temporal para la cach?. Si gastamos el mismo que andami este se ocupar? de gestionar su

         * destrucci?n al cerrar gvSIG.

         */

        private String tempCacheDirectoryPath = System.getProperty("java.io.tmpdir")

                        + File.separator + "tmp-andami";

        /**

         * Elimina los ficheros del directorio temporal. Realizamos esta acci?n al

         * levantar la librer?a.

         */

        public void cleanUpTempFiles() {

                try {

                        File tempDirectory = new File(tempCacheDirectoryPath);

                        File[] files = tempDirectory.listFiles();

                        if (files != null)

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

                                        // s?lo por si en un futuro se necesitan crear directorios temporales

                                        if (files[i].isDirectory())

                                                deleteDirectory(files[i]);

                                        files[i].delete();

                                }

                        tempDirectory.delete();

                } catch (Exception e) {

                }

        }

        /**

         * Esta funci?n crea el directorio para temporales y devuelve el manejador

         * del directorio

         * @return

         */

        public File getTemporalFile() {

                File tempDirectory = new File(tempCacheDirectoryPath);

                if (!tempDirectory.exists())

                        tempDirectory.mkdir();

                return tempDirectory;

        }

        /**

         * Esta funci?n crea el directorio para temporales y devuelve la ruta de este

         * @return

         */

        public String getTemporalPath() {

                return getTemporalFile().getAbsolutePath();

        }

        //******* Servicio de nombres de capas ?nicos **************

        /**

         * Contador global de las capas generadas para raster. Hay que contar con que esta

         * clase es un singleton desde el manager. Si hay varias instanciaciones layerCount 

         * dar? valores erroneos. 

         */

        private int                   layerCount = 1;

        private ArrayList<PropertyListener>     

                                                                        propetiesListeners = new ArrayList<PropertyListener>();

        /**

         * La gesti?n de nombres ?nicos en la generaci?n de capas se lleva de forma

         * autom?tica. Cuando alguien crea una capa nueva, si esta no tiene nombre especifico,

         * obtiene su nombre mediante este m?todo. La siguiente vez que se llame dar? un nombre

         * distinto. El nombre de la capa ser? NewLayer_ seguido de un contador de actualizaci?n

         * autom?tica cada vez que se usa.

         * @return Nombre ?nico para la capa.

         */

        public String usesOnlyLayerName() {

                String oldValue = getOnlyLayerName();

                String newValue = "NewLayer_" + (++layerCount);

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

                        if(propetiesListeners.get(i) instanceof PropertyListener)

                                ((PropertyListener)propetiesListeners.get(i)).actionValueChanged(new PropertyEvent(oldValue, "NewLayer", newValue, oldValue));

                return newValue;

        }

        /**

         * Obtiene el nombre ?nico de la siguiente capa sin actualizar el contador. Es

         * solo para consulta. La siguiente vez que se llama a getOnlyLayerName o usesOnlyLayerName

         * devolver? el mismo nomnbre.

         * @return Nombre ?nico para la capa.

         */

        public String getOnlyLayerName() {

                return "NewLayer_" + layerCount;

        }

        /**

         * A?adir un listener a la lista de eventos

         * @param listener

         */

        public void addOnlyLayerNameListener(PropertyListener listener) {

                if (!propetiesListeners.contains(listener))

                        propetiesListeners.add(listener);

        }

        /**

         * Elimina un listener de la lista de eventos

         * @param listener

         */

        public void removeOnlyLayerNameListener(PropertyListener listener) {

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

                        if(propetiesListeners.get(i) == listener)

                                propetiesListeners.remove(i);

        }

        //******* End: Servicio de nombres de capas ?nicos **************

}