public class

WMSLayer

extends DynamicLayer

java.lang.Object
↳	com.esri.android.map.Layer
	↳	com.esri.android.map.DynamicLayer
		↳	com.esri.android.map.ogc.WMSLayer

Class Overview

A layer for OGC Web Map Services (WMS). This class searches for its default spatial reference and extent from root to bottom in its layer hierarchy. It allows users to specify the default spatial references in the constructor too if users want to do that.

Summary

[Expand]

Inherited Fields

From class com.esri.android.map.DynamicLayer

From class com.esri.android.map.Layer

Public Constructors
	WMSLayer(String url) This constructor is used if you're instantiating the WMSLayer using a URL.
	WMSLayer(String url, String[] visibleLayers) This constructor is used if you're instantiating the WMSLayer using a URL and visible layer names.
	WMSLayer(String url, SpatialReference sr) This constructor is used if you're instantiating the WMSLayer using a URL and default spatial reference.
	WMSLayer(String url, boolean checkSupportedSRs) This constructor is used if you're instantiating the WMSLayer using a URL and checkSupportedSRs flag.
	WMSLayer(String url, SpatialReference sr, boolean checkSupportedSRs, String[] visibleLayers, UserCredentials credentials, boolean initLayer) This constructor is used if you're instantiating the WMSLayer using a URL, default spatial reference, checkSupportedSRs flag, visible layer names, user credential and initLayer flag.

Public Methods
String	getImageFormat() Returns the image format.
WMSLayerInfo[]	getLayers() Gets all layer information available in the service.
String[]	getSupportedImageFormats() Gets the supported image formats.
SpatialReference[]	getSupportedSpatialReferences() Gets supported spatial references.
String	getVersion() Gets the WMS service's version.
String[]	getVisibleLayers() Gets visible layer names.
boolean	isTransparent() True if the image background is transparent.
void	setImageFormat(String format) Sets the image format as a string('image/png', etc.).
void	setTransparent(boolean transparent) Sets the image background to be transparent or not.
void	setVisibleLayer(String[] layerNames) Sets visible layers by specifying the layer names.

Protected Methods
byte[]	getImage(int width, int height, Envelope extent)
void	initLayer() Initializes the layer.
void	updateSpatialReferenceStatus(int SRStatus) The callback method is invoked when the layer is added to map.

[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

Public Constructors

public WMSLayer (String url)

This constructor is used if you're instantiating the WMSLayer using a URL.

Parameters

url	URL string to the WMS layer.

public WMSLayer (String url, String[] visibleLayers)

This constructor is used if you're instantiating the WMSLayer using a URL and visible layer names.

Parameters

url	URL string to the WMS layer.
visibleLayers	names of sub-layers to be included in the image rendered(EPSG:3857, etc.).

public WMSLayer (String url, SpatialReference sr)

This constructor is used if you're instantiating the WMSLayer using a URL and default spatial reference. A WMSLayer may support several spatial references. Users can specify a default spatial reference instead of asking WMSLayer to choose one automatically.

Parameters

url	URL string to the WMS layer.
sr	default spatial reference of the layer.

public WMSLayer (String url, boolean checkSupportedSRs)

This constructor is used if you're instantiating the WMSLayer using a URL and checkSupportedSRs flag. If checkSupportedSRs is false, it assumes that WMS layer can be projected to any spatial reference and it will not check if map's spatial reference is in the supported spatial reference list of the WMS layer. Users can set this flag to false if some spatial reference is supported by WMS service but not declared in its capability response.

Parameters

url	URL string to the WMS layer.
checkSupportedSRs	a flag which indicate to check if map's spatial reference is in the WMSLayer's supported spatial reference list or not.

public WMSLayer (String url, SpatialReference sr, boolean checkSupportedSRs, String[] visibleLayers, UserCredentials credentials, boolean initLayer)

This constructor is used if you're instantiating the WMSLayer using a URL, default spatial reference, checkSupportedSRs flag, visible layer names, user credential and initLayer flag.

Parameters

url	URL string to the WMS layer.
sr	default spatial reference.
checkSupportedSRs	true if map's spatial reference is checked against spatial reference list supported by the WMS service when layer is added into map.
visibleLayers	names of sub-layers to be included in the image rendered.
credentials	user credential
initLayer	true if layer initialization happens immediately.

Public Methods

public String getImageFormat ()

Returns the image format. Default is 'image/png'.

Returns

image format in String.

public WMSLayerInfo[] getLayers ()

Gets all layer information available in the service.

Returns

an array of WMSLayerInfo objects.

public String[] getSupportedImageFormats ()

Gets the supported image formats.

Returns

supported image formats in String array.

public SpatialReference[] getSupportedSpatialReferences ()

Gets supported spatial references.

Returns

spatial references in array.

public String getVersion ()

Gets the WMS service's version.

Returns

WMS service version in String.

public String[] getVisibleLayers ()

Gets visible layer names. If not set, all the layers are visible and a null is returned.

Returns

visible layer name array.

public boolean isTransparent ()

True if the image background is transparent. Please ensure that the WMS service supports this property. Default is true.

Returns

true if image background is transparent.

public void setImageFormat (String format)

Sets the image format as a string('image/png', etc.). Please ensure that the WMS service supports the requested image format.

Parameters

format	image format in string.

public void setTransparent (boolean transparent)

Sets the image background to be transparent or not. Please ensure that the WMS service supports this property.

Parameters

transparent	true if image background is set to transparent.

public void setVisibleLayer (String[] layerNames)

Sets visible layers by specifying the layer names.

Parameters

layerNames	visible ayer name array.

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.

protected void updateSpatialReferenceStatus (int SRStatus)

The callback method is invoked when the layer is added to map. 0 - Spatial Reference Invalid 1 - Spatial Reference NotNeeded 2 - Spatial Reference Projected 3 - Spatial Reference Good

Parameters

SRStatus	an integer indicating the spatial reference status of layer

Classes

WMSLayer

Class Overview

Summary

Public Constructors

public WMSLayer (String url)

Parameters

public WMSLayer (String url, String[] visibleLayers)

Parameters

public WMSLayer (String url, SpatialReference sr)

Parameters

public WMSLayer (String url, boolean checkSupportedSRs)

Parameters

public WMSLayer (String url, SpatialReference sr, boolean checkSupportedSRs, String[] visibleLayers, UserCredentials credentials, boolean initLayer)

Parameters

Public Methods

public String getImageFormat ()

Returns

public WMSLayerInfo[] getLayers ()

Returns

public String[] getSupportedImageFormats ()

Returns

public SpatialReference[] getSupportedSpatialReferences ()

Returns

public String getVersion ()

Returns

public String[] getVisibleLayers ()

Returns

public boolean isTransparent ()

Returns

public void setImageFormat (String format)

Parameters

public void setTransparent (boolean transparent)

Parameters

public void setVisibleLayer (String[] layerNames)

Parameters

Protected Methods

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

Throws

protected void initLayer ()

protected void updateSpatialReferenceStatus (int SRStatus)

Parameters