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 org.gvsig.raster.lib.buffer.api.exceptions.BandException;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.lang.Cloneable;

import org.gvsig.tools.observer.ComplexWeakReferencingObservable;

/**

 * @author fdiaz

 *

 */

public interface Band extends Cloneable, ComplexWeakReferencingObservable, Disposable {

    /**

     * 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 {@link 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);

    /**

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

     * return null if the value is the NoData value.

     *

     * @param row

     * @param column

     * @return

     */

    public Double getAsDouble(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 value. If NoData is undefined, do

     * nothing.

     *

     * @param value

     */

    public void fill(Object value);

    /**

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

     *

     * @param source

     * @throws BandException

     */

    public void copyFrom(Band source) throws BandException;

    /**

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

     *

     * @param source

     * @param row

     * @param column

     * @throws BandException

     */

    public void copyFrom(Band source, int row, int column) throws BandException;

    /**

     * 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);

    /**

     *

     * @return true if is paginated

     */

    public boolean isPaginated();

    /**

     * @return If supports writing or not

     */

    public boolean isReadOnly();

    /**

     * Gets information about the specified band. If band does not have

     * information, it will return <code>null</code>

     *

     * @param band

     *            The specified band

     * @return Returns information about specified band.

     */

    public BandInfo getBandInfo();

    /**

     * 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);

        public byte[] createRowBuffer();

    }

    /**

     * 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);

        public short[] createRowBuffer();

    }

    /**

     * A Band which elements are integers.

     *

     * @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);

        public int[] createRowBuffer();

    }

    /**

     * 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);

        public float[] createRowBuffer();

    }

    /**

     * A Band which elements are doubles.

     *

     * @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);

        public double[] createRowBuffer();

    }

}