Application: gvSIG desktop » gvSIG raster

package org.gvsig.raster.cache.buffer;

import java.io.IOException;

import org.gvsig.raster.cache.buffer.Band;

import org.gvsig.raster.cache.buffer.Buffer;

import org.gvsig.raster.cache.buffer.exception.OperationNotSupportedException;

/**

 * Data Server for read only buffers. 

 * 02/11/2008

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

 */

public interface BufferDataSource {

        /**

         * Get the path to image file

         * @return

         */

        public String getPath();

        /**

         * Set the path to image file

         * @param  path

         *         path to the file

         */

        public void setPath(String path);

        /**

         * Get the band selected to read for loadSelectedBand method

         * @return

         */

        public int getSelectedBand();

        /**

         * Set the band selected to read for loadSelectedBand method

         * @param  band

         *         band to the file

         */

        public void setSelectedBand(int path);

        /**

         * Get the width of the data source

         * @return

         */

        public int getWidth();

        /**

         * Get the height of the data source

         * @return

         */

        public int getHeight();

        /**

         * Get de number of bands

         * @return

         */

        public int getBandCount();

        /**

         * Get the data type

         * @return

         */

        public int getDataType();

        /**

         * Load a page with data. 

         * @param  rb

         *         Page 

         * @param  stripe

         *         Object with the information about data read. This contains positional information.

         * @throws IOException

         * @throws InterruptedException

         * @throws OperationNotSupportedException

         */

        public void loadPage(Buffer rb, PxTile stripe) throws IOException, InterruptedException, OperationNotSupportedException;

        /**

         * Load a one banded page with data. 

         * @param  rb

         *         Page 

         * @param  stripe

         *         Object with the information about data read. This contains positional information.

         * @param  iBand

         *         Band to load

         * @throws IOException

         * @throws InterruptedException

         * @throws OperationNotSupportedException

         */

        public void loadPage(Buffer rb, PxTile stripe, int iBand) throws IOException, InterruptedException, OperationNotSupportedException;

        /**

         * Load a page with data. Only is loaded the band selected in the variable "selectedBand" 

         * @param  rb

         *         Page 

         * @param  stripe

         *         Object with the information about data read. This contains positional information.

         * @throws IOException

         * @throws InterruptedException

         * @throws OperationNotSupportedException

         */

        public void loadSelectedBand(Buffer rb, PxTile stripe) throws IOException, InterruptedException, OperationNotSupportedException;

        /**

         * Load a page of cache from the hard disk

         * @param RasterMemoryBuffer Data buffer to load in memory 

         * @param String File name

         */

        public void loadPage(Buffer buf, String file) throws InterruptedException;

        /**

         * Save a page of cache to the hard disk   

         * @param RasterMemoryBuffer Data buffer to load in memory 

         * @param String File name

         * @throws IOException

         */

        public void savePage(Buffer buf, String file)throws IOException;

        /**

         * Save a band of cache to the hard disk   

         * @param RasterMemoryBuffer Data buffer to load in memory 

         * @param String File name

         * @throws IOException

         */

        public void saveBand(Band buf, String file)throws IOException;

        /**

         * Elimina la fuente de datos de disco

         * @throws IOException

         */

        public void delete(String file)throws IOException;

        /**

         * Close the data source

         */

        public void close() throws IOException;

        /**

         * Change the name of a file

         * @param oldName

         * @param newName

         */

        public void changeFileName(String oldName, String newName);

        /**

         * Clone the datasource to be assigned to each band

         * @return

         */

        public BufferDataSource clone();

}