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.raster.cache.tile.layer;

import java.util.ArrayList;

import org.gvsig.raster.cache.tile.Tile;

import org.gvsig.raster.cache.tile.exception.TileGettingException;

import org.gvsig.raster.cache.tile.provider.TileListener;

import org.gvsig.tools.task.Cancellable;

/**

 * API interface for a cached layer

 *

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

 */

public interface TiledLayer {

        /**

         * Gets a tile

         * @param tile

         * @return

         * @throws TileGettingException 

         */

        public Tile getTile(Tile tile) throws TileGettingException;

        /**

         * Gets a list of tiles

         * @param tiles

         * @param listener

         * @throws TileGettingException 

         */

        public void getTiles(ArrayList<Tile> tiles, TileListener listener, Cancellable status) throws TileGettingException;

        /**

         * Gets the base directory for this layer. This function builds an unique identifier

         * for a layer with a limited length.

         * @return

         */

        public String getBaseLayerDirectory();

        /**

         * Returns the ID of this layer. 

         * The ID is the name of the directory where the tiles are stored.

         * @return

         */

        public String getID();

        /**

         * Deletes the files of this layer 

         * @return Size of information that was deleted

         */

        public long delete();

}