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.fmap.dal.coverage.store.parameter;

import java.io.File;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.coverage.store.RasterDataServerExplorer;

/**

 * All raster parameter should inherit from this interface. It provides

 * general methods for open a raster.

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

 */

public interface RasterDataParameters extends DataStoreParameters {

        //Load options

        public static int             REPROJECT_DATA               = 1;

        public static int             REPROJECT_VIEW               = 2;

        public static int             DONT_CHANGE_PROJECTION       = 0;

        public static int             NEW_PROJETION_TO_THE_LAYER   = 6;

        public static int             NOT_LOAD                     = 4;

        public static int             ON_THE_FLY                   = 5;

        //General parameters

        public static final String    FIELD_URI                    = "uri";

        public static final String    FIELD_CRS                    = "CRS";

        public static final String    FIELD_RMF_FOLDER             = "rmf_folder";

        /**

         * Flag to know if this provider is visible or it isn't

         * @return

         */

        public boolean isVisible();

        /**

         * Assigns the flag to know if this provider is visible or it isn't

         * @return

         */

        public void setVisible(boolean visible);

        public boolean isValid();

        /**

         * When a layer is loaded will have several options when its projection is not the same that the view projection.

         * This options are defined as static variables in RasterDataParameters interface 

         * @param frame

         */

        public void setReprojectionOption(int option);

        /**

         * When a layer is loaded will have several options when its projection is not the same that the view projection.

         * This options are defined as static variables in RasterDataParameters interface  

         * @return

         */

        public int getReprojectionOption();

        /**

         * Gets the uniform resource identifier of a provider. This can be

         * a file name or a URL 

         * @return

         */

        public String getURI();

        /**

         * Sets the uniform resource identifier of a provider. This can be

         * a file name or a URL 

         * @param uri

         */

        public void setURI(String uri);

        public String getSRSID();

        public void setSRSID(String srsid);

        public void setSRS(IProjection srs);

        public IProjection getSRS();

        public boolean isOverridingHost();

        public void setOverrideHost(boolean over);

        /**

         * Sets the number of alpha band

         * @param alphaBand

         */

        public void setAlphaBand(int alphaBand);

        /**

         * Sets the frame width

         * @param frame

         */

        public void setFrame(int frame);

        /**

         * Gets the number of alpha band

         * @param alphaBand

         */

        public int getAlphaBand();

        /**

         * Gets the frame width

         * @param frame

         */

        public int getFrame();

        /**

         * Sets the folder to store RMF file. This folder may be different 

         * than the raster folder

         * @param rmfFolder

         */

        public void setRMFFolder(File rmfFolder);

        /**

         * Gets the folder to store RMF file

         * @return

         */

        public File getRMFFolder();

        /**

         * Return true if the store to open is going to be tiled

         */

        public boolean isSourceTiled();

        /**

         * Assigns field from a data parameters to other

         * @param par

         */

        public void assignFields(RasterDataParameters par, RasterDataServerExplorer explorer);

}