Application: gvSIG desktop

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2017 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.tools.lib.api;

import java.io.File;

import java.util.List;

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

import org.gvsig.fmap.mapcontext.raster.api.RasterLayer;

import org.gvsig.raster.tools.lib.api.exceptions.ClipException;

import org.gvsig.tools.task.SimpleTaskStatus;

/**

 * @author fdiaz

 *

 */

public interface RasterClip {

    /**

     * @param layer the layer to set

     */

    public void setLayer(RasterLayer layer);

    /**

     * @return the layer

     */

    public RasterLayer getLayer();

    /**

     * @param taskStatus

     * @throws ClipException

     */

    public void execute(SimpleTaskStatus taskStatus) throws ClipException;

    /**

     * @param envelope

     */

    public void setEnvelope(Envelope envelope);

    /**

     * @return envelope

     */

    public Envelope getEnvelope();

    /**

     * @param pixelSizeX

     */

    public void setPixelSizeX(double pixelSizeX);

    /**

     * @param pixelSizeY

     */

    public void setPixelSizeY(double pixelSizeY);

    /**

     * @return pixelSizeX

     */

    public double getPixelSizeX();

    /**

     * @return pixelSizeY

     */

    public double getPixelSizeY();

    /**

     * @param interpolationMethod

     */

    public void setInterpolationMethod(int interpolationMethod);

    /**

     * @return

     */

    public int getInterpolationMethod();

    /**

     * @param bands

     */

    public void setBands(List<Integer> bands);

    /**

     * @return

     */

    public List<Integer> getBands();

    /**

     * @param layerNamePrefix

     */

    public void setLayerNamePrefix(String layerNamePrefix);

    /**

     * @return layer name prefix

     */

    public String getLayerNamePrefix();

    /**

     * @param createOneLayerPerBand

     */

    public void setCreateOneLayerPerBand(boolean createOneLayerPerBand);

    /**

     * @return true if will create one layer per band

     */

    public boolean isCreateOneLayerPerBand();

    /**

     * @param folder

     */

    public void setFolder(File folder);

    /**

     * @return The folder where will be created the new raster file

     */

    public File getFolder();

    /**

     * @param saveToNewRasterFile

     */

    public void setSaveToNewRasterFile(boolean saveToNewRasterFile);

    /**

     * @return true if will creates a new raster file

     */

    public boolean isSaveToNewRasterFile();

    /**

     * @return

     */

    int getRows();

    /**

     * @param rows

     */

    void setRows(int rows);

    /**

     * @return

     */

    int getColumns();

    /**

     * @param columns

     */

    void setColumns(int columns);

}