org.jdesktop.swingx.mapviewer

Class AbstractTileFactory

java.lang.Object

org.jdesktop.swingx.mapviewer.TileFactory

org.jdesktop.swingx.mapviewer.AbstractTileFactory

Direct Known Subclasses:

DefaultTileFactory

public abstract class AbstractTileFactory
extends TileFactory

The AbstractTileFactory provides a basic implementation for the TileFactory.

Constructor Summary

Constructors

Constructor and Description
AbstractTileFactory(TileFactoryInfo info) Creates a new instance of DefaultTileFactory using the spcified TileFactoryInfo

Method Summary

Methods

Modifier and Type	Method and Description
protected Runnable	createTileRunner(Tile tile) Subclasses can override this if they need custom TileRunners for some reason
void	dispose() Disposes this TileFactory
protected ExecutorService	getService() Subclasses may override this method to provide their own executor services.
Tile	getTile(int x, int y, int zoom) Returns the tile that is located at the given tilePoint for this zoom.
TileCache	getTileCache()
void	promote(Tile tile) Increase the priority of this tile so it will be loaded sooner.
void	setThreadPoolSize(int size) Set the number of threads to use for loading the tiles.
void	setTileCache(TileCache cache)
protected void	startLoading(Tile tile) Override this method to load the tile using, for example, an ExecutorService.

Methods inherited from class org.jdesktop.swingx.mapviewer.TileFactory

addTileListener, fireTileLoadedEvent, geoToPixel, getInfo, getMapSize, getTileSize, pixelToGeo, removeTileListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractTileFactory

public AbstractTileFactory(TileFactoryInfo info)

Creates a new instance of DefaultTileFactory using the spcified TileFactoryInfo

Parameters:

info - a TileFactoryInfo to configure this TileFactory

Method Detail

getTile

public Tile getTile(int x,
           int y,
           int zoom)

Returns the tile that is located at the given tilePoint for this zoom. For example, if getMapSize() returns 10x20 for this zoom, and the tilePoint is (3,5), then the appropriate tile will be located and returned.

Specified by:

getTile in class TileFactory

Parameters:

x - the x value

y - the y value

zoom - the current zoom level

Returns:

the tile that is located at the given tilePoint for this zoom level. For example, if getMapSize() returns 10x20 for this zoom, and the tilePoint is (3,5), then the appropriate tile will be located and returned. This method must not return null. However, it can return dummy tiles that contain no data if it wants. This is appropriate, for example, for tiles which are outside of the bounds of the map and if the factory doesn't implement wrapping.

getTileCache

public TileCache getTileCache()

Returns:

the tile cache

setTileCache

public void setTileCache(TileCache cache)

Parameters:

cache - the tile cache

getService

protected ExecutorService getService()

Subclasses may override this method to provide their own executor services. This method will be called each time a tile needs to be loaded. Implementations should cache the ExecutorService when possible.

Returns:

ExecutorService to load tiles with

dispose

public void dispose()

Description copied from class: TileFactory

Disposes this TileFactory

Specified by:

dispose in class TileFactory

setThreadPoolSize

public void setThreadPoolSize(int size)

Set the number of threads to use for loading the tiles. This controls the number of threads used by the ExecutorService returned from getService(). Note, this method should be called before loading the first tile. Calls after the first tile are loaded will have no effect by default.

Parameters:

size - the thread pool size

startLoading

protected void startLoading(Tile tile)

Description copied from class: TileFactory

Override this method to load the tile using, for example, an ExecutorService.

Specified by:

startLoading in class TileFactory

Parameters:

tile - The tile to load.

createTileRunner

protected Runnable createTileRunner(Tile tile)

Subclasses can override this if they need custom TileRunners for some reason

Parameters:

tile - the tile (unused!)

Returns:

the tile runner

promote

public void promote(Tile tile)

Increase the priority of this tile so it will be loaded sooner.

Parameters:

tile - the tile