Package org.openstreetmap.josm.gui.layer

Class WMSLayer

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<AbstractWMSTileSource>

org.openstreetmap.josm.gui.layer.WMSLayer

All Implemented Interfaces:

java.awt.image.ImageObserver, org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener, ProjectionChangeListener, ImageryFilterSettings.FilterChangeListener, TileSourceDisplaySettings.DisplaySettingsChangeListener, MapViewPaintable, NavigatableComponent.ZoomChangeListener, Destroyable

public class WMSLayer
extends AbstractCachedTileSourceLayer<AbstractWMSTileSource>

This is a layer that grabs the current screen from an WMS server. The data fetched this way is tiled and managed to the disc to reduce server load.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WMSLayer.BookmarkWmsAction	This action will add a WMS layer menu entry with the current WMS layer URL and name extended by the current resolution.

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

AbstractTileSourceLayer.PrecacheTask, AbstractTileSourceLayer.TileSet, AbstractTileSourceLayer.TileSourceLayerPopup

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

ImageryLayer.OffsetAction, ImageryLayer.OffsetMenuEntry

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	Description
private static java.lang.String	CACHE_REGION_NAME
private static java.lang.String	PREFERENCE_PREFIX
static BooleanProperty	PROP_DEFAULT_AUTOZOOM	should WMS layer autozoom in default mode
static IntegerProperty	PROP_IMAGE_SIZE	default tile size for WMS Layer
private java.util.List<java.lang.String>	serverProjections

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

MAX_DISK_CACHE_SIZE

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

coordinateConverter, MAX_ZOOM, MIN_ZOOM, PROP_MAX_ZOOM_LVL, PROP_MIN_ZOOM_LVL, tileCache, tileLoader, tileSource, ZOOM_OFFSET

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

icon, info, PROP_SHARPEN_LEVEL

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	Description
WMSLayer(ImageryInfo info)	Constructs a new WMSLayer.

Method Summary

Modifier and Type	Method	Description
private Projection	chooseProjection(Projection requested)
protected TileSourceDisplaySettings	createDisplaySettings()	This method creates the TileSourceDisplaySettings object.
static org.apache.commons.jcs3.access.CacheAccess<java.lang.String,BufferedImageCacheEntry>	getCache()	Returns cache region for WMS layer.
protected java.lang.String	getCacheName()
javax.swing.Action[]	getMenuEntries()	Returns list of actions.
java.util.Collection<java.lang.String>	getNativeProjections()	Get projections this imagery layer supports natively.
protected java.lang.Class<? extends org.openstreetmap.gui.jmapviewer.interfaces.TileLoader>	getTileLoaderClass()
protected AbstractWMSTileSource	getTileSource()	Creates and returns a new TileSource instance depending on ImageryLayer.info specified in the constructor.
void	projectionChanged(Projection oldValue, Projection newValue)
private Projection	selectProjection(Projection proj)

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

getCache, getDiskCacheSize, getTileLoaderFactory, getTileLoaderFactory, setTileLoaderFactory

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

actionSupportLayers, attachToMapView, checkMaxZoomLvl, checkMinZoomLvl, clearTileCache, createAndOpenSaveFileChooser, createMapViewPainter, createTile, decreaseZoomLevel, destroy, displaySettingsChanged, estimateTileCacheSize, filterChanged, getAdjustAction, getBestZoom, getCommonEntries, getDisplaySettings, getDownloadAreaToCacheTask, getHeaders, getInfoComponent, getLayerListEntries, getMaxZoomLvl, getMaxZoomLvl, getMinZoomLvl, getMinZoomLvl, getOffsetMenuEntries, getScaleFactor, getTileSet, getToolTipText, getZoomLevel, hookUpMapView, imageUpdate, increaseZoomLevel, initTileSource, isSavable, loadAllErrorTiles, loadAllTiles, paint, registerMenuAddition, registerMenuAddition, setMaxZoomLvl, setMinZoomLvl, setZoomLevel, tileLoadingFinished, visitBoundingBox, zoomChanged, zoomDecreaseAllowed, zoomIncreaseAllowed

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

addImageProcessor, applyImageProcessors, create, createImageProcessor, createTextField, getChangesetSourceTag, getFilterSettings, getIcon, getImageProcessors, getInfo, getOffsetMenuItem, getOffsetMenuItem, getPPD, isMergable, mergeFrom, removeImageProcessor, toString

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

addPropertyChangeListener, checkSaveConditions, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getColor, getDefaultLayerPosition, getLabel, getName, getOpacity, getViewProjectionBounds, hasColor, isBackgroundLayer, isInfoResizable, isProjectionSupported, isRenamed, isVisible, nameSupportedProjections, onPostLoadFromFile, removePropertyChangeListener, rename, setAssociatedFile, setBackgroundLayer, setColor, 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, wait, wait, wait

Field Detail

PREFERENCE_PREFIX

private static final java.lang.String PREFERENCE_PREFIX

See Also:

Constant Field Values

PROP_IMAGE_SIZE

public static final IntegerProperty PROP_IMAGE_SIZE

default tile size for WMS Layer

PROP_DEFAULT_AUTOZOOM

public static final BooleanProperty PROP_DEFAULT_AUTOZOOM

should WMS layer autozoom in default mode

CACHE_REGION_NAME

private static final java.lang.String CACHE_REGION_NAME

See Also:

Constant Field Values

serverProjections

private java.util.List<java.lang.String> serverProjections

Constructor Detail

WMSLayer

public WMSLayer(ImageryInfo info)

Constructs a new WMSLayer.

Parameters:

info - ImageryInfo description of the layer

Method Detail

createDisplaySettings

protected TileSourceDisplaySettings createDisplaySettings()

Description copied from class: AbstractTileSourceLayer

This method creates the TileSourceDisplaySettings object. Subclasses may implement it to e.g. change the prefix.

Overrides:

createDisplaySettings in class AbstractTileSourceLayer<AbstractWMSTileSource>

Returns:

The object.

getMenuEntries

public javax.swing.Action[] getMenuEntries()

Description copied from class: Layer

Returns list of actions. Action can implement LayerAction interface when it needs to be represented by other menu component than JMenuItem or when it supports multiple layers. Actions that support multiple layers should also have correct equals implementation.

Use Layer.SeparatorLayerAction.INSTANCE instead of new JSeparator

Overrides:

getMenuEntries in class AbstractTileSourceLayer<AbstractWMSTileSource>

Returns:

menu actions for this layer

getTileSource

protected AbstractWMSTileSource getTileSource()

Description copied from class: AbstractTileSourceLayer

Creates and returns a new TileSource instance depending on ImageryLayer.info specified in the constructor.

Specified by:

getTileSource in class AbstractTileSourceLayer<AbstractWMSTileSource>

Returns:

TileSource for specified ImageryInfo

getNativeProjections

public java.util.Collection<java.lang.String> getNativeProjections()

Description copied from class: AbstractTileSourceLayer

Get projections this imagery layer supports natively.

For example projection of tiles that are downloaded from a server. Layer may support even more projections (by reprojecting the tiles), but with a certain loss in image quality and performance.

Specified by:

getNativeProjections in class AbstractTileSourceLayer<AbstractWMSTileSource>

Returns:

projections this imagery layer supports natively; null if layer is projection agnostic.

projectionChanged

public void projectionChanged(Projection oldValue,
                              Projection newValue)

Specified by:

projectionChanged in interface ProjectionChangeListener

Overrides:

projectionChanged in class AbstractTileSourceLayer<AbstractWMSTileSource>

chooseProjection

private Projection chooseProjection(Projection requested)

selectProjection

private Projection selectProjection(Projection proj)

getTileLoaderClass

protected java.lang.Class<? extends org.openstreetmap.gui.jmapviewer.interfaces.TileLoader> getTileLoaderClass()

Specified by:

getTileLoaderClass in class AbstractCachedTileSourceLayer<AbstractWMSTileSource>

getCacheName

protected java.lang.String getCacheName()

Specified by:

getCacheName in class AbstractCachedTileSourceLayer<AbstractWMSTileSource>

getCache

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

Returns cache region for WMS layer.

Returns:

cache region for WMS layer