Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

*

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

*

*/

/*

* AUTHORS (In addition to CIT):

* 2009 IVER T.I   {{Task}}

*/

package org.gvsig.raster.mosaic.io;

import java.util.ArrayList;

import org.gvsig.fmap.dal.coverage.store.parameter.RasterDataParameters;

import org.gvsig.fmap.dal.spi.DataStoreProvider;

import org.gvsig.raster.impl.provider.RasterProvider;

import org.gvsig.timesupport.Time;

/**

 * Parameters for the Mosaic provider

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public interface MosaicDataParameters extends RasterDataParameters {

        public static final String            FIELD_PROVIDERS           = "Providers";

        public static final String            FIELD_PIXELSIZE           = "Pixelsize";

        public static final String            FIELD_NODATA              = "NoData";

        public static final String            FIELD_OVERLAP             = "Overlap";

        public static final String            FIELD_COLORCORRECTION     = "ColorCorrection";

        public static final String            FIELD_TIMESELECTION       = "TimeSelection";

        public static final String            FIELD_PROVIDER_VISIBLE    = "ProviderVisible";

        //Overlap methods

        public static final int               FIRST                     = 0;

        public static final int               LAST                      = 1;

        public static final int               FEATHERING                = 2;

        public static final int               MEAN                      = 3;

        public static final int               MIN                       = 4;

        public static final int               MAX                       = 5;

        //Color correction

        public static final int               NONE                      = 0;

        public static final int               HISTOGRAM_MATCHING        = 1;

        /**

         * Removes a provider from the list

         * @param uri

         */

        public void removeProvider(String uri);

        /**

         * Adds a provider to the list

         * @param prov

         */

        public void addProvider(RasterProvider prov);

        /**

         * Adds a provider to the list if this is not tiled

         * @param prov

         * @return true if the provider has been added and false if doesn't

         */

        public boolean addNotTiledProvider(DataStoreProvider prov);

        /**

         * Returns true if exists a provider with the selected file name

         * @param fileName

         * @return

         */

        public boolean existsProvider(String fileName);

        /**

         * Gets the list of providers

         */

        public ArrayList<RasterProvider> getProviders();

        /**

         * Gets the pixel size

         * @return

         */

        public double getPixelSize();

        /**

         * Sets the pixel size 

         */

        public void setPixelSize(double ps);

        /**

         * Gets the NoData value

         * @return

         */

        public double getNoData();

        /**

         * Sets the NoData value 

         */

        public void setNoData(double nd);

        /**

         * Returns true if the parameters has changed

         * @return

         */

        public boolean hasParamsChanged();

        /**

         * Sets the overlap method. The disposable methods are defined 

         * as a constant in this interface

         * @return

         */

        public void setOverlapMethod(int overlap);

        /**

         * Gets the overlap method. The disposable methods are defined 

         * as a constant in this interface

         * @return

         */

        public int getOverlapMethod();

        /**

         * Sets the color correction method. The disposable methods are defined 

         * as a constant in this interface

         * @return

         */

        public void setColorCorrectionMethod(int colorCorrection);

        /**

         * Gets the color correction method. The disposable methods are defined 

         * as a constant in this interface

         * @return

         */

        public int getColorCorrectionMethod();

        /**

         * Sets the selection of time. If this parameter is null all layers will

         * be selected.

         * @param

         */

        public void setTimeSelection(Time timeSelection);

        /**

         * Gets the selection of time. If this parameter is null all layers will

         * be selected.

         * @return

         */

        public Time getTimeSelection();

}