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.

* 

*/

package org.gvsig.fmap.dal.coverage.datastruct;

import java.awt.geom.Dimension2D;

import java.awt.geom.Point2D;

import java.awt.geom.Rectangle2D;

import org.cresques.cts.IProjection;

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

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

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

/**

 * Factory for data structures

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

 *

 */

public interface DataStructFactory {

        /**

         * Builds a TransparencyRange object

         * @return

         */

        public TransparencyRange createTransparencyRange();

        /**

         * Creates a <code>Transparency</code> object. This object is useful to render

         * with transparency information.

         * @return

         */

        public Transparency createTransparency(int nBands);

    /**

     * Returns the object which represents the color table library

     * @return

     */

    public ColorTableLibrary getColorTableLibrary();

    /**

     * Builds a extent using upper left coordinate and lower right coordinate 

     * @param ul        upper left coordinate

     * @param lr        lower right coordinate 

     */

    public Extent createExtent(Point2D ul, Point2D lr);

    /**

     * Builds a extent using the four coordinates 

     * @param ul upper left coordinate

     * @param lr lower right coordinate 

     * @param ur upper right coordinate

     * @param ll lower left coordinate 

     */

    public Extent createExtent(Point2D ul, Point2D lr, Point2D ur, Point2D ll);

    /**

     * Builds a extent using upper left coordinate and lower right coordinate 

     * @param x1 X upper left coordinate

     * @param y1 Y upper left coordinate

     * @param x2 X lower right coordinate 

     * @param y2 Y lower right coordinate 

     */

    public Extent createExtent(double x1, double y1, double x2, double y2);

    /**

     * Builds a extent using a rectangle

     * @param r        Rectangle 2D

     */

    public Extent createExtent(Rectangle2D r);

    /**

     * Builds an empty extent

     * @return

     */

    public Extent createExtent();

        /**

         * Builds a new NoData object

         * @param noData

         *        value to assign to all bands

         * @param nativeNoData

         *        The native is the original value

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

         * @param fileName

         *        Name of file owner of this nodata value. This string is useful to

         *        save the rmf file

         * @param bandCount

         *        Number of bands of the file

         * @return NoData

         */

        public NoData createNoData(Number noData, Number nativeNoData, String fileName, int bandCount);

        /**

         * Builds a new NoData for DEMs

         * @param noData

         *        value to assign to all bands

         * @param nativeNoData

         *        The native is the original value

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

         * @param fileName

         *        Name of file owner of this nodata value. This string is useful to

         *        save the rmf file

         * @return NoData

         */

        public NoData createNoData(Number noData, Number nativeNoData, String fileName);

        /**

         * Builds a new NoData for DEMs

         * @param dataType

         *        dataType of this NoData

         * @param bandCount

         *        Number of bands

         * @return NoData

         */

        public NoData createDefaultNoData(int bandCount, int dataType);

        /**

         * Creates a empty DataStore

         * @return

         */

        public RasterDataStore createDataStore();

        /**

         * Creates a empty geopoint

         * @return

         */

        public GeoPoint createGeoPoint();

        /**

         * Creates a geopoint with values

         * @param p

         * @param m

         * @return

         */

        public GeoPoint createGeoPoint(Point2D p, Point2D m);

        /**

         * Gets a new instance of a ColorInterpretation object

         * @param A list of color interpretation strings

         * @return

         */

        public ColorInterpretation createColorInterpretation(String[] colorInterp);

        /**

         * Gets a new instance of a ColorInterpretation object

         * @param A constant defined in <code>ColorInterpretation</code> interface. 

         * It can be RGB, BGR, ARGB, PALETTE or GRAYSCALE 

         * @return

         */

        public ColorInterpretation createColorInterpretation(String colorInterpretationConstant);

         /**

     * Builds a new ViewPortData object

     * @param proj

     * @param extent

     * @param size

     * @return

     */

    public ViewPortData createViewPortData(IProjection proj, Extent extent, Dimension2D size);

    /**

     * Builds a new ViewPortData object

     * @return

     */

    public ViewPortData createViewPortData();

}