Application: gvSIG desktop

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2016 gvSIG Association

 *

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

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.raster.lib.buffer.api;

import java.awt.image.BufferedImage;

import java.awt.image.DataBuffer;

import java.awt.image.Raster;

import java.io.File;

import java.io.IOException;

import java.util.List;

import java.util.Map;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.raster.lib.buffer.api.exceptions.BandException;

import org.gvsig.raster.lib.buffer.api.exceptions.BufferException;

import org.gvsig.tools.dataTypes.CoercionException;

/**

 * @author fdiaz

 *

 */

public interface BufferManager {

    public final static int TYPE_UNDEFINED = DataBuffer.TYPE_UNDEFINED;

    public final static int TYPE_BYTE = DataBuffer.TYPE_BYTE;

    public final static int TYPE_USHORT = DataBuffer.TYPE_USHORT;

    public final static int TYPE_SHORT = DataBuffer.TYPE_SHORT;

    public final static int TYPE_INT = DataBuffer.TYPE_INT;

    public final static int TYPE_FLOAT = DataBuffer.TYPE_FLOAT;

    public final static int TYPE_DOUBLE = DataBuffer.TYPE_DOUBLE;

    /**

     * Creates a NoData object.

     *

     * @param value

     * @param defaultValue

     *

     * @return NoData

     */

    public NoData createNoData(Number value, Number defaultValue);

    /**

     * Creates {@link BandInfo} with information about one band.

     *

     * @param band

     *            Band of this {@link BandInfo}

     * @param name

     *            Band name

     * @param description

     *            Description of band

     * @param dataType

     *            Data type of band. See {@link BufferManager} to check types.

     * @param values

     *            A key-value map with information properties about band

     * @return BandInfo

     */

    public BandInfo createBandInfo(int band, String name, String description, int dataType,

        List<Map.Entry<Object, Object>> values);

    /**

     * Creates a {@link Band}. If {@link PageManager} is null, the band will be

     * in

     * memory, otherwise, the band will be paginated using page manager.

     *

     * @param dataType

     *            Type of band. Check {@link BufferManager} to see what types

     *            are available

     * @param rows

     *            Band rows

     * @param columns

     *            Band columns

     * @param noData

     *            {@link NoData} of band. If It is null, a undefined NoData will

     *            be set.

     * @param pageManager

     *            Page manager to paginate band. It page manager is null, band

     *            will be in memory.

     * @return Band A empty band.

     * @throws BandException

     *             If there are problems creating the band.

     * @see BufferManager#createNoData(Number, Number)

     * @see BufferManager#createBandInfo(String, String, List)

     * @see BufferManager#createSimpleBandPageManager(File, int, int, int)

     */

    public Band createBand(int dataType, int rows, int columns, NoData noData,

        PageManager pageManager) throws BandException;

    /**

     * Creates a memory buffer.

     *

     * @param rows

     *            Rows of buffer. All buffer bands will have the same rows as

     *            buffer.

     * @param columns

     *            Columns of buffer. All buffer bands will have the same

     *            columns as buffer.

     * @param bandDataTypes

     *            Types of buffer bands, see {@link BufferManager} to get types.

     *            The length of array indicates number of buffer bands.

     * @param projection

     *            Projection of buffer.

     * @return Buffer

     * @throws BufferException

     *             If there is any problem creating buffer.

     */

    Buffer createBuffer(int rows, int columns, int[] bandDataTypes, IProjection projection)

        throws BufferException;

    /**

     * Creates a memory buffer.

     *

     * @param rows

     *            Rows of buffer. All buffer bands will have the same rows as

     *            buffer.

     * @param columns

     *            Columns of buffer. All buffer bands will have the same

     *            columns as buffer.

     * @param bandDataTypes

     *            Types of buffer bands, see {@link BufferManager} to get types.

     *            The length of array indicates number of buffer bands.

     * @param bandNodata

     *            {@link NoData} of each band. It can be null. If there are

     *            bands without NoData object, a undefined NoData will be set.

     * @param projection

     *            Projection of buffer.

     * @return Buffer

     * @throws BufferException

     *             If there is any problem creating buffer.

     */

    Buffer createBuffer(int rows, int columns, int[] bandDataTypes, NoData[] bandNodata,

        IProjection projection) throws BufferException;

    /**

     * Creates a memory buffer.

     *

     * @param rows

     *            Rows of buffer. All buffer bands will have the same rows as

     *            buffer.

     * @param columns

     *            Columns of buffer. All buffer bands will have the same

     *            columns as buffer.

     * @param bandDataTypes

     *            Types of buffer bands, see {@link BufferManager} to get types.

     *            The length of array indicates number of buffer bands.

     * @param bandNodata

     *            {@link NoData} of each band. If there are bands without NoData

     *            object, a undefined NoData will be set. It can be

     *            <code>null</code>.

     * @param projection

     *            Projection of buffer.

     * @param envelope

     *            Envelope of data. It can be <code>null</code>.

     * @return Buffer

     * @throws BufferException

     *             If there is any problem creating buffer.

     */

    Buffer createBuffer(int rows, int columns, int[] bandDataTypes, NoData[] bandNodata,

        IProjection projection, Envelope envelope) throws BufferException;

    /**

     * Creates a buffer. Buffer bands will be paginated using

     * {@link BandPageManager}.

     *

     * @param rows

     *            Rows of buffer. All buffer bands will have the same rows as

     *            buffer.

     * @param columns

     *            Columns of buffer. All buffer bands will have the same

     *            columns as buffer.

     * @param bandDataTypes

     *            Types of buffer bands, see {@link BufferManager} to get types.

     *            The length of array indicates number of buffer bands.

     * @param bandNoData

     *            {@link NoData} of each band. If there are bands without NoData

     *            object, a undefined NoData will be set. It can be

     *            <code>null</code>.

     * @param projection

     *            Projection of buffer.

     * @param envelope

     *            Envelope of data. It can be <code>null</code>.

     * @param pageManagers

     *            Page manager list to paginate data bands. If there are bands

     *            without page manager,

     *            they will be loaded at memory.

     * @return Buffer

     * @throws BufferException

     *             If there is any problem creating buffer.

     */

    public Buffer createBuffer(int rows, int columns, int[] bandDataTypes, NoData[] bandNoData,

        IProjection projection, Envelope envelope, List<PageManager> pageManagers)

        throws BufferException;

    /**

     * Creates a buffer from another buffer.

     * If paginated parameter is false the buffer bands will be in memory.

     * If paginated parameter is true the buffer bands will be paginated using a simple band page manager.

     *

     * @param buffer

     * @param paginated

     * @return Buffer

     * @throws BufferException

     */

    public Buffer createBuffer(Buffer buffer, boolean paginated) throws BufferException;

    /**

     * Create one buffer from another by changing the type. The returned buffer will be like a view

     * of the original buffer. It not reserve additional memory.

     *

     * @param buffer

     * @param type

     * @return a converted type buffer

     * @throws BufferException

     */

    public Buffer createConvertedTypeBuffer(Buffer buffer, int type) throws BufferException;

    /**

     * Creates a buffer from clipping of a buffer. The returned clipping will be like a view

     * of the original buffer. It not reserve additional memory. It will only be

     * a walkway to access an area of the buffer.

     *

     * @param buffer

     * @param envelope

     * @return a clip buffer

     * @throws BufferException

     */

    public Buffer createClippedBuffer(Buffer buffer, Envelope envelope) throws BufferException;

    /**

     * @param file

     * @param rows

     * @param columns

     * @param dataType

     * @return BandPageManager

     * @throws IOException

     */

    public PageManager createSimpleBandPageManager(File file, int rows, int columns, int dataType)

        throws IOException;

    /**

     *

     * @param files

     * @param rows

     * @param columns

     * @param dataType

     * @return A list of page managers

     * @throws IOException

     */

    public List<PageManager> createSimpleBandPageManagerList(File[] files, int rows, int columns,

        int[] dataType) throws IOException;

    /**

     * @param dataType

     *            Data tpye

     * @return Data type size in bytes

     */

    public int getDataTypeSize(int dataType);

    /**

     * Creates a clipping of a band. The returned clipping will be like a view

     * of the original band. It not reserve additional memory. It will only be

     * a walkway to access an area of the band.

     *

     * @param buffer

     * @param band

     * @return Band

     * @throws BandException

     */

    public Band createClippedBand(Buffer buffer, Band band) throws BandException;

    /**

     * Create one band from another by changing the type. The returned clipping will be like a view

     * of the original band. It not reserve additional memory.

     *

     * @param buffer

     * @param band

     * @param type

     * @return Band

     * @throws BandException

     */

    public Band createConvertedTypeBand(Buffer buffer, Band band, int type) throws BandException;

    /**

     * Creates a forced RGBA Buffer from a BufferedImage

     *

     * @param img

     * @param projection

     * @param envelope

     *

     * @return Buffer

     * @throws BufferException

     */

    public Buffer createRGBABuffer(BufferedImage img, IProjection projection, Envelope envelope) throws BufferException;

    /**

     * Creates a forced RGB Buffer from a BufferedImage

     *

     * @param img

     * @param projection

     * @param envelope

     *

     * @return Buffer

     * @throws BufferException

     */

    public Buffer createRGBBuffer(BufferedImage img, IProjection projection, Envelope envelope) throws BufferException;

    /**

     * Return type's name

     *

     * @param type

     * @return

     */

    public String getTypeName(int type);

    /**

     * @param dataType

     * @return

     */

    String getBufferTypeName(int dataType);

    public Object coerce(int dataType, Object value) throws CoercionException;

    List<Buffer> createOneBufferPerBand(Buffer buffer, boolean paginated) throws BufferException;

    /**

     * @param rows

     * @param columns

     * @param envelope

     * @return

     */

    public BufferDimensions createBufferDimensions(int rows, int columns, Envelope envelope);

    /**

     * @param folder

     */

    public void setLastFolderUsedToSaveRaster(File folder);

    /**

     * @return

     */

    public File getLastFolderUsedToSaveRaster();

    public Kernel createKernel(double[][] k);

    public Kernel createKernel(double[][] k, double divisor);

    /**

     * @param img

     * @return

     * @throws IOException

     */

    public List<PageManager> createAwtRasterBandPageManagerList(Raster img) throws IOException;

    /**

     * @param img

     * @param band

     * @return

     */

    public BandPageManager createAwtRasterBandPageManager(Raster img, int band);

    /**

     * @param raster

     * @return

     */

    public int getBufferTypeFromAwtRaster(Raster raster);

    /**

     * @param raster

     * @param projection

     * @param envelope

     * @return

     * @throws IOException

     * @throws BufferException

     */

    public Buffer createBufferFromAwtRaster(Raster raster, IProjection projection, Envelope envelope) throws IOException, BufferException;

}