org.openstreetmap.josm.data.imagery

Class TMSCachedTileLoader

java.lang.Object

org.openstreetmap.josm.data.imagery.TMSCachedTileLoader

All Implemented Interfaces:

CachedTileLoader, TileLoader

Direct Known Subclasses:

WMSCachedTileLoader

public class TMSCachedTileLoader
extends java.lang.Object
implements TileLoader, CachedTileLoader

Wrapper class that bridges between JCS cache and Tile Loaders

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.jcs.access.behavior.ICacheAccess<java.lang.String,BufferedImageCacheEntry>	cache
protected int	connectTimeout
private static java.util.concurrent.ThreadPoolExecutor	DEFAULT_DOWNLOAD_JOB_DISPATCHER separate from JCS thread pool for TMS loader, so we can have different thread pools for default JCS and for TMS imagery
private java.util.concurrent.ThreadPoolExecutor	downloadExecutor
protected java.util.Map<java.lang.String,java.lang.String>	headers
static IntegerProperty	HOST_LIMIT Limit definition for per host concurrent connections
protected TileLoaderListener	listener
protected int	readTimeout
static IntegerProperty	THREAD_LIMIT overrides the THREAD_LIMIT in superclass, as we want to have separate limit and pool for TMS

Constructor Summary

Constructors

Constructor and Description
TMSCachedTileLoader(TileLoaderListener listener, org.apache.commons.jcs.access.behavior.ICacheAccess<java.lang.String,BufferedImageCacheEntry> cache, int connectTimeout, int readTimeout, java.util.Map<java.lang.String,java.lang.String> headers) Constructor

Method Summary

Modifier and Type	Method and Description
void	cancelOutstandingTasks() cancels all outstanding tasks in the queue.
void	clearCache(TileSource source)
TileJob	createTileLoaderJob(Tile tile) A typical implementation of this function should create and return a new TileJob instance that performs the load action.
java.util.concurrent.ThreadPoolExecutor	getDownloadExecutor()
static java.util.concurrent.ThreadPoolExecutor	getNewThreadPoolExecutor(java.lang.String name)
static java.util.concurrent.ThreadPoolExecutor	getNewThreadPoolExecutor(java.lang.String nameFormat, int workers)
java.lang.String	getStats()
void	setDownloadExecutor(java.util.concurrent.ThreadPoolExecutor downloadExecutor) Sets the download executor that will be used to download tiles instead of default one.

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected final org.apache.commons.jcs.access.behavior.ICacheAccess<java.lang.String,BufferedImageCacheEntry> cache

connectTimeout

protected final int connectTimeout

readTimeout

protected final int readTimeout

headers

protected final java.util.Map<java.lang.String,java.lang.String> headers

listener

protected final TileLoaderListener listener

THREAD_LIMIT

public static final IntegerProperty THREAD_LIMIT

overrides the THREAD_LIMIT in superclass, as we want to have separate limit and pool for TMS

HOST_LIMIT

public static final IntegerProperty HOST_LIMIT

Limit definition for per host concurrent connections

DEFAULT_DOWNLOAD_JOB_DISPATCHER

private static java.util.concurrent.ThreadPoolExecutor DEFAULT_DOWNLOAD_JOB_DISPATCHER

separate from JCS thread pool for TMS loader, so we can have different thread pools for default JCS and for TMS imagery

downloadExecutor

private java.util.concurrent.ThreadPoolExecutor downloadExecutor

Constructor Detail

TMSCachedTileLoader

public TMSCachedTileLoader(TileLoaderListener listener,
                           org.apache.commons.jcs.access.behavior.ICacheAccess<java.lang.String,BufferedImageCacheEntry> cache,
                           int connectTimeout,
                           int readTimeout,
                           java.util.Map<java.lang.String,java.lang.String> headers)
                    throws java.io.IOException

Constructor

Parameters:

listener - called when tile loading has finished

cache - of the cache

connectTimeout - to remote resource

readTimeout - to remote resource

headers - HTTP headers to be sent along with request

Throws:

java.io.IOException - when cache initialization fails

Method Detail

getNewThreadPoolExecutor

public static java.util.concurrent.ThreadPoolExecutor getNewThreadPoolExecutor(java.lang.String nameFormat,
                                                                               int workers)

Parameters:

nameFormat - see Utils.newThreadFactory(String, int)

workers - number of worker thread to keep

Returns:

new ThreadPoolExecutor that will use a @see HostLimitQueue based queue

getNewThreadPoolExecutor

public static java.util.concurrent.ThreadPoolExecutor getNewThreadPoolExecutor(java.lang.String name)

Parameters:

name - name of threads

Returns:

new ThreadPoolExecutor that will use a @see HostLimitQueue based queue, with default number of threads

createTileLoaderJob

public TileJob createTileLoaderJob(Tile tile)

Description copied from interface: TileLoader

A typical implementation of this function should create and return a new TileJob instance that performs the load action.

Specified by:

createTileLoaderJob in interface TileLoader

Parameters:

tile - the tile to be loaded

Returns:

TileJob implementation that performs the desired load action.

clearCache

public void clearCache(TileSource source)

Specified by:

clearCache in interface CachedTileLoader

getStats

public java.lang.String getStats()

Returns:

cache statistics as string

cancelOutstandingTasks

public void cancelOutstandingTasks()

cancels all outstanding tasks in the queue. This rollbacks the state of the tiles in the queue to loading = false / loaded = false

Specified by:

cancelOutstandingTasks in interface TileLoader

setDownloadExecutor

public void setDownloadExecutor(java.util.concurrent.ThreadPoolExecutor downloadExecutor)

Sets the download executor that will be used to download tiles instead of default one. You can use getNewThreadPoolExecutor(java.lang.String, int) to create a new download executor with separate queue from default.

Parameters:

downloadExecutor - download executor that will be used to download tiles

getDownloadExecutor

public java.util.concurrent.ThreadPoolExecutor getDownloadExecutor()

Returns:

download executor that is used by this factory