public class

OpenStreetMapLayer

extends TiledServiceLayer

java.lang.Object
↳	com.esri.android.map.Layer
	↳	com.esri.android.map.TiledLayer
		↳	com.esri.android.map.TiledServiceLayer
			↳	com.esri.android.map.osm.OpenStreetMapLayer

Class Overview

A tile service layer that supports OpenStreetMap (OSM) tile servers.

Default tile servers used are:

http://[a,b,c].tile.openstreetmap.org

The additional tile servers can be found on the OpenStreetMap web site.

If access to the tile servers require a key that should not be hard-coded into the URL string, then the URLs can have a placeholder for key identified by "{KEY}". setKey(String) can be used replace the placeholder with actual key at runtime.

NOTE: Attribution is provided for the default tile servers. Please check whether it is appropriate at the time of usage. Refer to Tile usage policy to provide attribution appropriate to the tile servers used.

Summary

Constants
double	XMAX	Maximum X coordinate in meters for the full extent.
double	XMIN	Minimum X coordinate in meters for the full extent.
double	YMAX	Maximum Y coordinate in meters for the full extent.
double	YMIN	Minimum Y coordinate in meters for the full extent.

[Expand]

Inherited Constants

From class com.esri.android.map.TiledServiceLayer

[Expand]

Inherited Fields

From class com.esri.android.map.TiledServiceLayer

From class com.esri.android.map.Layer

Public Constructors
	OpenStreetMapLayer() Default constructor for OpenStreetMapLayer.
	OpenStreetMapLayer(boolean initLayer) The constructor for OpenStreetMapLayer.
	OpenStreetMapLayer(String[] tileServerURLs, int minZoomLevel, int maxZoomLevel, String attributionText, boolean initLayer) Constructs an instance of `OpenStreetMapLayer` with specified tile servers.

Public Methods
String	getAttributionText() Returns the attribution text.
int	getMaxZoomLevel() Returns the maximum zoom level.
int	getMinZoomLevel() Returns the minimum zoom level.
String[]	getTileServerURLs() The URLs used to fetch tiles from.
void	setKey(String key) Replaces the placeholder "{KEY}" in the tile server URLs.

Protected Methods
byte[]	getTile(int lev, int col, int row)
void	initLayer() Initializes the layer.

[Expand]

Inherited Methods

From class com.esri.android.map.TiledServiceLayer

From class com.esri.android.map.TiledLayer

void	clearTiles() Cancels all current tile request.
float	getBrightness() Gets the brightness of the ArcGISTiledMapCacheLayer.
float	getContrast() Gets the contrast of the ArcGISTiledMapCacheLayer.
int	getCurrentLevel() Returns the current the level of detail(LOD).
float	getGamma() Gets the gamma of the ArcGISTiledMapCacheLayer.
boolean	isPopupAllowGeometryUpdate(Graphic graphic) Returns true if the popup allow the geometry to be updated, potentially based on some information carried by the `Graphic` provided.
boolean	isPopupDeletable(Graphic graphic) Returns true if the popup created is deletable, potentially based on some information carried by the `Graphic` provided.
boolean	isPopupEditable(Graphic graphic) Returns true if the popup created is editable, potentially based on some information carried by the `Graphic` provided.
boolean	isRenderNativeResolution() Returns true if rendering at native resolution is enabled.
void	setBrightness(float brightness) Sets the brightness of the ArcGISTiledMapCacheLayer.
void	setContrast(float contrast) Sets the contrast of the ArcGISTiledMapCacheLayer.
void	setGamma(float gamma) Sets the gamma of the ArcGISTiledMapCacheLayer.
void	setRenderNativeResolution(boolean renderNativeResolution) Sets to true to render the tiled layer in native resolution.

From class com.esri.android.map.Layer

void	changeStatus(OnStatusChangedListener.STATUS status) Changes the STATUS of the layer and notifies the listener.
abstract long	create()
Popup	createPopup(MapView mapView, int sublayerId, Graphic graphic) Creates the popup.
void	finalize()
UserCredentials	getCredentials() Gets a copy of the credentials attached to the Layer.
SpatialReference	getDefaultSpatialReference() Gets the defaultSpatialReference of the Layer.
float	getDpi()
Polygon	getExtent() Gets the current extent.
Envelope	getFullExtent() Returns the full extent of the layer.
int	getHeight() Gets the height of the Layer in screen units.
long	getID() Return the Layer runtime ID which is a long integer.
Envelope	getInitialExtent() Returns the initial extent of the layer.
double	getMaxScale() Gets max scale.
double	getMinScale() Gets min scale.
String	getName() Gets the name of the layer.
float	getOpacity() Gets the opacity of the Layer.
Layer	getParent() Returns parent layer if the layer is in a group layer otherwise returning null.
ExecutorService	getPoolExecutor() Returns the ThreadPoolExecutor based on the context.
ArcGISPopupInfo	getPopupInfo(int sublayerId) Gets the `PopupInfo` associated with the sub-layer id.
Map<Integer, ArcGISPopupInfo>	getPopupInfos() Gets the popup infos.
String	getQueryUrl(int subLayerId) Gets the query url.
double	getResolution() Gets the resolution of the Layer.
ExecutorService	getServiceExecutor() Returns the ThreadPoolExecutor based on the context.
SpatialReference	getSpatialReference() Gets the current spatial reference of the Layer.
String	getTitle() Gets the title of the Layer.
String	getUrl() Gets the URL of the map service associated with the layer.
int	getUrlHashCode() A convenience method that returns the hash code of the map service URL.
String	getWebMapLayerID() Gets the web map layer id.
int	getWidth() Gets the width of the Layer in screen units.
abstract void	initLayer() Initializes the layer.
void	initializeMinMaxScale(double initalMinScale, double initalMaxScale) honor the webmaplayer min/max scale first, if it is not override, then using service min/max if they are set.
boolean	isInitialized() Gets the initialized of the Layer.
boolean	isRecycled() Returns true or false if the Layer object has been recycled.
boolean	isShowLegend() Returns true if legend of the layer will be shown up; by default it is true; The property is usually defined in the web map, a operation layer legend could be on or off.
boolean	isVisible() Gets the visibility of the Layer.
boolean	isWebMapBaselayer() Returns true if the layer is used as base layer in a web map.
<T> T	loadServiceInfo(Callable<T> task) If the Layer is loaded as a WebMapLayer and the OnWebMapLoadListener is specified, the service information will be loaded interactively.
synchronized long	lock()
void	recycle() Releases resources referenced by the Layer so that they can be recycled.
void	reinitializeLayer(UserCredentials usercredentials) Re-initializes the layer with the given credentials.
void	setCredentials(UserCredentials credentials) Sets the credentials of the Layer.
void	setDefaultSpatialReference(SpatialReference defaultSpatialReference) Sets the defaultSpatialReference of the Layer.
void	setFullExtent(Envelope extent)
void	setInitialExtent(Envelope e) Sets the initial extent of layer.
void	setMaxScale(double maxScale) Sets max scale.
void	setMinScale(double minScale) Sets min scale.
void	setName(String name) Sets the layer name.
void	setOnStatusChangedListener(OnStatusChangedListener onStatusChangedListener) Sets the onStatusChangedListener.
void	setOpacity(float opacity) Sets the opacity of the Layer.
void	setPopupInfos(Map<Integer, ArcGISPopupInfo> popUpInfos) Sets the popup infos.
void	setQueryUrls(Map<Integer, String> queryUrls) Sets the query urls.
void	setUrl(String url) Sets the URL of the map service associated with the layer.
void	setVisible(boolean visible) Sets the visibility of the Layer.
void	unlock(long handle)
void	updateSpatialReferenceStatus(int SRStatus) The callback method is invoked when the layer is added to map.
boolean	verifyCredentials() Returns true if the credentials is valid.

From class java.lang.Object

From interface com.esri.android.map.popup.PopupLayer

Constants

public static final double XMAX

Maximum X coordinate in meters for the full extent.

Constant Value: 2.003750834278E7

public static final double XMIN

Minimum X coordinate in meters for the full extent.

Constant Value: -2.003750834278E7

public static final double YMAX

Maximum Y coordinate in meters for the full extent.

Constant Value: 2.003750834278E7

public static final double YMIN

Minimum Y coordinate in meters for the full extent.

Constant Value: -2.003750834278E7

Public Constructors

public OpenStreetMapLayer ()

Default constructor for OpenStreetMapLayer.

public OpenStreetMapLayer (boolean initLayer)

The constructor for OpenStreetMapLayer.

Parameters

initLayer	true or false. The layer will be initialized if it is true.

public OpenStreetMapLayer (String[] tileServerURLs, int minZoomLevel, int maxZoomLevel, String attributionText, boolean initLayer)

Constructs an instance of OpenStreetMapLayer with specified tile servers.

Parameters

tileServerURLs	tile servers that follow OSM specification to fetch tiles from.
minZoomLevel	minimum zoom level
maxZoomLevel	maximum zoom level
attributionText	attribution to be used.
initLayer	boolean, true to initialize the layer otherwise not.

Public Methods

public String getAttributionText ()

Returns the attribution text.

Returns

the attribution text.

public int getMaxZoomLevel ()

Returns the maximum zoom level.

Returns

the maximum zoom level.

public int getMinZoomLevel ()

Returns the minimum zoom level.

Returns

the minimum zoom level.

public String[] getTileServerURLs ()

The URLs used to fetch tiles from.

Returns

set of URLs.

public void setKey (String key)

Replaces the placeholder "{KEY}" in the tile server URLs.

Example:
String tileServerURL = "http://a.tile.cloudmade.com/{KEY}/3/256/";
After setKey("081abc");
tileServerURL = "http://a.tile.cloudmade.com/081abc/3/256/";

Parameters

key	key to be used.

Protected Methods

protected byte[] getTile (int lev, int col, int row)

Throws

Exception

protected void initLayer ()

Initializes the layer. The implementation should submit the OnStatusChangedListener.STATUS event accordingly.

Classes

OpenStreetMapLayer

Class Overview

Summary

Constants

public static final double XMAX

public static final double XMIN

public static final double YMAX

public static final double YMIN

Public Constructors

public OpenStreetMapLayer ()

public OpenStreetMapLayer (boolean initLayer)

Parameters

public OpenStreetMapLayer (String[] tileServerURLs, int minZoomLevel, int maxZoomLevel, String attributionText, boolean initLayer)

Parameters

Public Methods

public String getAttributionText ()

Returns

public int getMaxZoomLevel ()

Returns

public int getMinZoomLevel ()

Returns

public String[] getTileServerURLs ()

Returns

public void setKey (String key)

Parameters

Protected Methods

protected byte[] getTile (int lev, int col, int row)

Throws

protected void initLayer ()