public class

ArcGISImageServiceLayer

extends DynamicLayer

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

Class Overview

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

The following are examples of how you might work with the ArcGISImageServiceLayer class. The code will add a map service from ArcGIS Online using map services that are dynamically retrieved. When working with dynamic services the ArcGISImageServiceLayer 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:

 //ArcGISImageServiceLayer class is used to define the Layer that is added to the
 //MapView object.
 MapView mv = new MapView(this);
 mv.addLayer(new ArcGISImageServiceLayer(
 "http://myserver/arcgis/rest/services/MyImage/ImageServer",null));
 setContentView(mv);

Summary

[Expand]

Inherited Fields

From class com.esri.android.map.DynamicLayer

From class com.esri.android.map.Layer

Public Constructors
	ArcGISImageServiceLayer(String url, ImageServiceParameters options) This constructor is used if you're instantiating the ArcGISImageServiceLayer.
	ArcGISImageServiceLayer(String url, ImageServiceParameters options, UserCredentials credentials, boolean initLayer) This constructor is used if you instantiate an ArcGISImageServiceLayer object.
	ArcGISImageServiceLayer(String url, ImageServiceParameters options, UserCredentials credentials) This constructor is used if you're instantiating the ArcGISImageServiceLayer (see the class description for an example of this usage).

Public Methods
int	getBandCount() Gets the number of bands in the ArcGISImageServiceLayer.
int[]	getBandIds() Gets ImageService Band IDs.
int	getCompressionQuality() Gets the compression quality of the exported image.
String	getCopyrightText() Gets the copyright information of the ArcGISImageServiceLayer.
ImageServiceParameters.IMAGE_FORMAT	getImageFormat() Gets the image format.
ImageServiceParameters.RSP	getInterpolation() Gets the interpolation method.
MosaicRule	getMosaicRule() Gets the mosaic rule of the layer.
ImageServiceParameters	getOptions() Gets the options of the ArcGISImageServiceLayer.
double	getPixelSizeX() Gets the size of pixel in X direction.
double	getPixelSizeY() Gets the size of pixel in Y direction.
ImageServiceParameters.PIXEL_TYPE	getPixelType() Gets the pixel type of the image service.
RasterFunction	getRenderingRule() Gets the rendering rule of the layer.
void	setBandIds(int[] bandIds) Sets the R,G,B of the exported image to the appropriate ImageService Band ID.
void	setCompressionQuality(int compressionQuality) Sets the compression quality of the exported image.
void	setImageFormat(ImageServiceParameters.IMAGE_FORMAT format) Sets the image format.
void	setInterpolation(ImageServiceParameters.RSP interpolation) Sets the interpolation method.
void	setMosaicRule(MosaicRule mosaicRule) Sets the mosaic rule of the layer to the specified value.
void	setRenderingRule(RasterFunction renderingRule) Sets the rendering rule of the layer to the given value.

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

Public Constructors

public ArcGISImageServiceLayer (String url, ImageServiceParameters options)

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

Parameters

url	the URL of the dynamic map service.
options	optional parameters.

public ArcGISImageServiceLayer (String url, ImageServiceParameters options, UserCredentials credentials, boolean initLayer)

This constructor is used if you instantiate an ArcGISImageServiceLayer object.

Parameters

url	the URL of the dynamic map service.
options	optional parameters.
credentials	the credentials
initLayer	set to true to initialize the the layer, or the layer will not initialized.

public ArcGISImageServiceLayer (String url, ImageServiceParameters options, UserCredentials credentials)

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

Parameters

url	the URL of the image map service.
options	optional parameters.
credentials	the credentials

Public Methods

public int getBandCount ()

Gets the number of bands in the ArcGISImageServiceLayer. The BandCount is defined in the associated service. You should not invoke the method unless the layer is initialized.

Returns

Returns the bandCount.

public int[] getBandIds ()

Gets ImageService Band IDs. BandIds are zero based.

Returns

the band ids

public int getCompressionQuality ()

Gets the compression quality of the exported image. Only valid with JPG image format.

Returns

A value from 0 to 100. 100 is best quality but largest in file size.

public String getCopyrightText ()

Gets the copyright information of the ArcGISImageServiceLayer. The text is defined in the associated service. You should not invoke the method unless the layer is initialized.

Returns

Returns the copyrightText.

public ImageServiceParameters.IMAGE_FORMAT getImageFormat ()

Gets the image format.

Returns

the image format.

public ImageServiceParameters.RSP getInterpolation ()

Gets the interpolation method. The interpolation method affects how the raster dataset is transformed when it undergoes warping or when it changes coordinate space.

Returns

the interpolation value.

public MosaicRule getMosaicRule ()

Gets the mosaic rule of the layer. The mosaic rule defines how individual images should be mosaicked.

Returns

the current MosaicRule.

public ImageServiceParameters getOptions ()

Gets the options of the ArcGISImageServiceLayer.

Returns

Returns the options.

public double getPixelSizeX ()

Gets the size of pixel in X direction. The size is defined in the associated service. You should not invoke the method unless the layer is initialized.

Returns

Returns the pixelSizeX.

public double getPixelSizeY ()

Gets the size of pixel in Y direction. The size is defined in the associated service. You should not invoke the method unless the layer is initialized.

Returns

Returns the pixelSizeY.

public ImageServiceParameters.PIXEL_TYPE getPixelType ()

Gets the pixel type of the image service. Pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point. Integers are whole numbers, whereas floating points have decimals. The type is defined in the associated service. You should not invoke the method unless the layer is initialized.

Returns

Returns the pixelType.

public RasterFunction getRenderingRule ()

Gets the rendering rule of the layer.

Returns

the new rendering rule.

public void setBandIds (int[] bandIds)

Sets the R,G,B of the exported image to the appropriate ImageService Band ID. BandIds are zero based. You need to call refresh() to reflect changes of the band ids.

Parameters

bandIds	the new band ids.

public void setCompressionQuality (int compressionQuality)

Sets the compression quality of the exported image. Only valid with JPG image format.You need to call

Parameters

compressionQuality	A value from 0 to 100. 100 is best quality but largest in file size. `refresh()` to reflect changes of the compression quality.

public void setImageFormat (ImageServiceParameters.IMAGE_FORMAT format)

Sets the image format. You need to call refresh() to reflect changes of the format.

Parameters

format	the new image format.

public void setInterpolation (ImageServiceParameters.RSP interpolation)

Sets the interpolation method. The interpolation method affects how the raster dataset is transformed when it undergoes warping or when it changes coordinate space. You need to call refresh() to reflect changes of the interpolation value.

Parameters

interpolation	the new interpolation value.

public void setMosaicRule (MosaicRule mosaicRule)

Sets the mosaic rule of the layer to the specified value. The mosaic rule defines how individual images should be mosaicked. You need to call refresh() to reflect changes of the MosaicRule.

Parameters

mosaicRule	the mosaic rule.

public void setRenderingRule (RasterFunction renderingRule)

Sets the rendering rule of the layer to the given value. You need to call refresh() to reflect changes of the rendering rule.

Parameters

renderingRule	the new rendering rule.

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

ArcGISImageServiceLayer

Class Overview

Summary

Public Constructors

public ArcGISImageServiceLayer (String url, ImageServiceParameters options)

Parameters

public ArcGISImageServiceLayer (String url, ImageServiceParameters options, UserCredentials credentials, boolean initLayer)

Parameters

public ArcGISImageServiceLayer (String url, ImageServiceParameters options, UserCredentials credentials)

Parameters

Public Methods

public int getBandCount ()

Returns

public int[] getBandIds ()

Returns

public int getCompressionQuality ()

Returns

public String getCopyrightText ()

Returns

public ImageServiceParameters.IMAGE_FORMAT getImageFormat ()

Returns

public ImageServiceParameters.RSP getInterpolation ()

Returns

public MosaicRule getMosaicRule ()

Returns

public ImageServiceParameters getOptions ()

Returns

See Also

public double getPixelSizeX ()

Returns

public double getPixelSizeY ()

Returns

public ImageServiceParameters.PIXEL_TYPE getPixelType ()

Returns

public RasterFunction getRenderingRule ()

Returns

public void setBandIds (int[] bandIds)

Parameters

public void setCompressionQuality (int compressionQuality)

Parameters

public void setImageFormat (ImageServiceParameters.IMAGE_FORMAT format)

Parameters

public void setInterpolation (ImageServiceParameters.RSP interpolation)

Parameters

public void setMosaicRule (MosaicRule mosaicRule)

Parameters

public void setRenderingRule (RasterFunction renderingRule)

Parameters

Protected Methods

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

Throws

protected void initLayer ()