Application: gvSIG desktop » gvSIG raster

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2016 gvSIG Association

 *

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.fmap.dal.raster.api;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.raster.lib.buffer.api.BandInfo;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.lang.Cloneable;

/**

 * Store for rasters

 * @author dmartinezizquierdo

 *

 */

public interface RasterStore extends DataStore, Cloneable{

    /**

     * May provide a dynamic method to get the legend

     */

    final public static String DYNMETHOD_GETLEGEND_NAME = "getLegend";

    /**

     * May provide a dynamic method to get the Color Interpretation

     */

    final public static String DYNMETHOD_GETCOLORINTERPRETATION_NAME = "getColorInterpretation";

    /**

     * May provide a dynamic method to get the Color Table

     */

    final public static String DYNMETHOD_GETCOLORTABLE_NAME = "getColorTable";

    /**

     * Returns this store's parameters.

     *

     * @return

     *         {@link DataStoreParameters} containing this store's parameters

     */

    public DataStoreParameters getParameters();

    /**

     * Returns all available data in the store

     * @return RasterSet

     * @throws DataException

     */

    RasterSet getRasterSet() throws DataException;

    /**

     * Returns a subset of data taking into account the properties and

     * restrictions of the RasterQuery.

     * @param rasterQuery

     * @param RasterQuery

     * @return RasterSet

     * @throws DataException

     */

    RasterSet getRasterSet(RasterQuery rasterQuery) throws DataException;

    /**

     * Returns a new {@link RasterQuery} associated to this store.

     * @return RasterQuery

     */

    RasterQuery createRasterQuery();

    /**

     * Returns the envelope associated to this store buffer

     * @return Envelope

     * @throws DataException

     */

    Envelope getEnvelope() throws DataException;

    /**

     * Creates a {@link BandQuery} from band received as parameter.

     *

     * @param band

     *            Band to create BandQuery

     * @return BandQuery

     */

    public BandQuery createBandQuery(int band);

    /**

     * Gets information about the specified band. If band does not have

     * information, it will return <code>null</code>

     *

     * @param band

     *            The specified band

     * @return Returns information about specified band.

     */

    public BandInfo getBandInfo(int band);

    /**

     * Gets {@link BandDescriptor} of band received as parameter. If band does

     * not have {@link BandAttributeDescriptor}, this method will return an

     * empty {@link BandDescriptor}.

     *

     * @param band

     *            Band to get its {@link BandDescriptor}

     * @return BandDescriptor

     */

    public BandDescriptor getBandDescriptor(int band);

    /**

     * Gets number of total bands

     *

     * @return Number of bands

     */

    public int getBands();

    /**

     * @param providerName

     * @param parameters

     * @throws DataException

     */

    // OpenRasterStoreParameters parameters

    public void useCache(String providerName, DynObject parameters) throws DataException;

    /**

     * @return

     */

    public RasterCache getCache();

}