Application: gvSIG desktop » gvSIG raster

import org.gvsig.tools.lang.Cloneable;

public interface Band extends Cloneable {

    /**

     * Gets the number of columns of the band

     *

     * @return the number of columns of the band

     */

    public int getColumns();

    /**

     * Gets the number of rows of the band

     *

     * @return the number of rows of the band

     */

    public int getRows();

    /**

     * Gets the dataType.

     *

     * The possible data types are defined in BufferManager

     *

     * The data type of the band can't be changed after being created.

     *

     * @return the data type

     */

    public int getDataType();

    /**

     *Gets the NoData value

     *

     * @return the noData of the band. Can't be null;

     */

    public NoData getNoData();

    /**

     * Gets the corresponding value to a row and column of the band

     *

     * @param row

     * @param column

     * @return value of corresponding data type.

     */

    public Object get(int row, int column);

    /**

     * Set the value in the row and column of the band.

     *

     * @param row

     * @param column

     * @param value

     */

    public void set(int row, int column, Object value);

    /**

     * Fills the band with a unique value.

     *

     * If the value is null, fills with NoData

     *

     * @param value

     */

    public void fill(Object value);

    /**

     * Fills this band with a copy of the source data band.

     *

     * @param source

     */

    public void copyFrom(Band source);

    /**

     * Creates an array of corresponding data type.

     *

     * The size of the array is the width of the band.

     *

     * @return an array of corresponding data type.

     */

    public Object createRowBuffer();

    /**

     * Fills the rowBuffer Object with the row.

     *

     * @param row

     * @param rowBuffer

     */

    public void fetchRow(int row, Object rowBuffer);

    /**

     * Fills the row with the rowBuffer

     *

     * @param row

     * @param rowBuffer

     */

    public void putRow(int row, Object rowBuffer);

    /**

     * A Band which elements are bytes.

     *

     * @author fdiaz

     *

     */

    public interface BandByte extends Band {

        /**

         * Gets the corresponding value to the row and column;

         *

         * @param row

         * @param column

         * @return a byte;

         */

        public byte getValue(int row, int column);

        /**

         * Sets the value in the row and column;

         *

         * @param row

         * @param column

         * @param value

         */

        public void setValue(int row, int column, byte value);

        /**

         * Gets a row of the Band.

         * @param row

         *

         * @return an array of bytes.

         */

        public byte[] getRowValues(int row);

        /**

         * Sets a row to the band

         *

         * @param row

         *            Row number

         * @param values

         *            byte array

         */

        public void setRowValues(int row, byte[] values);

    }

    /**

     * A Band which elements are shorts.

     *

     * @author fdiaz

     *

     */

    public interface BandShort extends Band {

        /**

         * Gets the corresponding value to the row and column;

         *

         * @param row

         * @param column

         * @return a short;

         */

        public short getValue(int row, int column);

        /**

         * Sets the value in the row and column;

         *

         * @param row

         * @param column

         * @param value

         */

        public void setValue(int row, int column, short value);

        /**

         * Gets a row of the Band.

         *

         * @param row

         * @return an array of shorts

         */

        public short[] getRowValues(int row);

        /**

         * Sets a row to the band

         *

         * @param row

         *            Row number

         * @param values

         *            byte array

         */

        public void setRowValues(int row, short[] values);

    }

    /**

     * A Band which elements are ints.

     *

     * @author fdiaz

     *

     */

    public interface BandInt extends Band {

        /**

         * Gets the corresponding value to the row and column;

         *

         * @param row

         * @param column

         * @return a int;

         */

        public int getValue(int row, int column);

        /**

         * Sets the value in the row and column;

         *

         * @param row

         * @param column

         * @param value

         */

        public void setValue(int row, int column, int value);

        /**

         * Gets a row of the Band.

         * @param row

         *

         * @return an array of ints

         */

        public int[] getRowValues(int row);

        /**

         * Sets a row to the band

         *

         * @param row

         *            Row number

         * @param values

         *            byte array

         */

        public void setRowValues(int row, int[] values);

    }

    /**

     * A Band which elements are floats.

     *

     * @author fdiaz

     *

     */

    public interface BandFloat extends Band {

        /**

         * Gets the corresponding value to the row and column;

         *

         * @param row

         * @param column

         * @return a byte;

         */

        public float getValue(int row, int column);

        /**

         * Sets the value in the row and column;

         *

         * @param row

         * @param column

         * @param value

         */

        public void setValue(int row, int column, float value);

        /**

         * Gets a row of the Band.

         * @param row

         *

         * @return an array of floats

         */

        public float[] getRowValues(int row);

        /**

         * Sets a row to the band

         *

         * @param row

         *            Row number

         * @param values

         *            byte array

         */

        public void setRowValues(int row, float[] values);

    }

    /**

     * A Band which elements are double.

     *

     * @author fdiaz

     *

     */

    public interface BandDouble extends Band {

        /**

         * Gets the corresponding value to the row and column;

         *

         * @param row

         * @param column

         * @return a byte;

         */

        public double getValue(int row, int column);

        /**

         * Sets the value in the row and column;

         *

         * @param row

         * @param column

         * @param value

         */

        public void setValue(int row, int column, double value);

        /**

         * Gets a row of the Band.

         * @param row

         *

         * @return an array of doubles

         */

        public double[] getRowValues(int row);

        /**

         * Sets a row to the band

         *

         * @param row

         *            Row number

         * @param values

         *            byte array

         */

        public void setRowValues(int row, double[] values);

    }