org.openstreetmap.gui.jmapviewer.tilesources

Class AbstractOsmTileSource

java.lang.Object

org.openstreetmap.gui.jmapviewer.tilesources.AbstractTileSource

org.openstreetmap.gui.jmapviewer.tilesources.AbstractTMSTileSource

org.openstreetmap.gui.jmapviewer.tilesources.AbstractOsmTileSource

All Implemented Interfaces:

Attributed, TileSource

Direct Known Subclasses:

AbstractMapQuestTileSource, OsmTileSource.CycleMap, OsmTileSource.Mapnik

public abstract class AbstractOsmTileSource
extends AbstractTMSTileSource

Abstract class for OSM Tile sources

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_OSM_ATTRIBUTION The OSM attribution.

Fields inherited from class org.openstreetmap.gui.jmapviewer.tilesources.AbstractTMSTileSource

baseUrl, id, name, osmMercator, tileSize

Fields inherited from class org.openstreetmap.gui.jmapviewer.tilesources.AbstractTileSource

attributionImage, attributionImageURL, attributionLinkURL, attributionText, termsOfUseText, termsOfUseURL

Constructor Summary

Constructors

Constructor and Description
AbstractOsmTileSource(String name, String baseUrl, String id) Constructs a new OSM tile source

Method Summary

Modifier and Type	Method and Description
Image	getAttributionImage()
String	getAttributionImageURL()
String	getAttributionLinkURL()
String	getAttributionText(int zoom, ICoordinate topLeft, ICoordinate botRight)
int	getMaxZoom() Specifies the maximum zoom value.
String	getTermsOfUseText()
String	getTermsOfUseURL()
boolean	requiresAttribution()

Methods inherited from class org.openstreetmap.gui.jmapviewer.tilesources.AbstractTMSTileSource

getBaseUrl, getDefaultTileSize, getDistance, getExtension, getId, getMetadata, getMinZoom, getName, getTileId, getTilePath, getTileSize, getTileUrl, getTileXMax, getTileXMin, getTileYMax, getTileYMin, isNoTileAtZoom, latLonToTileXY, latLonToTileXY, latLonToXY, latLonToXY, tileXYToLatLon, tileXYToLatLon, tileXYToLatLon, toString, xyToLatLon, xyToLatLon

Methods inherited from class org.openstreetmap.gui.jmapviewer.tilesources.AbstractTileSource

setAttributionImage, setAttributionImageURL, setAttributionLinkURL, setAttributionText, setTermsOfUseText, setTermsOfUseURL

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OSM_ATTRIBUTION

public static final String DEFAULT_OSM_ATTRIBUTION

The OSM attribution. Must be always in line with https://www.openstreetmap.org/copyright/en

See Also:

Constant Field Values

Constructor Detail

AbstractOsmTileSource

public AbstractOsmTileSource(String name,
                             String baseUrl,
                             String id)

Constructs a new OSM tile source

Parameters:

name - Source name as displayed in GUI

baseUrl - Source URL

id - unique id for the tile source; contains only characters that are safe for file names; can be null

Method Detail

getMaxZoom

public int getMaxZoom()

Description copied from interface: TileSource

Specifies the maximum zoom value. The number of zoom levels is [0.. TileSource.getMaxZoom()].

Specified by:

getMaxZoom in interface TileSource

Overrides:

getMaxZoom in class AbstractTMSTileSource

Returns:

maximum zoom value that has to be smaller or equal to JMapViewer.MAX_ZOOM

requiresAttribution

public boolean requiresAttribution()

Specified by:

requiresAttribution in interface Attributed

Overrides:

requiresAttribution in class AbstractTileSource

Returns:

True if the tile source requires attribution in text or image form.

getAttributionText

public String getAttributionText(int zoom,
                                 ICoordinate topLeft,
                                 ICoordinate botRight)

Specified by:

getAttributionText in interface Attributed

Overrides:

getAttributionText in class AbstractTileSource

Parameters:

zoom - The optional zoom level for the view.

topLeft - The top left of the bounding box for attribution.

botRight - The bottom right of the bounding box for attribution.

Returns:

Attribution text for the image source.

getAttributionLinkURL

public String getAttributionLinkURL()

Specified by:

getAttributionLinkURL in interface Attributed

Overrides:

getAttributionLinkURL in class AbstractTileSource

Returns:

The URL to open when the user clicks the attribution text.

getAttributionImage

public Image getAttributionImage()

Specified by:

getAttributionImage in interface Attributed

Overrides:

getAttributionImage in class AbstractTileSource

Returns:

The URL for the attribution image. Null if no image should be displayed.

getAttributionImageURL

public String getAttributionImageURL()

Specified by:

getAttributionImageURL in interface Attributed

Overrides:

getAttributionImageURL in class AbstractTileSource

Returns:

The URL to open when the user clicks the attribution image. When return value is null, the image is still displayed (provided getAttributionImage() returns a value other than null), but the image does not link to a website.

getTermsOfUseText

public String getTermsOfUseText()

Specified by:

getTermsOfUseText in interface Attributed

Overrides:

getTermsOfUseText in class AbstractTileSource

Returns:

The attribution "Terms of Use" text. In case it returns null, but getTermsOfUseURL() is not null, a default terms of use text is used.

getTermsOfUseURL

public String getTermsOfUseURL()

Specified by:

getTermsOfUseURL in interface Attributed

Overrides:

getTermsOfUseURL in class AbstractTileSource

Returns:

The URL to open when the user clicks the attribution "Terms of Use" text.