Application: gvSIG desktop » gvSIG raster

package org.gvsig.fmap.dal.coverage;

import java.io.IOException;

import org.gvsig.fmap.dal.coverage.dataset.Buffer;

import org.gvsig.fmap.dal.coverage.dataset.BufferParam;

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

import org.gvsig.fmap.dal.coverage.exception.BufferCreationException;

import org.gvsig.fmap.dal.coverage.store.RasterDataStore;

/**

 * Factory for raster buffers

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

 */

public interface BufferFactory {

        /**

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

         * The buffer will be cached if it's necessary

         * @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, 

                        boolean malloc);

        /**

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

         * The buffer will be stored in memory.

         * @param  w

         *         Width

         * @param  h

         *         Height

         * @param  bandCount

         *                    Number of bands

         * @param  dataType

         *         Type of data        

         */

        public BufferParam createMemoryBufferParams(

                        int w, 

                        int h, 

                        int bandCount, 

                        int dataType, 

                        boolean malloc);

        /**

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

         * is read-only. 

         * @return {@link BufferParam}

         * @throws IOException 

         */

        public BufferParam createReadOnlyBufferParams(

                        RasterDataStore store,

                        int minx,

                        int miny,

                        int maxx,

                        int maxy,

                        BandList bandList);

        /**

         * Creates a buffer with the selected parameters

         * @param param

         * @return

         * @throws BufferCreationException 

         */

        public Buffer createBuffer(BufferParam param) throws BufferCreationException;

}