public class

ArcGISTiledMapServiceLayer

extends TiledServiceLayer

java.lang.Object
↳	com.esri.android.map.Layer
	↳	com.esri.android.map.TiledLayer
		↳	com.esri.android.map.TiledServiceLayer
			↳	com.esri.android.map.ags.ArcGISTiledMapServiceLayer

Class Overview

The ArcGISTiledMapServiceLayer class allows you to work with a cached map service resource exposed by the ArcGIS Server REST API. A cached service accesses tiles from a cache instead of dynamically rendering images. Java usage:

 
 MapView mv = new MapView(this);
 mv.addLayer(new ArcGISTiledMapServiceLayer(
 "http://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer"));
 setContentView(mv);

Summary

[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
	ArcGISTiledMapServiceLayer(String url) This constructor is used if you're instantiating the ArcGISTiledMapServiceLayer using Java code (see the class description for an example of this usage).
	ArcGISTiledMapServiceLayer(String url, UserCredentials credentials) This constructor is used if you're instantiating the ArcGISTiledMapServiceLayer using Java code.
	ArcGISTiledMapServiceLayer(String url, UserCredentials credentials, boolean initLayer) Instantiates an object of ArcGISTiledMapServiceLayer.

Public Methods
ArcGISPopupInfo	createPopupInfo(int sublayerId) Creates the popup info.
ArcGISLayerInfo[]	getAllLayers() Returns the all of sub-layers of the tiled map service.
String	getCapabilities() Gets the capabilities of the map service.
ArcGISLayerInfo[]	getLayers() Returns the immediate sub-layers of the tiled map service.
ArcGISPopupInfo	getPopupInfo(int sublayerId) Gets the `PopupInfo` associated with the sub-layer id.
boolean	retrieveLegendInfo() Supported on ArcGIS Server 10.01 and above.

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

[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

Public Constructors

public ArcGISTiledMapServiceLayer (String url)

This constructor is used if you're instantiating the ArcGISTiledMapServiceLayer using Java code (see the class description for an example of this usage).

Parameters

url	the URL of the dynamic map service.

public ArcGISTiledMapServiceLayer (String url, UserCredentials credentials)

This constructor is used if you're instantiating the ArcGISTiledMapServiceLayer using Java code.

Parameters

url	the URL of the tiled map service.
credentials	the credentials used for accessing a secure tiled map service

public ArcGISTiledMapServiceLayer (String url, UserCredentials credentials, boolean initLayer)

Instantiates an object of ArcGISTiledMapServiceLayer.

Parameters

url	the URL of the tiled map service.
credentials	the credentials used for accessing a secure tiled map service
initLayer	set to true to initialize layer.

Public Methods

public ArcGISPopupInfo createPopupInfo (int sublayerId)

Creates the popup info.

Parameters

sublayerId	the sublayer id

Returns

the arc gis popup info

public ArcGISLayerInfo[] getAllLayers ()

Returns the all of sub-layers of the tiled map service. See getLayers() if you need the layers returned in hierarchy.

Returns

an array of type ArcGISLayerInfo.

public String getCapabilities ()

Gets the capabilities of the map service. It is a comma separated list of supported capabilities - e.g. "Map, Query, Data". Only available if the map service is published using ArcGIS Server version 10 or above. You can not call this method until the layer is loaded.

Returns

the comma separated capabilities or null if the associated server doesn't support it.

public ArcGISLayerInfo[] getLayers ()

Returns the immediate sub-layers of the tiled map service. If a layer is a group layer, you can call the

Returns

an array of type ArcGISLayerInfo. getLayers() to get the sub-layers of the group layer.

public ArcGISPopupInfo getPopupInfo (int sublayerId)

Gets the PopupInfo associated with the sub-layer id.

Parameters

sublayerId	the sublayer id

Returns

PopupInfo

public boolean retrieveLegendInfo ()

Supported on ArcGIS Server 10.01 and above.
Synchronously retrieves the legend information for all the layer infos. Once finished,

Returns

true, if retrieve legend info getLegend() may be called on the individual ArcGISLayerInfos that make up this ArcGISTiledMapServiceLayer.

Note: The developer is responsible for calling this method in a non-UI thread.

Protected Methods

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

Throws

Exception

protected void initLayer ()

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

Classes

Enums

ArcGISTiledMapServiceLayer

Class Overview

Summary

Public Constructors

public ArcGISTiledMapServiceLayer (String url)

Parameters

public ArcGISTiledMapServiceLayer (String url, UserCredentials credentials)

Parameters

public ArcGISTiledMapServiceLayer (String url, UserCredentials credentials, boolean initLayer)

Parameters

Public Methods

public ArcGISPopupInfo createPopupInfo (int sublayerId)

Parameters

Returns

public ArcGISLayerInfo[] getAllLayers ()

Returns

public String getCapabilities ()

Returns

public ArcGISLayerInfo[] getLayers ()

Returns

public ArcGISPopupInfo getPopupInfo (int sublayerId)

Parameters

Returns

public boolean retrieveLegendInfo ()

Returns

Protected Methods

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

Throws

protected void initLayer ()

protected void retrieveNoDataTileETag ()