public class

ArcGISDynamicMapServiceLayer

extends DynamicLayer
implements TimeAwareLayer

java.lang.Object
↳	com.esri.android.map.Layer
	↳	com.esri.android.map.DynamicLayer
		↳	com.esri.android.map.ags.ArcGISDynamicMapServiceLayer

Class Overview

The ArcGISDynamicMapServiceLayer class allows you to work with a dynamic map service resource that is exposed by the ArcGIS Server REST API (see the system requirements document for supported versions of ArcGIS Server). A dynamic map service generates map images on the server each time a request comes in.

The following are examples of how you might work with the ArcGISDynamicMapServiceLayer class. The code will add a map service from ArcGIS Online using map services that are dynamically retrieved. When working with dynamic services the ArcGISDynamicMapServiceLayer class must be used. This example code shows you how to connect to ArcGIS Online, but you can easily update the code to point to your own ArcGIS Server REST end points. Java usage:

 //ArcGISDynamicMapServiceLayer class is used to define the Layer that is added to the
 //MapView object.
 MapView mv = new MapView(this);
 mv.addLayer(new ArcGISDynamicMapServiceLayer(
 "http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Demographics/ESRI_Population_World/MapServer"));
 setContentView(mv);

Summary

[Expand]

Inherited Fields

From class com.esri.android.map.DynamicLayer

From class com.esri.android.map.Layer

Public Constructors
	ArcGISDynamicMapServiceLayer(String url, int[] visiblelayers) This constructor is used if you're instantiating the ArcGISDynamicMapServiceLayer.
	ArcGISDynamicMapServiceLayer(String url, int[] visiblelayers, UserCredentials credentials, boolean initLayer) This constructor is used if you're instantiating the ArcGISDynamicMapServiceLayer.
	ArcGISDynamicMapServiceLayer(String url, int[] visiblelayers, int[] invisibleLegendLayers, UserCredentials credentials, boolean initLayer) This constructor is used if you're instantiating the ArcGISDynamicMapServiceLayer.
	ArcGISDynamicMapServiceLayer(String url) This constructor is used if you're instantiating the ArcGISDynamicMapServiceLayer (see the class description for an example of this usage).
	ArcGISDynamicMapServiceLayer(String url, int[] visiblelayers, UserCredentials credentials) This constructor is used if you're instantiating the ArcGISDynamicMapServiceLayer.

Public Methods
ArcGISPopupInfo	createPopupInfo(int sublayerId) Creates the popup info.
ArcGISLayerInfo[]	getAllLayers() Returns the all of sub-layers of the dynamic map service.
String	getCapabilities() Gets the capabilities of the map service.
Map<Integer, String>	getLayerDefinitions() Gets the layer definitions of the ArcGISDynamicMapServiceLayer.
ArcGISLayerInfo[]	getLayers() Returns the immediate sub-layers of the dynamic map service.
ArcGISPopupInfo	getPopupInfo(int sublayerId) Gets the `PopupInfo` associated with the sub-layer id.
TimeExtent	getTimeExtent() Gets the valid TimeExtent object for the Layer or null if this service does not support time based queries.
TimeInfo	getTimeInfo() Get all the time awareness information for this layer.@return
TimeExtent	getTimeInterval() Get the current date/time range that this layer is filtered by.
Map<Integer, TimeOptions>	getTimeOptions() This method will return a list of.
boolean	isTimeAware() Indicates whether or not this particular layer instance is time aware.
boolean	retrieveLegendInfo() Supported on ArcGIS Server 10.01 and above.
void	setLayerDefinitions(Map<Integer, String> layerDefs) Sets the layer definitions used to filter the features of individual layers in the map service.
void	setTimeInterval(TimeExtent timeInterval) Set the current date/time range that this layer will be filtered by.
void	setTimeOptions(Map<Integer, TimeOptions> timeOptions) Set a list of LayerTimeOptions.

Protected Methods
byte[]	getImage(int width, int height, Envelope extent)
void	initLayer() Initializes the layer.

[Expand]

Inherited Methods

From class com.esri.android.map.DynamicLayer

void	cancelPendingTasks() Cancel pending tasks.
long	create()
float	getBrightness() Gets the brightness of the DynamicLayer.
double	getCenterMeridan() return central meridan value
float	getContrast() Gets the contrast of the DynamicLayer.
float	getGamma() Gets the gamma of the DynamicLayer.
abstract byte[]	getImage(int width, int height, Envelope extent)
void	getImageAsych(int w, int h, Envelope extent, CallbackListener<byte[]> imagecallback)
void	initLayer() Initializes the layer.
boolean	isCrossDateline() is cross date line.
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	isWrapAroundEnabled() is wrap around enabled.
void	recycle() Releases resources referenced by the Layer so that they can be recycled.
void	refresh() Invoke this method to fetch the map image from the associated map service and update the MapView.
void	requestImage(int width, int height, double minx, double miny, double maxx, double maxy)
void	setBrightness(float brightness) Sets the brightness of the DynamicLayer.
void	setContrast(float contrast) Sets the contrast of the DynamicLayer.
void	setGamma(float gamma) Sets the gamma of the DynamicLayer.

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

From interface com.esri.core.map.TimeAwareLayer

Public Constructors

public ArcGISDynamicMapServiceLayer (String url, int[] visiblelayers)

This constructor is used if you're instantiating the ArcGISDynamicMapServiceLayer.

Parameters

url	the URL of the dynamic map service.
visiblelayers	the IDs of the layers are visible. Set to null if all layers are visible.

public ArcGISDynamicMapServiceLayer (String url, int[] visiblelayers, UserCredentials credentials, boolean initLayer)

This constructor is used if you're instantiating the ArcGISDynamicMapServiceLayer.

Parameters

url	the URL of the dynamic map service.
visiblelayers	the IDs of the layers are visible. Set to null if all layers are visible.
credentials	the credentials used for accessing a secure dynamic map service
initLayer	set to true to initialize the layer.

public ArcGISDynamicMapServiceLayer (String url, int[] visiblelayers, int[] invisibleLegendLayers, UserCredentials credentials, boolean initLayer)

This constructor is used if you're instantiating the ArcGISDynamicMapServiceLayer.

Parameters

url	the URL of the dynamic map service.
visiblelayers	the IDs of the layers are visible. Set to null if all layers are visible.
invisibleLegendLayers	the IDs of the layers which legends are invisible. Set to null if all layers legend are visible.
credentials	the credentials used for accessing a secure dynamic map service
initLayer	set to true to initialize the layer.

public ArcGISDynamicMapServiceLayer (String url)

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

Parameters

url	the URL of the dynamic map service.

public ArcGISDynamicMapServiceLayer (String url, int[] visiblelayers, UserCredentials credentials)

This constructor is used if you're instantiating the ArcGISDynamicMapServiceLayer.

Parameters

url	the URL of the dynamic map service.
visiblelayers	the IDs of the layers are visible. Set to null if all layers are visible.
credentials	the credentials used for accessing a secure dynamic map service

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 dynamic map service. See getLayers() if you need the layer 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 greater. 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 Map<Integer, String> getLayerDefinitions ()

Gets the layer definitions of the ArcGISDynamicMapServiceLayer.

Returns

Returns the layerDefs.

public ArcGISLayerInfo[] getLayers ()

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

Returns

an array of type ArcGISLayerInfo. getLayers() method to get the sub-layer 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 TimeExtent getTimeExtent ()

Gets the valid TimeExtent object for the Layer or null if this service does not support time based queries.

Returns

the valid range of dates for this layer.

public TimeInfo getTimeInfo ()

Get all the time awareness information for this layer.@return

public TimeExtent getTimeInterval ()

Get the current date/time range that this layer is filtered by.

Returns

the current date/time range

public Map<Integer, TimeOptions> getTimeOptions ()

This method will return a list of.

Returns

list of LayerTimeOptions instances com.esri.core.internal.value.LayerTimeOptions LayerTimeOptions that can be used to indicate whether or not each layer should use the time extent specified by the TimeInterval property or not, whether to draw the layer features cumulatively or not and the time offsets for the layer. If this property has not been previously set by the user, the returned Map will be empty.

public boolean isTimeAware ()

Indicates whether or not this particular layer instance is time aware.

Returns

True if this is a time aware layer, false otherwise.

public boolean retrieveLegendInfo ()

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

Returns

boolean getLegend() may be called on the individual ArcGISLayerInfos that make up this ArcGISDynamicMapServiceLayer.

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

public void setLayerDefinitions (Map<Integer, String> layerDefs)

Sets the layer definitions used to filter the features of individual layers in the map service.

Java sample:

 layer = new ArcGISDynamicMapServiceLayer("http://yourhost/MapServer");
 HashMap<Integer, String> layerDefs = new HashMap<Integer, String>();
 layerDefs.put(Integer.valueOf(1), "pop1990 > 5000000");
 layer.setLayerDefinitions(layerDefs);
 
 map.addLayer(layer);

Parameters

layerDefs	The layerDefs to set. The key is the index of the sublayer, the value is the where clause.

public void setTimeInterval (TimeExtent timeInterval)

Set the current date/time range that this layer will be filtered by.

Parameters

timeInterval	the new date/time range

public void setTimeOptions (Map<Integer, TimeOptions> timeOptions)

Set a list of LayerTimeOptions.

Parameters

timeOptions	list of LayerTimeOptions to apply to this layer

Protected Methods

protected byte[] getImage (int width, int height, Envelope extent)

Throws

Exception

protected void initLayer ()

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

Classes

Enums

ArcGISDynamicMapServiceLayer

Class Overview

Summary

Public Constructors

public ArcGISDynamicMapServiceLayer (String url, int[] visiblelayers)

Parameters

public ArcGISDynamicMapServiceLayer (String url, int[] visiblelayers, UserCredentials credentials, boolean initLayer)

Parameters

public ArcGISDynamicMapServiceLayer (String url, int[] visiblelayers, int[] invisibleLegendLayers, UserCredentials credentials, boolean initLayer)

Parameters

public ArcGISDynamicMapServiceLayer (String url)

Parameters

public ArcGISDynamicMapServiceLayer (String url, int[] visiblelayers, UserCredentials credentials)

Parameters

Public Methods

public ArcGISPopupInfo createPopupInfo (int sublayerId)

Parameters

Returns

public ArcGISLayerInfo[] getAllLayers ()

Returns

public String getCapabilities ()

Returns

public Map<Integer, String> getLayerDefinitions ()

Returns

See Also

public ArcGISLayerInfo[] getLayers ()

Returns

public ArcGISPopupInfo getPopupInfo (int sublayerId)

Parameters

Returns

public TimeExtent getTimeExtent ()

Returns

public TimeInfo getTimeInfo ()

public TimeExtent getTimeInterval ()

Returns

public Map<Integer, TimeOptions> getTimeOptions ()

Returns

public boolean isTimeAware ()

Returns

public boolean retrieveLegendInfo ()

Returns

public void setLayerDefinitions (Map<Integer, String> layerDefs)

Parameters

public void setTimeInterval (TimeExtent timeInterval)

Parameters

public void setTimeOptions (Map<Integer, TimeOptions> timeOptions)

Parameters

Protected Methods

protected byte[] getImage (int width, int height, Envelope extent)

Throws

protected void initLayer ()