org.openstreetmap.josm.gui.layer

Class AbstractCachedTileSourceLayer<T extends AbstractTMSTileSource>

java.lang.Object

org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable

org.openstreetmap.josm.gui.layer.Layer

org.openstreetmap.josm.gui.layer.ImageryLayer

org.openstreetmap.josm.gui.layer.AbstractTileSourceLayer<T>

org.openstreetmap.josm.gui.layer.AbstractCachedTileSourceLayer<T>

Type Parameters:

T - Tile Source class used by this Imagery Layer

All Implemented Interfaces:

java.awt.image.ImageObserver, TileLoaderListener, ProjectionChangeListener, MapViewPaintable, NavigatableComponent.ZoomChangeListener, Destroyable

Direct Known Subclasses:

TMSLayer, WMSLayer, WMTSLayer

public abstract class AbstractCachedTileSourceLayer<T extends AbstractTMSTileSource>
extends AbstractTileSourceLayer<T>

Class providing cache to other layers

Nested Class Summary

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.AbstractTileSourceLayer

AbstractTileSourceLayer.PrecacheTask, AbstractTileSourceLayer.TileSourceLayerPopup

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.ImageryLayer

ImageryLayer.ApplyOffsetAction, ImageryLayer.ColorfulImageProcessor, ImageryLayer.GammaImageProcessor, ImageryLayer.OffsetAction, ImageryLayer.SharpenImageProcessor

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.Layer

Layer.LayerAction, Layer.LayerGpxExportAction, Layer.LayerSaveAction, Layer.LayerSaveAsAction, Layer.MultiLayerAction, Layer.SeparatorLayerAction

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable

AbstractMapViewPaintable.CompatibilityModeLayerPainter

Nested classes/interfaces inherited from interface org.openstreetmap.josm.gui.layer.MapViewPaintable

MapViewPaintable.LayerPainter, MapViewPaintable.MapViewEvent, MapViewPaintable.PaintableInvalidationEvent, MapViewPaintable.PaintableInvalidationListener

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.commons.jcs.access.behavior.ICacheAccess<java.lang.String,BufferedImageCacheEntry>	cache
private static java.util.Map<java.lang.String,TileLoaderFactory>	loaderFactories loader factory responsible for loading tiles for all layers
private TileLoaderFactory	loaderFactory
private static TileLoaderFactory	loaderFactoryOverride
static IntegerProperty	MAX_DISK_CACHE_SIZE how many object on disk should be stored for TMS region in MB.
private static java.lang.String	PREFERENCE_PREFIX

Fields inherited from class org.openstreetmap.josm.gui.layer.AbstractTileSourceLayer

autoLoad, autoZoom, currentZoomLevel, MAX_ZOOM, MIN_ZOOM, PROP_DEFAULT_AUTOLOAD, PROP_DEFAULT_AUTOZOOM, PROP_DEFAULT_SHOWERRORS, PROP_MAX_ZOOM_LVL, PROP_MIN_ZOOM_LVL, showErrors, tileCache, tileLoader, tileSource, ZOOM_OFFSET

Fields inherited from class org.openstreetmap.josm.gui.layer.ImageryLayer

collorfulnessImageProcessor, dx, dy, gammaImageProcessor, icon, info, PROP_FADE_AMOUNT, PROP_FADE_COLOR, PROP_SHARPEN_LEVEL, sharpenImageProcessor

Fields inherited from class org.openstreetmap.josm.gui.layer.Layer

FILTER_STATE_PROP, NAME_PROP, OPACITY_PROP, propertyChangeSupport, VISIBLE_PROP

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
AbstractCachedTileSourceLayer(ImageryInfo info) Creates an instance of class based on InageryInfo

Method Summary

Modifier and Type	Method and Description
private org.apache.commons.jcs.access.behavior.ICacheAccess<java.lang.String,BufferedImageCacheEntry>	getCache()
static org.apache.commons.jcs.access.CacheAccess<java.lang.String,BufferedImageCacheEntry>	getCache(java.lang.String name)
protected abstract java.lang.String	getCacheName()
protected int	getDiskCacheSize()
protected abstract java.lang.Class<? extends TileLoader>	getTileLoaderClass()
protected TileLoaderFactory	getTileLoaderFactory()
static TileLoaderFactory	getTileLoaderFactory(java.lang.String name, java.lang.Class<? extends TileLoader> klazz) Returns tile loader factory for cache region and specified TileLoader class
static void	setTileLoaderFactory(TileLoaderFactory newLoaderFactory) Plugins that wish to set custom tile loader should call this method

Methods inherited from class org.openstreetmap.josm.gui.layer.AbstractTileSourceLayer

attachToMapView, checkMaxZoomLvl, checkMinZoomLvl, clearTileCache, createAndOpenSaveFileChooser, createMapViewPainter, decreaseZoomLevel, downloadAreaToCache, estimateMemoryUsage, estimateTileCacheSize, getBestZoom, getCommonEntries, getHeaders, getLayerListEntries, getMaxZoomLvl, getMaxZoomLvl, getMenuEntries, getMinZoomLvl, getMinZoomLvl, getTileSource, getToolTipText, hookUpMapView, imageUpdate, increaseZoomLevel, initTileSource, isChanged, isSavable, loadAllErrorTiles, loadAllTiles, paint, redraw, setColorfulness, setGamma, setMaxZoomLvl, setMinZoomLvl, setOffset, setSharpenLevel, setZoomLevel, tileLoadingFinished, visitBoundingBox, zoomChanged, zoomDecreaseAllowed, zoomIncreaseAllowed

Methods inherited from class org.openstreetmap.josm.gui.layer.ImageryLayer

addImageProcessor, applyImageProcessors, create, createImageProcessor, destroy, displace, getColorfulness, getDx, getDy, getFadeColor, getFadeColorWithAlpha, getGamma, getIcon, getImageProcessors, getInfo, getInfoComponent, getOffsetMenuItem, getOffsetMenuItem, getPPD, getSharpenLevel, isMergable, mergeFrom, removeImageProcessor

Methods inherited from class org.openstreetmap.josm.gui.layer.Layer

addPropertyChangeListener, checkLayerMemoryDoesNotExceedMaximum, checkSaveConditions, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getColor, getDefaultLayerPosition, getName, getOpacity, getViewProjectionBounds, isBackgroundLayer, isInfoResizable, isProjectionSupported, isRenamed, isVisible, nameSupportedProjections, onPostLoadFromFile, projectionChanged, removePropertyChangeListener, rename, setAssociatedFile, setBackgroundLayer, setFilterStateChanged, setName, setOpacity, setVisible, toggleVisible

Methods inherited from class org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable

addInvalidationListener, invalidate, removeInvalidationListener

Methods inherited from class java.lang.Object

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

Field Detail

loaderFactories

private static java.util.Map<java.lang.String,TileLoaderFactory> loaderFactories

loader factory responsible for loading tiles for all layers

PREFERENCE_PREFIX

private static final java.lang.String PREFERENCE_PREFIX

See Also:

Constant Field Values

loaderFactoryOverride

private static volatile TileLoaderFactory loaderFactoryOverride

MAX_DISK_CACHE_SIZE

public static final IntegerProperty MAX_DISK_CACHE_SIZE

how many object on disk should be stored for TMS region in MB. 500 MB is default value

cache

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

loaderFactory

private volatile TileLoaderFactory loaderFactory

Constructor Detail

AbstractCachedTileSourceLayer

public AbstractCachedTileSourceLayer(ImageryInfo info)

Creates an instance of class based on InageryInfo

Parameters:

info - ImageryInfo describing the layer

Method Detail

getTileLoaderFactory

protected TileLoaderFactory getTileLoaderFactory()

Specified by:

getTileLoaderFactory in class AbstractTileSourceLayer<T extends AbstractTMSTileSource>

getCache

private org.apache.commons.jcs.access.behavior.ICacheAccess<java.lang.String,BufferedImageCacheEntry> getCache()

Returns:

cache used by this layer

setTileLoaderFactory

public static void setTileLoaderFactory(TileLoaderFactory newLoaderFactory)

Plugins that wish to set custom tile loader should call this method

Parameters:

newLoaderFactory - that will be used to load tiles

getTileLoaderFactory

public static TileLoaderFactory getTileLoaderFactory(java.lang.String name,
                                                     java.lang.Class<? extends TileLoader> klazz)

Returns tile loader factory for cache region and specified TileLoader class

Parameters:

name - of the cache region

klazz - type of the TileLoader

Returns:

factory returning cached tile loaders using specified cache and TileLoaders

getCache

public static org.apache.commons.jcs.access.CacheAccess<java.lang.String,BufferedImageCacheEntry> getCache(java.lang.String name)

Parameters:

name - of cache region

Returns:

cache configured object for specified cache region

getTileLoaderClass

protected abstract java.lang.Class<? extends TileLoader> getTileLoaderClass()

getDiskCacheSize

protected int getDiskCacheSize()

getCacheName

protected abstract java.lang.String getCacheName()