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 java.util.List;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreParameters;

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

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

import org.gvsig.fmap.geom.exception.CreateEnvelopeException;

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

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

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

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.lang.Cloneable;

import org.gvsig.tools.locator.LocatorException;

/**

 * 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

     * @throws CreateEnvelopeException

     * @throws LocatorException

     */

    Envelope getEnvelope() throws DataException, LocatorException, CreateEnvelopeException;

    /**

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

     *

     * @param band

     *            Band to create BandQuery

     * @return BandQuery

     */

    public BandQuery createBandQuery(int band);

    /**

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

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

     * empty {@link BandsDescriptor}.

     *

     * @param band

     *            Band to get its {@link BandsDescriptor}

     * @return BandDescriptor

     */

    public BandDescriptor getBandDescriptor(int band);

    /**

     * Gets number of total bands

     *

     * @return Number of bands

     */

    public int getBands();

    /**

     * @return

     */

    public RasterCache getCache();

    /**

     * Add a band from other store.

     * If the store is the same of main store will return a IllegalAttributeException

     *

     * @param store

     * @param band

     * @throws DataException

     */

    public void addBand(RasterStore store, int band) throws DataException;

    /**

     * Add a list of bands from other store.

     * If the store is the same of main store will return a IllegalAttributeException

     *

     * @param store

     * @param bands

     * @throws DataException

     */

    public void addBands(RasterStore store, List<Integer> bands) throws DataException;

    /**

     * Remove a band.

     * If band belongs to main store, will return a IllegalAttributeException

     *

     * @param band

     */

    public void removeBand(int band);

    /**

     * Remove any band that does not belong to itself.

     */

    public void clearAdditionalBands();

    /**

     * Return true if the band is own. If the band is from additional store, return false.

     *

     * @param band

     * @return

     */

    public boolean isOwnBand(int band);

    /**

     * Return the buffer dimensions of the complete store.

     * @return

     * @throws InitializeException

     */

    public BufferDimensions getDimensions() throws InitializeException;

    public boolean isTiled();

}