Application: gvSIG desktop » gvSIG raster

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

/**

 * @author fdiaz

 *

 */

public interface NoData {

    /**

     * Gets a unique value for nodata. It doesn't take into account if the raster has

     * several bands. Returns the same value for all of them.

     * @return the noData

     */

    public Number getValue();

    /**

     * Sets a unique value for nodata. It doesn't take into account if the raster has

     * several bands. Assigns the same value for all of them.

     * @param noData the noData to set

     */

    public void setValue(Number noData);

    /**

     * Returns true if getValue is defined and false if is null

     * @return true if getValue is defined and false if is null

     */

    public boolean isDefined();

    /**

     * NoData value persistence. Saves the nodata value in the rmf.

     */

    public void save();

    /**

     * Loads this class from the rmf.

     */

    public void load();

    /**

     * Deletes the nodata value.

     */

    public void delete();

    /**

     * Restores native value. The native is the original value

     * saved in the head of the file or its metadata. This value

     * has to be assign when NoData object is initialize.

     */

    public void restore();

    /**

     * The native is the original value

     * saved in the head of the file or its metadata. This value

     * has to be assign when NoData object is initialize

     * @return the noData

     */

    public Number getNativeValue();

    /**

     * The native is the original value

     * saved in the head of the file or its metadata. This value

     * has to be assign when NoData object is initialize.

     * @param nativeNoDataValue

     */

    public void setNativeValue(Number nativeNoDataValue);

    /**

     * Sets the file name

     * @param fileName

     * @param bandCount

     */

    public void setFileName(String fileName);

    /**

     * Flag to renderize nodata values as transparent

     * @return true if renderize nodata values as transparent

     */

    public boolean isNoDataTransparent();

    /**

     * Flag to renderize nodata values as transparent

     * @param noDataAsTransparent

     */

    public void setNoDataTransparent(boolean noDataAsTransparent);

    /**

     * Gets the NoData data type

     * @return the data type

     */

    public int getDataType();

    /**

     * Sets the datatype

     * @param datatype

     */

    public void setDataType(int datatype);

    //FIXME: ?Esto no ser?a sobreescribir el m?todo equals?

//    /**

//     * Compares two NoData objects an returns true if contains the same values

//     * @param noData

//     * @return

//     */

//    public boolean compare(NoData noData);

    //FIXME: ?Es necesario?

//    /**

//     * Creates and returns a copy of this object.

//     * @return

//     */

//    public Object clone();

    //FIXME: De aqu? para abajo ?Deber?a ir fuera?

//    //***********************************************

//    //Only for file with more than one band

//

//    /**

//     * Gets the nodata value by band

//     * @param nBand

//     * @return

//     */

//    public Number getValueByBand(int nBand);

//

//    /**

//     * Gets the number of bands

//     * @return

//     */

//    public int getBandCount();

//

//    /**

//     * Sets the number of bands

//     * @param bandCount

//     */

//    public void setBandCount(int bandCount);

//

//    /**

//     * Assigns one value in a band

//     * @param noDataValue

//     */

//    public void setValueByBand(Number noDataValue, int nBand);

}