Application: gvSIG desktop » gvSIG raster

import java.awt.Image;

import java.awt.geom.AffineTransform;

import java.awt.geom.Point2D;

import org.cresques.cts.IProjection;

import org.gvsig.compat.net.ICancellable;

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

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

/**

 * This interface have to be implemented by a raster data source. Is used by a store to

 * provide services from a specific source.

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

 *

 */

public interface RasterProvider extends CoverageStoreProvider, Histogramable {

	public void reload();

	/**

	 * 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

	 */

	/**

	 * Gets the URI of the first provider.

	 *         File name or URI

	 */

	/**

	 * @return

	 */

	public int[] getBandCountByProvider();

	/**

	 * Selecting a number of band this function returns the number of band

	 * inside the file. If this provider has only one file the result

	 * @return

	 */

	public int getBandPositionByProvider(int band);

	/**

	 * Returns the number of internal providers that it has

	 * @return

	 */

	public int getInternalProviderCount();

	/**

	 * Gets the internal provider of the i position

	 * @param i

	 * @return

	 */

	public RasterProvider getInternalProvider(int i);

	/**

	 * 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

	 */

	/**

	 * Gets the uniform resource identifier

	 * @return

	 */

	/**

	 * Gets the number of subdatasets

	 * @return

	 */

	public int getSubdatasetCount();

	/**

	 * the kind of provider and its implementation.

	 * @param file

	 */

	/**

	 * the kind of provider and its implementation.

	 * @param file

	 */

	/**

	 * Obtiene el n?mero de bandas del raster

	 * @return N?mero de bandas

	 */

	public int getBandCount();

	/**

	 * Obtiene el tipo de dato por banda

	 * @return tipo de dato por banda

	 */

	public int[] getDataType();

	/**

	 * Obtiene la altura del raster en p?xeles.

	 * @return altura

	 * @return anchura

	 */

	public double getWidth();

	/**

	 * Devuelve si el Dataset es reproyectable

	 * @return

	 */

	public boolean isReproyectable();

	/**

	 * Returns true if this raster has rotation and false if don't

	 */

	public boolean isRotated();

	/**

	 * Returns true if this provider is open and false if don't

	 * @return

	 */

	public boolean isOpen();

	/**

	 * Returns true if this provider supports time.

	 * @return

	 */

	public boolean isTimeSupported();

	/**

	 * Returns true if the provider support tiles

	 * @return

	 */

	public boolean isTiled();

	/**

	 * Informa de si el dataset soporta overviews o no.

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

	 */

	public boolean isOverviewsSupported();

	/**

	 * Obtiene el n?mero de overviews de una banda

	 * @return

	 */

	public int getOverviewHeight(int band, int overview) throws BandAccessException, RasterDriverException;

	/**

	 * Informa de si el punto en coordenadas del mundo real pasado por par?metro cae dentro del

	 * raster o fuera. Para este calculo cogeremos el punto a averiguar si est? dentro del raster

	 * @return true si el punto est? dentro y false si est? fuera.

	 */

	public boolean isInside(Point2D p);

	/**

	 * Gets the nodata value.

	 * @return

	 */

	public NoData getNoDataValue();

	/**

	 * Gets statistics of this provider

	 * @return MultiFileStatistics

	 */

	public Statistics getStatistics();

	/**

	 */

	public void setStatistics(Statistics stats) throws RmfSerializerException;

	/**

	 * Obtiene el extent del raster.

	 * @return Extent

	 */

	public Extent getExtent();

	/**

	 * @return

	 */

	public String getFileSuffix();

	/**

	 * Este es el extent sobre el que se ajusta una petici?n para que esta no

	 * exceda el extent m?ximo del raster. Para un raster sin rotar ser? igual al

	 * @return Extent

	 */

	public Extent getExtentWithoutRot();

	/**

	 * 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();

	/**

	 * Sets the provider projection

	 * @return IProjection

	 */

	public IProjection getProjection();

	/**

	 * Gets the provider projection

	 * @return IProjection

	 */

	public void setProjection(IProjection proj, boolean persist) throws RmfSerializerException;

	/**

	 * Obtiene el extent asignado

	 * @return	Extent

	 */

	public Extent getView();

	/**

	 * Gets a DatasetMetadata object

	 * @return

	 */

	public Metadata getMetadata();

	/**

	 * Gets the object with the color interpretation by band

	 * @return ColorInterpretation

	 */

	public ColorInterpretation getColorInterpretation();

	/**

	 * Assigns the object with the color interpretation by band

	 * @param ci

	 */

	public void setColorInterpretation(ColorInterpretation ci);

	/**

	 * Define el objeto paleta. Si se define null quiere decir que no tiene paleta

	 * para su visualizaci?n.

	 * @param value

	 */

	public void setColorTable(ColorTable value);

	/**

	 * Gets the {@link ColorTable} or null if the raster

	 * does not have

	 * @return

	 */

	public ColorTable getColorTable();

	/**

	 * Gets the legend as a image. The store could not have implemented this method .

	 * could return a legend as image.

	 * @return

	 */

	public Image getImageLegend();

	/**

	 * Obtiene el estado de transparencia a partir de los estados de transparencia de todos

	 * transparencia estas tendr?n que ser mezcladas sobre una banda de transparencia ?nica.

	 * @return Objeto FileTransparency con el estado de transparencia

	 */

	public Transparency getTransparency();

	/**

	 * Cierra los raster asociados.

	 */

	public void close();

	/**

	 * 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);

	/**

	 * 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 t);

	/**

	 * Gets the pixel size

	 * @return

	 */

	public double getCellSize();

	/**

	 * Obtiene el tama?o de pixel en X

	 * @return tama?o de pixel en X

	 * @return tama?o de pixel en Y

	 */

	public double getPixelSizeY();

	/**

	 * Obtiene el valor del raster en la coordenada que se le pasa.

	 * El valor ser? Double, Int, Byte, etc. dependiendo del tipo de

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

	/**

	 * multiDataset deben tener la misma proyecci?n obtenemos esta del primer

	 * dataset.

	 * @return Proyecci?n en formato cadena

	 * @throws RasterDriverException

	 */

	public String getWktProjection() throws RasterDriverException;

	/**

	 * Sets the nodata value

	 * @return

	 */

	public void setNoDataValue(NoData value);

	/**

	 * 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 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();

	/**

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

	 */

	public void deleteLayerFromCache();

	/**

	 * Clone this RasterProvider

	 * @return

	 */

	public RasterProvider cloneProvider() throws CloneException;

	/**

	 * Returs the DataParameters

	 * @return

	 */

	public RasterDataParameters getDataParameters();

	/**

	 * Reads a complete block of data and returns an tridimensional array of the right type. This function is useful

	 * @deprecated This method is only used to generate statistics. The statistics have to change the way in

	 * which are calculated. Then this function will be eliminated.

	 */

	public Object readBlock(int pos, int blockHeight, double scale)

		throws InvalidSetViewException, FileNotOpenException, RasterDriverException, ProcessInterruptedException;

	/**

	 * Carga un objecto desde un serializador usando el tipo del mismo objeto pasado por parametro.

	 * Usa value para iniciar dicho serializador

	 * @throws RmfSerializerException

	 */

	public Object loadObjectFromRmf(Class<?> class1, Object value) throws RmfSerializerException;

	/**

	 * Guarda en el RMF el objecto actual en caso de que exista un serializador para el.

	 * El tipo del objeto se especifica en el parametro class1.

	 * Esto nos puede permitir poder poner a null un valor y encontrar su serializador.

	 * @param class1

	 * @param value

	 */

	public void saveObjectToRmf(Class<?> class1, Object value) throws RmfSerializerException;

	/**

	 * Sets the status information using other provider of the same type. The first action

	 * of this method should be to check the type of the parameter.

	 * @param provider

	 */

	public void setStatus(RasterProvider provider);

	/**

	 * Gets the information in a real point

	 * @param x

	 * @param y

	 * @return

	 */

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

	/**

	 * @param x

	 *        X Pixel position

	 * @param y

	 * @throws RemoteServiceException

	 */

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

	/**

	 * Gets the tile cache data server

	 * @return

	 */

	public TileServer getTileServer();

	/**

	 * 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();

	/**

	 * Gets the rmf file path. This method will have to be redefined by providers

	 * with a different path

	 * @return

	 */

	/**

	 * Selects the subdataset.

	 */

	public void selectSubdataset();

	/**

	 * Gets the list of supported formats

	 * @return

	 */

	public String[] getFormatList();

	/**

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

	 * @return

	 */

	public int getSourceType();

	/**

	 * 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();

	/**

	 * Gets the time serial information

	 * @return

	 */

	public TimeSeries getTimeSerials() throws RmfSerializerException;

	/**

	 * Sets the time serial information

	 */

	public void setTimeSerials(TimeSeries serialInfo) throws RmfSerializerException;

	 * Gets the set of data selected in the {@link RasterQuery}

	 * @param q

	 * @return

	 */

	public Buffer getDataSet(SpiRasterQuery query) throws ProcessInterruptedException, RasterDriverException;

	/**

	 * 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);

}