Application: gvSIG desktop » gvSIG raster

package org.gvsig.fmap.dal.coverage.store.parameter;

import java.awt.geom.AffineTransform;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.dal.NewDataStoreParameters;

import org.gvsig.fmap.dal.coverage.dataset.Buffer;

import org.gvsig.fmap.dal.coverage.datastruct.Params;

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

import org.gvsig.fmap.dal.coverage.store.props.ColorInterpretation;

/**

 * This class represents parameters that we need to create a new

 * raster source.

 *

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

 */

public interface NewRasterStoreParameters extends NewDataStoreParameters {

        public static String          FIELD_BUFFER                 = "buffer";

        public static String          FIELD_COLORINTERPRETATION    = "colorInterpretation";

        public static String          FIELD_SRS                    = "srs";

        public static String          FIELD_PARAMS                 = "driverparams";

        public static String          FIELD_BAND                   = "band";

        public static String          FIELD_WKT                    = "wktproj";

        public static String          FIELD_AFFINETRANSFORM        = "affineTransform";

        public static String          FIELD_DATA_SERVER            = "dataserver";

        /**

         * Sets the data server

         * @param dataServer

         */

        public void setDataServer(DataServerWriter dataServer);

        /**

         * Sets the name of the file to save

         * @param fileName

         */

        public void setDestination(String path, String fileName);

        /**

         * Sets the buffer with data loaded

         * @param buffer

         */

        public void setBuffer(Buffer buffer);

        /**

         * Sets the color interpretation. Constants with color interpretation are

         * declared int {@link ColorInterpretation} class.

         * @param colorInterpretation

         */

        public void setColorInterpretation(String[] colorInterpretation);

        /**

         * Sets the projection

         * @param projection

         */

        public void setProjection(IProjection projection);

        /**

         * Sets the driver parameters. This method is useful when the parameters are loaded 

         * using the driver GUI. If this parameters does not exists then it will use generic

         * configuration.

         * @param params

         */

        public void setDriverParams(Params params);

        /**

         * Sets the projection using Wkt notation

         * @param wkt

         */

        public void setWktProjection(String wkt);

        /**

         * Sets the number of band in the buffer that will be saved. If this value is greater

         * than zero only one band (n) will be written. If this value is lower than zero 

         * then all bands will be written. This is the value by default. 

         * @param n

         */

        public void setBand(int n);

        /**

         * This method is maintained to keep compatibility with the old system. It is recommended

         * not to use. If the buffer don't have bounding box the affine transform will be the 

         * identity and if not the affine transform will be calculated using the geographic information.

         * 

         * @param at

         * @deprecated 

         */

        public void setAffineTransform(AffineTransform at);

        /**

         * This method is maintained to keep compatibility with the old system. It is recommended

         * not to use. If the buffer don't have bounding box the affine transform will be the 

         * identity and if not the affine transform will be calculated using the geographic information.

         * 

         * @return AffineTransform

         */

        public AffineTransform getAffineTransform();

        /**

         * Gets the number of band in the buffer that will be saved. If this value is greater

         * than zero only one band (n) will be written. If this value is lower than zero 

         * then all bands will be written. This is the value by default. 

         * @return

         */

        public int getBand();

        /**

         * Gets the projection using Wkt notation

         * @return

         */

        public String getWktProjection();

        /**

         * Gets the driver parameters. This method is useful when the parameters are loaded 

         * using the driver GUI. If this parameters does not exists then it will use generic

         * configuration.

         * @return

         */

        public Params getDriverParams();

        /**

         * Gets the name of the file to save

         * @return

         */

        public String getFileName();

        public String getPath();

        /**

         * Gets the buffer with data loaded

         * @return

         */

        public Buffer getBuffer();

        /**

         * Gets the color interpretation. Constants with color interpretation are

         * declared int {@link ColorInterpretation} class.

         * @return

         */

        public String[] getColorInterpretation();

        /**

         * Gets the projection

         * @return

         */

        public IProjection getProjection();

        /**

         * Gets the data server

         * @return

         */

        public DataServerWriter getDataServer();

}