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.cache.buffer;

import java.io.IOException;

import org.gvsig.raster.cache.buffer.histogram.BufferHistogram;

import org.gvsig.raster.cache.buffer.task.TaskEventManager;

/**

 * This class is responsible of the management of the library's business logic.

 * It is the library's main entry point, and provides all the services to manage

 * {@link BufferCacheService}s.

 * 

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

 * @version $Id$

 */

public interface BufferCacheManager {

        public static int                      DONT_FORCE                 = 0;

        public static int                      MEMORY_BUFFER              = 1;

        public static int                      BAND_CACHE                 = 2;

        public static int                      BAND_VERT_CACHE            = 3;

        public static int                      READ_ONLY_CACHE            = 4;

        /**

         * Valor noData por defecto para la librer?a. En caso de no tener un valor asociado

         * al raster se usar? este.

         */

        public static double            defaultNoDataValue       = -99999;

        public static boolean           noDataValueEnable        = false;

        //*****************************************************

        //BUFFER API

        //*****************************************************

        /**

         * Genera instancias del buffer de datos adecuado al tama?o del raster. Si no hay muchos datos

         * (menos de cacheMemorySize) crear? un buffer en memoria. Si hay m?s de esta cantidad

         * entonces crearemos un buffer cacheado (RasterCache). A partir de la cantidad se?alada

         * por multicacheMemorySize haremos un buffer cacheado donde cada p?gina no ocupa todo

         * el ancho del raster ya que este ser? muy grande. La gesti?n de una cache donde cada

         * pagina ha de partir una l?nea lleva una complejidad a?adida.

         *  

         * @param params Par?metros de la carga

         * @return Objeto RasterBuffer

         */

        public Buffer createBuffer(BufferParam params);

        /**

         * Genera una instancia del buffer de solo lectura. Este buffer consta de una cache y unos apuntadores

         * a las p?ginas en disco. Cuando se accede a los datos se carga en memoria la p?gina pedida.

         *  

         * @param  file 

         *         File to read data

         */

        public Buffer createReadOnlyBuffer(String file);

        /**

         * Creates an instance of a memory buffer

         * 

         * @param dataType Tipo de dato

         * @param width Ancho

         * @param height Alto

         * @param bandNr Banda

         * @param flag En caso de buffers de memoria este flag a true significa que se reserva la memoria

         * para el buffer de forma normal y si est? a false no se reserva por lo que la reserva deber? ser

         * posterior. 

         */

        public Buffer createMemoryBuffer(int dataType, int width, int height, int bandNr, boolean malloc);

        /**

         * Creates an instance of a memory buffer

         * 

         * @param params

         *        Parameters to instantiate this buffer

         */

        public Buffer createMemoryBuffer(BufferParam params);

        /**

         * Creates a new instance of an interpolation object.

         * @param buf IRasterBuffer

         * @return IBufferInterpolation

         */

        public BufferInterpolation createInterpolation(Buffer buf);

        /**

         * Builds a new parameter object

         * @param  x

         *         Upper left X position 

         * @param  y

         *         Upper left X position

         * @param  w

         *         Width

         * @param  h

         *         Height

         */

        public BufferParam createBufferParams(int w, int h);

        /**

         * Creates a parameter object for building a buffer. The buffer type is read-write.

         * This type could be changed after the creation of a {@link BufferParam} object.

         * @param  w

         *         Width

         * @param  h

         *         Height

         * @param  bandCount

         *                    Number of bands

         * @param  dataType

         *         Type of data        

         */

        public BufferParam createBufferParams(int w, int h, int bandCount, int dataType);

        /**

         * Creates a parameter object for building a buffer. For this call the buffer type 

         * is read-only and the source will be a multifile. 

         * @param files

         *        File list in disk

         * @param x

         *        initial pixel

         * @param y

         *        initial pixel

         * @param w

         *        Width in pixels

         * @param h

         *        Height in pixels

         * @param bands

         *        bands to render

         * @return {@link BufferParam}

         * @throws IOException 

         */

        public BufferParam createBufferParams(String[] files, int x, int y, int w, int h, int[] bands) throws IOException;

        /**

         * Creates a parameter object for building a buffer. For this call the buffer type 

         * is read-only. 

         * @param file

         *        File in disk

         * @param x

         *        initial pixel

         * @param y

         *        initial pixel

         * @param w

         *        Width in pixels

         * @param h

         *        Height in pixels

         * @param bands

         *        bands to render

         * @return {@link BufferParam}

         * @throws IOException 

         */

        public BufferParam createBufferParams(String file, int x, int y, int w, int h, int[] bands) throws IOException;

        /**

         * Creates a parameter object for building a buffer. For this call the buffer type 

         * is read-only. 

         * @param file

         *        File in disk

         * @param x

         *        initial pixel

         * @param y

         *        initial pixel

         * @param w

         *        Width in pixels

         * @param h

         *        Height in pixels

         * @param bands

         *        bands to render

         * @return {@link BufferParam}

         * @throws IOException 

         */

        public BufferParam createBufferParams(String file, int x, int y, int w, int h) throws IOException;

        //*****************************************************

        //NODATA API

        //*****************************************************

        /**

         * Builds a new NoData object

         * @param noData

         *        value to assign to all bands

         * @param nativeNoData

         *        The native is the original value

         *        saved in the head of the file or its metadata.

         * @param fileName

         *        Name of file owner of this nodata value. This string is useful to

         *        save the rmf file

         * @param bandCount

         *        Number of bands of the file

         * @return NoData

         */

        public BufferNoData createNoData(Number noData, Number nativeNoData, String fileName, int bandCount);

        /**

         * Builds a new NoData for DEMs

         * @param noData

         *        value to assign to all bands

         * @param nativeNoData

         *        The native is the original value

         *        saved in the head of the file or its metadata.

         * @param fileName

         *        Name of file owner of this nodata value. This string is useful to

         *        save the rmf file

         * @return NoData

         */

        public BufferNoData createNoData(Number noData, Number nativeNoData, String fileName);

        /**

         * Builds a new NoData for DEMs

         * @param dataType

         *        dataType of this NoData

         * @param bandCount

         *        Number of bands

         * @return NoData

         */

        public BufferNoData createDefaultNoData(int bandCount, int dataType);

        //*****************************************************

        //HISTOGRAM API

        //*****************************************************

        /**

         * Creates a empty histogram

         * @param nBands

         * @param min

         * @param max

         * @param dataType

         * @param numberOfClasses

         * @return

         */

        public BufferHistogram createHistogram(int nBands, double[] min, double[] max, int dataType, int numberOfClasses);

        /**

         * Creates a empty histogram

         * @param nBands

         * @param min

         * @param max

         * @param dataType

         * @param numberOfClasses

         * @return

         */

        public BufferHistogram createHistogram(int nBands, int nClasses, double[] min, double[] max);

        //*****************************************************

        //TASK API

        //*****************************************************

        /**

         * Gets a register task. To get a task it will use the current thread ID

         * @return TaskEventManager

         */

        public TaskEventManager getTask();

        /**

         * Registers the object as a task using the current thread ID. It returns

         * a TaskEventManager

         * @param process

         * @return

         */

        public TaskEventManager createTask(Object process);

}