Application: gvSIG desktop » gvSIG raster

org.gvsig.raster.cache.tile.TileCacheLibrary

org.gvsig.raster.cache.buffer.BufferCacheLibrary

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

import org.gvsig.tools.locator.BaseLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

/**

 * This locator is the entry point for the Raster library, providing

 * access to all Raster services through the {@link TileCacheManager}

 * .

 * 

 * @author gvSIG team

 * @version $Id$

 */

public class TileCacheLocator extends BaseLocator {

    public static final String             MANAGER_NAME            = "TileCache.manager";

    public static final String             MANAGER_DESCRIPTION     = "TileCache Manager";

    private static final String            LOCATOR_NAME            = "TileCache.locator";

    private static final TileCacheLocator  INSTANCE                = new TileCacheLocator();

    /**

     * Return the singleton instance.

     * 

     * @return the singleton instance

     */

    public static TileCacheLocator getInstance() {

        return INSTANCE;

    }

    /**

     * Return the Locator's name.

     * 

     * @return a String with the Locator's name

     */

    public final String getLocatorName() {

        return LOCATOR_NAME;

    }

    /**

     * Return a reference to the RasterManager.

     * 

     * @return a reference to the RasterManager

     * @throws LocatorException

     *             if there is no access to the class or the class cannot be

     *             instantiated

     * @see Locator#get(String)

     */

    public static TileCacheManager getManager() throws LocatorException {

        return (TileCacheManager) getInstance().get(MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the RasterManager interface.

     * 

     * @param clazz

     *            implementing the RasterManager interface

     */

    public static void registerManager(

        Class<? extends TileCacheManager> clazz) {

        getInstance().register(MANAGER_NAME, MANAGER_DESCRIPTION, clazz);

    }

}

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

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.locator.ReferenceNotRegisteredException;

/**

 * 

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

 */

public class TileCacheLibrary extends AbstractLibrary {

	public static int                 DEFAULT_LEVELS       = 25; 

	public static int                 DEFAULT_TILEWIDTH    = 256;

	public static int                 DEFAULT_TILEHEIGHT   = 256;

	public static int                 ALTERNATIVE_TILESIZE = 1024;

	public static String              DEFAULT_STRUCTURE    = "FLATX";

	//One directory X dimension. The name of each tile is the Y coordinate. 

	public static String              FLATX_STRUCT         = "FLATX";

	public static String              QUADKEY_STRUCT       = "QUADKEY";

	public static int                 MAX_CACHE_SIZE       = 5000;

	public TileCacheLibrary() {

        registerAsAPI(TileCacheLibrary.class);

	}

	@Override

    protected void doInitialize() throws LibraryException {

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

        TileCacheManager manager = TileCacheLocator.getManager();

        if (manager == null) {

            throw new ReferenceNotRegisteredException(

                TileCacheLocator.MANAGER_NAME, TileCacheLocator

                    .getInstance());

        }

    }

}

/* 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.pool;

/**

 * This class manages transactions between the producer and the consumer. The

 * producer download tiles from a server and the consumer is a tile provider

 * which will return downloaded tiles.

 *

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

 */

public interface TilePipe {

	/**

	 * Sets a tile in the pipe

	 * @param tile

	 */

	public void setAtomicTask(AtomicTask tile);

	/**

	 * Gets a tile from the pipe

	 * @return

	 */

	public AtomicTask getAtomicTask();

	/**

	 * Returns the number of elements in the queue

	 * @return

	 */

	public int getSize();

	/**

	 * Cleans the queue

	 */

	public void clear();

}

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.raster.cache.tile.pool package documentation</title>

</head>

<body>

	<p>API to build a pool of threads of tasks</p>

	<p>

	</p>

</body>

</html>

/* 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.pool;

/**

 * Task with priorities

 *

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

 */

public interface AtomicTask extends Runnable, Comparable<AtomicTask> {

	/**

	 * Gets the priority of this task

	 * @return

	 */

	public int getPriority();

	/**

	 * Sets the priority of this task

	 * @param priority

	 */

	public void setPriority(int priority);

	/**

	 * Cancels this current task

	 */

	public void cancelTask();

}

/* 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.pool;

import java.util.LinkedList;

/**

 * Pool of threads. This class contains a list of tasks and a limited number

 * of threads to execute them. When a thread is free will execute the next task 

 * in the list. 

 *

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

 */

public interface ThreadPool {

	/**

	 * Stops all threads in the list and sets the list to null

	 */

	public void destroyPool();

	/**

	 * Adds a new task to the list

	 * @param task

	 */

	public void addTask(AtomicTask task);

	/**

	 * Gets the list of input tasks

	 * @return

	 */

	public LinkedList<AtomicTask> getInputTaskList();

	/**

	 * Gets the list of output tiles

	 * @return

	 */

	public TilePipe getTilePipe();

}

/* TileRasterCache, a library to download tiles from several sources.

 *

 * Copyright (C) 2010 Prodevelop SL.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *  

 *   Prodevelop Integraci�n de Tecnolog�as SL

 *   Plaza don Juan de Vilarrasa , 14-5

 *   46000 Valencia

 *   Spain

 *

 *   +34 963 510 612

 *   +34 963 510 968

 *   gis@prodevelop.es

 *   http://www.prodevelop.es

 *   

 *   author: Alberto Romeu Carrasco (aromeu@prodevelop.es)

 */

package org.gvsig.raster.cache.tile.disk;

/**

 * This interface allows to save/load tiles attending to different strategies, this means

 * the way the tiles are stored on disk, using a quadkey, flat zoom level, etc.

 *  

 * @author aromeu

 *

 */

public interface ITileFileSystemStrategy {

	public static final String FLATX = "flatx";

	public static final String QUADKEY = "quadkey";

	/**

	 * The relative path of the tile on disk

	 * @param row 

	 *        Row of the tile

	 * @param col

	 *        Column of the tile

	 * @param zoomLevel 

	 *        The zoom level

	 * @param var

	 *        Variable which is represented in this cache structure. This is useful for netcdf and other

	 *        multidimensional formats

	 * @param z

	 *        Level of deep in the raster layer. This is useful for multidimensional formats

	 * @param time

	 *        A format which supports 4D needs to store different time moments y different directories

	 * @return The path to append to the absolute path of the layer on disk

	 */

	public String getRelativeToLayerDirTilePath(int row, int col, int zoomLevel,

			String var, String z, String time);

}

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.raster.cache.tile.disk package documentation</title>

</head>

<body>

	<p>Strategies to store tiles in disk</p>

	<p>

	</p>

</body>

</html>

/* 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.provider;

import java.awt.geom.Point2D;

import java.awt.geom.Rectangle2D;

import java.util.ArrayList;

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

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

/**

 * Structure of a cache service

 *

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

 */

public interface CacheStruct {

	public static int    GEOGRAFIC   = 0;

	public static int    FLAT        = 1;

	/**

	 * Gets the number of resolution levels

	 * @return

	 */

	public int getNumberOfLevels();

	/**

	 * Gets the number of columns in a specific level

	 * @param level

	 * @return

	 */

	public long getWorldWidthOfTileMatrixByLevel(int level);

	/**

	 * Gets the number of rows in a specific level

	 * @param level

	 * @return

	 */

	public long getWorldHeightOfTileMatrixByLevel(int level);

	/**

	 * Gets the number of columns in a specific level

	 * @param level

	 * @return

	 */

	public int getLayerWidthOfTileMatrixByLevel(int level);

	/**

	 * Gets the number of rows in a specific level

	 * @param level

	 * @return

	 */

	public int getLayerHeightOfTileMatrixByLevel(int level);

	/**

	 * Gets the starting X position of the layer

	 * @param level

	 * @return

	 */

	public int getLayerInitXTilePositionByLevel(int level);

	/**

	 * Gets the starting Y position of the layer

	 * @param level

	 * @return

	 */

	public int getLayerInitYTilePositionByLevel(int level);

	/**

	 * Gets the tile size 

	 * @param level

	 * @return an array of two elements. The first element is the width in pixels and

	 * the second the height.

	 */

	public int[] getTileSizeByLevel(int level);

	/**

	 * Gets the tile size by level in world coordinates

	 * @param level

	 * @return width x height 

	 */

	public double[] getTileSizeInRealCoordsByLevel(int level);

	/**

	 * Gets the pixel size of a level

	 * @param level

	 * @return

	 */

	public double getPixelSizeByLevel(int level);

	/**

	 * Gets the extent of a tile

	 * @param level

	 * @param x

	 * @param y

	 * @return

	 */

	public Point2D[] getTileExtent(Tile tile);

	/**

	 * Get the extent of an matrix element in a specific level

	 * @param level

	 * @param col

	 * @param row

	 * @return

	 */

	public Point2D[] getTileExtent(int level, int col, int row);

	/**

	 * Builds a tile structure with all parameters that this kind of service needs. 

	 * @param level

	 * @param tileCol

	 * @param tileRow

	 * @return

	 */

	public Tile getTileStructure(int level, int tileCol, int tileRow, Point2D ul, Point2D lr) throws TileBuildException ;

	/**

	 * Gets the list of tiles inside of selected area in pixels. This method is only valid

	 * for the real level. Don't use with levels of resolution.

	 * @param r

	 * @return

	 */

	public ArrayList<Tile> getTileList(Rectangle2D r);

	/**

	 * Gets the list of tiles inside of selected area

	 * @param ul

	 * @param lr

	 * @param mtsPixelRequest

	 * @return

	 * @throws TileBuildException 

	 */

	public ArrayList<Tile> getTileList(Point2D ul, Point2D lr, double mtsPixelRequest) throws TileBuildException;

	/**

	 * Gets the layer name

	 * @return

	 */

	public String getLayerName();

	/**

	 * Gets the server URL

	 * @return

	 */

	public String getServerURL();

	/**

	 * Gets the suffix which represents the image format

	 * @return

	 */

	public String getFileSuffix();

	/**

	 * Gets the EPSG code

	 * @return

	 */

	public String getEPSG();

	/**

	 * If the source is a file gets the size or 0 if is not a file

	 * @return

	 */

	public String getFileSize();

	/**

	 * Compares two structures and returns true if they are equals

	 * @param struct

	 * @return

	 */

	public boolean compare(CacheStruct struct);

}

/* 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.provider;

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

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

/**

 * Tile cache uses this interface to get a tile and the data provider have to implement

 * it to serve tiles.

 *

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

 */

public interface Downloader {

	/**

	 * Gets a tile from the data source. The parameter tile contains 

	 * the information of the tile to download. If the provider is a remote

	 * service this will have to download the tile from the server and if it 

	 * is a file provider the source will be a file.

	 * @param tile Tile information

	 * @param param Additional parameter

	 * @return Tile loaded

	 */

	public Tile downloadTile(Tile tile) throws TileGettingException;

	/**

	 * Reads a tile from the tile cache. The path to the tile is in the Tile

	 * object

	 * @param tile

	 * @return

	 * @throws TileGettingException

	 */

	public Tile readTileFromDisk(Tile tile) throws TileGettingException;

	/**

	 * Gets the image that represent a tile while is downloading

	 * @return

	 */

	public Object[] getDownloadingImage(int w, int h);

	/**

	 * Gets the image that represent a crash tile

	 * @return

	 */

	public Object[] getCrashImage(int w, int h);

}

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.raster.cache.tile.provider package documentation</title>

</head>

<body>

	<p>Cache structures</p>

	<p>

	</p>

</body>

</html>

/* 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.provider;

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

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

/**

 * This interface will receive events when a new tile arrives. When the last tile is

 * received then endReading will be called.

 * 

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

 */

public interface TileListener {

	/**

	 * A new tile is received

	 * @param loadedTile 

	 */

	public void tileReady(Tile loadedTile) throws TileGettingException ;

	/**

	 * The last tile is received

	 */

	public void endReading();

	/**

	 * Returns true if the endReading wasn't be called yet

	 */

	public boolean isReading();

}

/* 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.provider;

/**

 * This interface have to be implemented by a data provider. This will report

 * the structure of its layers 

 *

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

 */

public interface TileServer {

	/**

	 * Gets the cache structure

	 * @return

	 */

	public CacheStruct getStruct();

	/**

	 * Sets the cache structure. It builds the Downloader with the 

	 * new structure.

	 * @param struct

	 */

	public void setStruct(CacheStruct struct);

	/**

	 * Gets the tile server

	 * @return

	 */

	public Downloader getDownloader();

	/**

	 * Gets the file extension to save tiles

	 * @return

	 */

	public String getFileSuffix();

	/**

	 * Assigns the extension of the output file

	 * @param extension

	 */

	public void setFileSuffix(String extension);

}

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

import java.awt.geom.Point2D;

import java.awt.geom.Rectangle2D;

import org.gvsig.raster.cache.tile.pool.ThreadPool;

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

/**

 * This class is responsible of the management of the library's business logic.

 * It is the library's main entry point, and provides all the services to manage

 * {@link TileCacheService}s.

 * 

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

 * @version $Id$

 */

public interface TileCacheManager {

	/**

	 * Builds a new entry point for a tile cache. The parameter is an identifier for a 

	 * tile cache structured implemented inside of this library

	 * @param baseDir

	 * @return

	 */

	public TileCache getTileCache(String baseDir);

	/**

	 * Creates a new tile structure

	 * @param level

	 * @param col

	 *        Tile column

	 * @param row

	 *        Tile row

	 * @return

	 */

	public Tile createTile(int level, int col, int row);

	/**

	 * Creates a new tile structure

	 * @param wPx

	 *        Width in pixels

	 * @param hPx

	 *        Height in pixels

	 * @param row

	 *        Tile row

	 * @param col

	 *        Tile column

	 * @param ul

	 *        Upper left coordinate

	 * @param lr

	 *        Lower roght coordinate 

	 * @return

	 */

	public Tile createTile(int wPx, int hPx, int row, int col, Point2D ul, Point2D lr);

	/**

	 * Builds a standard cache structure 

	 * @param typeOfCoords Constant defined in CacheStruct interface

	 * @param levels Number of levels

	 * @param layerExtent Bounding box of the layer

	 * @param pixelSize Pixel size of the layer

	 * @param tilePxWidth Width in pixels of a tile

	 * @param tilePxHeight Height in pixels of a tile

	 * @param uri server URL

	 * @param layerName Layer name or identifier

	 * @param strategy Strategy to store tiles in disk

	 * @param baseDir path to this layer

	 * @param fileSuffix File suffix

	 * @param epsg 

	 * @return

	 */

	public CacheStruct createCacheStructure(int typeOfCoords, 

    		int levels, 

    		Rectangle2D layerExtent, 

    		double pixelSize,

    		int tilePxWidth,

    		int tilePxHeight,

    		String uri,

    		String layerName,

    		String strategy,

    		String baseDir,

    		String fileSuffix,

    		String epsg,

    		long fileSize);

	/**

	 * Builds a standard cache structure for local files

	 * @param typeOfCoords Constant defined in CacheStruct interface

	 * @param levels Number of levels

	 * @param layerExtent Bounding box of the layer

	 * @param pixelSize Pixel size of the layer

	 * @param tilePxWidth Width in pixels of a tile

	 * @param tilePxHeight Height in pixels of a tile

	 * @param layerName Layer name or identifier

	 * @param strategy Strategy to store tiles in disk

	 * @param baseDir path to this layer

	 * @param fileSuffix File suffix

	 * @param epsg 

	 * @return

	 */

	public CacheStruct createCacheStructure(int typeOfCoords, 

    		int levels, 

    		Rectangle2D layerExtent, 

    		double pixelSize,

    		int tilePxWidth,

    		int tilePxHeight,

    		String layerName,

    		String strategy,

    		String baseDir,

    		String fileSuffix,

    		String epsg,

    		long fileSize);

	/**

	 * Builds a new thread pool. This pool will use five threads by default

	 * @return

	 */

	public ThreadPool createThreadPool(boolean priorityActive);

	/**

	 * Builds a new thread pool selecting the number of threads

	 * @return

	 */

	public ThreadPool createThreadPool(boolean priorityActive, int nThreads);

	/**

	 * Sets the time out in milliseconds

	 * @param ms

	 */

	public void setTileTimeOut(int ms);

	/**

	 * Gets the time out in milliseconds

	 * @return

	 */

	public int getTileTimeOut();

}

/* 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.TaskStatus;

/**

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

}

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.raster.cache.tile.layer package documentation</title>

</head>

<body>

	<p>Tile layer</p>

	<p>

	</p>

</body>

</html>

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

import java.awt.geom.Point2D;

import java.awt.geom.Rectangle2D;

import java.io.File;

import org.gvsig.raster.cache.tile.pool.AtomicTask;

import org.gvsig.raster.cache.tile.pool.TilePipe;

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

import org.gvsig.compat.net.ICancellable;

/**

 * Tile structure for requests

 *

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

 */

public interface Tile extends AtomicTask {

	/**

	 * Gets the Variable that this tile belong to.This is useful when the source 

	 * is a multidimensional container. If it is not then this variable will have

	 * a default value. 

	 * @return

	 */

	public String getVariable();

	/**

	 * Gets the Z that this tile belong to. This is useful when the source 

	 * is a multidimensional container. If it is not then this variable will have

	 * a 0 value. 

	 * @return

	 */

	public String getZ();

	/**

	 * Gets the time instant that this tile belong to.This is useful when the source 

	 * is a multidimensional container. If it is not then this variable will have

	 * a 0 value. 

	 * @return

	 */

	public String getTimeInstant();

	/**

	 * Sets the Variable that this tile belong to.This is useful when the source 

	 * is a multidimensional container. If it is not then this variable will have

	 * a default value. 

	 * @return

	 */

	public void setVariable(String var);

	/**

	 * Sets the Z that this tile belong to. This is useful when the source 

	 * is a multidimensional container. If it is not then this variable will have

	 * a 0 value. 

	 * @return

	 */

	public void setZ(String z);

	/**

	 * Sets the time instant that this tile belong to.This is useful when the source 

	 * is a multidimensional container. If it is not then this variable will have

	 * a 0 value. 

	 * @return

	 */

	public void setTimeInstant(String t);

	/**

	 * Gets the column of this tile

	 * @return

	 */

	public int getCol();

	/**

	 * Gets the row of this tile

	 * @return

	 */

	public int getRow();

	/**

	 * Gets the resolution level of this tile

	 * @return

	 */

	public int getLevel();

	/**

	 * Sets the column of this tile in its level

	 * @param col

	 */

	public void setCol(int col);

	/**

	 * Sets the row of this tile in its level

	 * @param col

	 */

	public void setRow(int row);

	/**

	 * Sets the level of resolution of this tile

	 * @param col

	 */

	public void setLevel(int level);

	/**

	 * Gets the coordinates in pixels of this tile inside the layer.

	 * This function is only for the real level. 

	 * @return

	 */

	public Rectangle2D getCoordsPx();

	/**

	 * Sets the coordinates ins pixels of this tile inside the layer.

	 * This function is only for the real level.

	 * @param r

	 */

	public void setCoordsPx(Rectangle2D r);

	/**

	 * Gets the width in pixels of this tile

	 * @return

	 */

	public int getWidthPx();

	/**

	 * Sets the width in pixels of this tile

	 * @param widthPx

	 */

	public void setWidthPx(int widthPx);

	/**

	 * Gets the height in pixels of this tile

	 * @return

	 */

	public int getHeightPx();

	/**

	 * Sets the height in pixels of this tile

	 * @param heightPx

	 */

	public void setHeightPx(int heightPx);

	/**

	 * Gets the bounding box

	 * @return

	 */

	public Rectangle2D getExtent();

	/**

	 * Gets the upper left coordinate of this tile

	 * @return

	 */

	public Point2D getUl();

	/**

	 * Sets the upper left coordinate of this tile

	 * @return

	 */

	public void setUl(Point2D ul);

	/**

	 * Gets the lower right coordinate of this tile

	 * @return

	 */

	public Point2D getLr();

	/**

	 * Sets the lower right coordinate of this tile

	 * @return

	 */

	public void setLr(Point2D lr);

	/**

	 * Gets the file associated to this tile

	 * @return

	 */

	public File getFile();

	/**

	 * Sets the file associated to this tile

	 * @param file

	 */

	public void setFile(File file);

	/**

	 * Gets an unique identifier to this tile

	 * @return

	 */

	public String getId();

	/**

	 * Gets the Downloader parameters

	 * @return

	 */

	public Object getDownloaderParams(String key);

	/**

	 * Sets the Downloader parameters

	 * @param downloaderParams

	 */

	public void setDownloaderParams(String key, Object downloaderParams);

	/**

	 * Sets the data associated to this tile. In the most cases

	 * will be only one element in the array of objects

	 * @param data

	 */

	public void setData(Object[] data);

	/**

	 * Gets the data associated to this tile. In the most cases

	 * will be only one element in the array of objects

	 * @return

	 */

	public Object[] getData();

	/**

	 * Returns true if the buffer data is loaded

	 * @return

	 */

	public boolean dataIsLoaded();	

	/**

	 * Sets this flag to true if the data is corrupt

	 * @param corrupt

	 */

	public void setCorrupt(boolean corrupt);

	/**

	 * Returns true if the downloaded tile is corrupt, so this can't be sent to the client 

	 * @return

	 */

	public boolean isCorrupt();

	/**

	 * Sets the pipe of tiles

	 * @param sharedPipe

	 */

	public void setSharedPipe(TilePipe sharedPipe);

	/**

	 * Sets the downloader for this tile

	 * @param downloader

	 */

	public void setDownloader(Downloader downloader);

	/**

	 * Gets the image that represent a tile while is downloading