Application: gvSIG desktop » gvSIG raster

import java.awt.geom.AffineTransform;

import java.awt.geom.Point2D;

import java.io.File;

import java.util.List;

import org.cresques.cts.ICoordTrans;

import org.cresques.cts.IProjection;

import org.gvsig.compat.net.ICancellable;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreParameters;

/**

 * Interfaz que deben implementar los almacenes de datos raster.

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

 */

	PyramidRasterStore, RasterStoreProperties, Histogramable {

	public static final int              RED_BAND            = 0x01;

	public static final int              GREEN_BAND          = 0x02;

	public static final int              BLUE_BAND           = 0x04;

	public static final int              ALPHA_BAND          = 0x08;

	/**

	* Tipos de raster dependiendo de su fuente

	*/

	public static final int              POSTGIS             = 1;

	public static final int              REMOTE              = 2;

	public static final int              MOSAIC              = 3;

	/**

	 * Actions to reload the information of a layer such as, read rmf or

	 */

	public void reload();

	/**

	 * Gets a default band list for this provider

	 * @return

	 */

	public BandList getDefaultBandList();

	/**

	 * Gets a list of data parameters. If it doesn't have

	 * internal providers this method will return only one DataParameter

	 * @return

	 */

	public RasterDataParameters[] getDataParametersByProvider();

	/**

	 * Gets a list of sizes. If the provider doesn't have files it will return null.

	 * If the provider has one file it will return an array of one element with the

	 * @return

	 */

	public long[] getFileSizeByProvider();

	/**

	 * @return

	 */

	/**

	 * @return

	 */

	public int[] getBandCountByProvider();

	/**

	 * @return

	 */

	public Metadata[] getMetadataByProvider();

	/**

	 * Gets the number of overviews by provider

	 * @param number of band

	 * @return

	 */

	public int[] getOverviewCountByProvider(int band) throws BandAccessException;

	/**

	 * Gets the size of a overview in one band. The result is a list of strings (WidthXHeight)

	 * @param band

	 * @return

	 */

	public String[] getOverviewSizeByProvider(int band, int overview) throws BandAccessException;

	/**

	 * Gets a list of affine transforms

	 * @return

	 */

	public AffineTransform[] getAffineTransformByProvider();

	/**

	 * Gets the height by provider

	 * @return

	 */

	public double[] getHeightByProvider();

	/**

	 * Gets the width by provider

	 * @return

	 */

	public double[] getWidthByProvider();

	/**

	 * Gets the URI of the source. If the provider has only one band

	 * the result will be the URI. If it is multifile will have to choose

	 * @param band

	 * @return

	 */

	/**

	 * Returns the number of internal providers that it has

	 * @return

	 */

	public int getProviderCount();

	/**

	 * the kind of provider and its implementation.

	 * @param file

	 */

	/**

	 * the kind of provider and its implementation.

	 * @param file

	 */

	/**

	 * Define el valor NoData asociado al raster.

	 * @return

	 */

	public void setNoDataValue(NoData value);

	/**

	 * Obtiene el extent asignado

	 * @return	Extent

	 */

	public Extent getView();

	/**

	 * Creates a new dataset which has the same source reference

	 * @return RasterDataStore

	 */

	public RasterDataStore newDataStore();

	/**

	 * Creates a new dataset which has the same source reference but insure

	 * that the provider will be not tiled. Most of processes has to be applied

	 * @return RasterDataStore

	 */

	public RasterDataStore newNotTiledDataStore();

	/**

	 * @return long que representa el tama?o

	 */

	public long getFileSize();

	/**

	 * Convierte un punto desde coordenadas pixel a coordenadas del mundo.

	 * @param pt Punto a transformar

	 * @return punto transformado en coordenadas del mundo

	 */

	public Point2D rasterToWorld(Point2D pt);

	/**

	 * Convierte un punto desde del mundo a coordenadas pixel.

	 * @param pt Punto a transformar

	 * @return punto transformado en coordenadas pixel

	 */

	public Point2D worldToRaster(Point2D pt);

	/**

	 * datos raster o fuera de ellos.

	 * @param p Punto a calcular

	 * @return true si est? dentro de los l?mites y false si est? fuera

	 */

	public boolean isInside(Point2D p);

	/**

	 * Returns true if the data source is tiled

	 * @return

	 */

	public boolean isTiled();

	/**

	 * Returns true if the provider has several files and all of them has the same extension

	 * @return

	 */

	public boolean isMultiFile();

	/**

	 * Returns true if the source of data is a mosaic of images

	 * @return

	 */

	public boolean isMosaic();

	/**

	 * Obtiene la matriz de transformaci?n del propio raster. Esta matriz es la

	 * encargada de convertir las coordenadas de la petici?n en coordenadas a las

	 * @return

	 */

	public AffineTransform getOwnAffineTransform();

	/**

	 * Obtiene la transformaci?n afin aplicada en las peticiones con coordenadas

	 * reales. Esta corresponde al producto matricial entre la transformaci?n de

	 * @return Matriz de la transformaci?n af?n.

	 */

	public AffineTransform getAffineTransform();

	/**

	 * Asigna una transformaci?n al raster para que se tenga en cuenta en la

	 * asignaci?n del setView. Esta asignaci?n recalcula el extent, el

	 * @param t Transformaci?n af?n a aplicar

	 */

	public void setAffineTransform(AffineTransform transf);

	/**

	 * Gets an object which vectorize a raster

	 * @return

	 * @throws RasterDriverException

	 * @throws ProcessInterruptedException

	 *         This operation can be interrupted

	 */

	public Vectorization createVectorizeObject() throws QueryException, ProcessInterruptedException;

	/**

	 * Builds an render object using this RasterDataStore

	 * @return Render

	 */

	public Render getRender();

	/**

	 * Assigns a render object

	 * @param render

	 */

	public void setRender(Render render);

	/**

	 * Saves georeferencing information in the rmf file

	 * @throws RmfSerializerException

	 */

	public void saveGeoreferencingToRmf() throws RmfSerializerException;

	/**

	 * Saves a color table

	 * @param table

	 * @throws RmfSerializerException

	 */

	public void saveColorTableToRmf(ColorTable table) throws RmfSerializerException;

	/**

	 * Saves the geo point list to a RMF file

	 * @param pointList

	 * @throws RmfSerializerException

	 */

	public void saveGeoPointListToRmf(GeoPointList pointList) throws RmfSerializerException;

	/**

	 * Saves a list of files in the RMF file

	 * @param fileList

	 * @throws RmfSerializerException

	 */

	public void saveROIFileListToRmf(List<File> fileList) throws RmfSerializerException;

	/**

	 * Gets the list of ROI files in the RMF

	 * @return

	 * @throws RmfSerializerException

	 */

	public List<File> getROIFileListFromRmf();

	/**

	 * Tipo de fichero soportado.

	 * Devuelve true si el tipo de fichero (extension) est? soportado, si no

	 * @return  true si est? soportado, si no false.

		*/

	public boolean isFileSupported(String fName);

	/**

	 * Returns true if this DataStore is open and false if not

	 * @return

	 */

	public boolean isOpen();

	/**

	 * Obtiene el flag que dice si el raster est? o no georreferenciado

	 * @return true si est? georreferenciado y false si no lo est?.

	 */

	public boolean isGeoreferenced();

	/**

	 * Returns true if this data store is reproyectable or false if not

	 * @return

	 */

	public boolean isReproyectable();

	/**

	 * Consulta de si un raster tiene rotaci?n o no.

	 * @return true si tiene rotaci?n y false si no la tiene.

	 */

	public boolean isRotated();

	/**

	 * Obtiene el n?mero de overviews de una banda

	 * @return N?mero de overviews del raster.

	 */

	public int getOverviewCount(int band) throws BandAccessException, RasterDriverException;

	/**

	 * Informa de si el dataset soporta overviews o no.

	 * @return true si soporta overviews y false si no las soporta.

	 */

	public boolean overviewsSupport();

	/**

	 * Obtiene el ancho de una overview de una banda

	 * @return

	 * @return

	 */

	public BandList getBands();

	/**

	 * Clones this object

	 * @return RasterDataStore

	 */

	public RasterDataStore cloneDataStore() throws CloneException;

	/**

	 * Gets a provider

	 * @return

	 */

	public CoverageStoreProvider getProvider();

	/**

	 * Sets a provider

	 * @return

	 */

	public void setProvider(CoverageStoreProvider prov);

	/**

	 * Deletes the cache of this layer composed by the files in the provider list

	 */

	public void deleteLayerFromCache();

	/**

	 * Sets the parameters

	 * @param p

	 */

	public void setParameters(DataStoreParameters p);

	/**

	 * Returns the source type (FILE, POSTGIS, REMOTE,...)

	 * @return

	 */

	public int getSourceType();

	/**

	 * This method will return the DataParameters if it has a simple provider behind. If it has

	 * @return

	 */

	public RasterDataParameters getInternalParameters();

	/**

     * Sets the explorer

     * @param explorer

     */

    public void setExplorer(RasterDataServerExplorer explorer);

	/**

	 * Closes this data store

	 * @throws CloseException

	 */

	public void close() throws CloseException;

	//******************************************

	//***********Query methods******************

	/**

	 * Returns the last buffer loaded if the flag storeLastBuffer in the query is true

	 * @return

	 */

	public Buffer getLastBuffer();

	/**

	 * @param x

	 * @param y

	 * @param band

	 * @throws RasterDriverException

	 */

	public Object getData(int x, int y, int band)throws InvalidSetViewException, FileNotOpenException, RasterDriverException;

	/**

	 * Makes a request to load a buffer of data. This call returns an array of results. The first

	 * the legend and so on. This funtion is mainly used by the getTile call. This array contains

	 * @return Object[]

	 */

	public Object[] queryArray(RasterQuery query) throws ProcessInterruptedException, QueryException;

	/**

	 * Makes a request to load a buffer of data. This call returns only a buffer. This call is used

	 * by most functions because the properties are read from the datastore.

	 * @return Buffer

	 */

	public Buffer query(RasterQuery query) throws ProcessInterruptedException, QueryException;

	/**

	 * Sets a tile server to create a second level of cache. This second level will be

	 * created if the cache structure is different to the current.

	 * @param tileServer

	 */

	public void setTileServer(Class<?> tileServer) throws InitializeException;

	/**

	 * is a service of this type if the size is not fixed. Other services, like

	 * WMTS are enclosed too but in this case it will have resolution by level.

	 * This method returns true if the data source is enclosed.

	 * @return

	 */

	public boolean isRasterEnclosed();

	/**

	 * This function returns true if the image to be loaded needs a enhanced filter or

	 * doesn't. It depends on the format, number of bands, type of data and so on.

	 * @return The default value is false but each driver can change this value.

	 */

	public boolean needEnhanced();

	/**

	 * Sets the transformation

	 * @param t

	 */

	public void setCoordTrans(ICoordTrans t);

	/**

	 * Gets the information in a real point

	 * @param x

	 * @return

	 */

	public String getInfoByPoint(double x, double y, ICancellable cancellable) throws InfoByPointException;

	/**

	 * @param x

	 *        X Pixel position

	 * @param y

	 * @throws RemoteServiceException

	 */

	public String getInfoByPoint(double x, double y, Extent extent, int w, int h, ICancellable cancellable) throws InfoByPointException;

	/**

	 * Gets the list of geo points associated to this provider

	 * @return

	 */

	public GeoPointList getGeoPointList();

	/**

	 * Sets the list of geo points associated to this provider

	 */

	public void setGeoPointList(GeoPointList geoPointList);

	/**

	 * Gets the list of regions of interest

	 * @param defaultProjection

	 * @throws ROIException

	 */

	public List<ROI> getRois(IProjection defaultProjection) throws ROIException;

	/**

	 * Gets the list of regions of interest

	 * @param defaultProjection

	 * @throws ROIException

	 */

	public List<ROI> getRois(String epsg) throws ROIException;

	/**

	 * Sets the list of regions of interest

	 * @param rois

	 */

	public void setRois(List<ROI> rois);

}