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

import java.awt.geom.AffineTransform;

import java.io.File;

import java.io.FileNotFoundException;

import java.io.IOException;

import java.security.NoSuchAlgorithmException;

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

/**

 * Utilities for files, directories and file names 

 *

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

 */

public interface FileUtils {

        /**

         * Copia de ficheros

         * @param pathOrig Ruta de origen

         * @param pathDst Ruta de destino.

         */

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

        /**

         * 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;

        /**

         * 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;

        /**

         * 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);

        /**

         * 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);

        /**

         * 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);

        /**

         * 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);

        /**

         * 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);

        /**

         * Obtiene la codificaci?n de un fichero XML

         * @param file Nombre del fichero XML

         * @return Codificaci?n

         */

        public String readFileEncoding(String file);

        /**

         * 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);

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

        /**

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

         * levantar la librer?a.

         */

        public void cleanUpTempFiles();

        /**

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

         * del directorio

         * @return

         */

        public File getTemporalFile();

        /**

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

         * @return

         */

        public String getTemporalPath();

        /**

         * Gets the name of a raster file

         */

        public String getFormatedRasterFileName(String name);

        /**

         * Converts a string to MD5

         * @param path

         * @return

         * @throws NoSuchAlgorithmException

         */

        public String convertPathToMD5(String path) throws NoSuchAlgorithmException;

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

        /**

         * 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();

        /**

         * 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();

        /**

         * A?adir un listener a la lista de eventos

         * @param listener

         */

        public void addOnlyLayerNameListener(PropertyListener listener);

        /**

         * Elimina un listener de la lista de eventos

         * @param listener

         */

        public void removeOnlyLayerNameListener(PropertyListener listener);

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

}