com.esri.adf.web.ags.data.image
Class AGSImageMapFunctionality

java.lang.Object
  com.esri.adf.web.ags.data.image.AGSImageMapFunctionality

All Implemented Interfaces:

ExportFunctionality, GISFunctionality, MapFunctionality, MapFunctionality2, java.io.Serializable

public class AGSImageMapFunctionality
extends java.lang.Object
implements MapFunctionality2, ExportFunctionality, java.io.Serializable

This class connects to the Image Service to retrieve the map image. It allows you to configure properties like Compression Quality, Transparency, and the bands to be included in the image, etc.

  <managed-bean>
   <managed-bean-name>agsMap1</managed-bean-name>
   <managed-bean-class>com.esri.adf.web.ags.data.image.AGSImageMapFunctionality</managed-bean-class>
   <managed-bean-scope>none</managed-bean-scope>
   <managed-property>
     <property-name>transparency</property-name>
     <value>1.0</value>
   </managed-property>
   <managed-property>
     <property-name>compressionQuality</property-name>
     <value>100</value>
   </managed-property>
   <managed-property>
     <property-name>bandIDs</property-name>
     <list-entries>
       <value-class>int</value-class>
       <value>0</value>
       <value>1</value>
       <value>2</value>
     </list-entries>
   </managed-property>
 </managed-bean>
 

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.adf.web.data.MapFunctionality

FUNCTIONALITY_NAME

Fields inherited from interface com.esri.adf.web.data.export.ExportFunctionality

EXPORT_FUNCTIONALITY_NAME

Constructor Summary

AGSImageMapFunctionality()

Method Summary

void	destroyFunctionality() The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
java.io.InputStream	export(ExportProperties exportProperties)
java.io.InputStream	exportImage() Exports a map for the Image Service at the current extent.
int[]	getBandIDs() Returns the band ID's.
int	getCompressionQuality() Returns the compression quality of the image.
com.esri.arcgisws.EnvelopeN	getCurrentAGSExtent() Returns the current extent as an EnvelopeN.
WebExtent	getCurrentExtent() Returns the current extent of this map.
WebExtent	getCurrentExtentInContextSR() Returns the current extent in the Web Context's spatial reference.
WebExtent	getFullExtent() Returns the full extent of this map.
WebExtent	getInitialExtent() Returns the initial extent of this map.
java.lang.String	getInterpolation() Returns the interpolation.
double	getMapScale() Returns the current scale of this map.
GISResource	getResource() Returns the GISResource associated with this functionality.
double	getTransparency() Returns the transparency factor for this map functionality.
void	initFunctionality(GISResource resource) The initialization chores for the functionality must be performed in this method.
boolean	isDisabled() Returns true if this map functionality is disabled.
void	setBandIDs(int[] bandIDs) Sets the band ID's that will be included in the resulting image.
void	setCompressionQuality(int compressionQuality) Sets the compression quality.
void	setCurrentAGSExtent(com.esri.arcgisws.EnvelopeN extent)
void	setCurrentExtent(WebExtent newMapExtent) Sets the current extent of this map.
void	setDisabled(boolean disabled) If true, this map functionality is disabled.
void	setInterpolation(java.lang.String interpolation) Sets the interpolation method.
void	setTransparency(double transparency) Sets the transparency factor for this map functionality.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AGSImageMapFunctionality

public AGSImageMapFunctionality()

Method Detail

initFunctionality

public void initFunctionality(GISResource resource)

Description copied from interface: GISFunctionality

The initialization chores for the functionality must be performed in this method. This method is called by the resource when the functionality needs to be initialized. This happens either when the resource itself is being initialized or if users add this functionality to the resource using the GISResource.addFunctionality(String, GISFunctionality) method after the resource has already been initialized.

Classes which implement this method should maintain the resource as a class instance variable and return the same in the GISFunctionality.getResource() method. The functionality is ready for use only after this method has been called.

Specified by:

initFunctionality in interface GISFunctionality

Parameters:

resource - the GISResource that this functionality supports

See Also:

GISResource.init(WebContext)

destroyFunctionality

public void destroyFunctionality()

Description copied from interface: GISFunctionality

The cleanup chores (such as releasing held resources) for the functionality must be performed in this method. This method is called by the GISResource when the resource itself is being destroyed.

The functionality is no longer usable after this method has been called.

Specified by:

destroyFunctionality in interface GISFunctionality

See Also:

GISResource.destroy()

exportImage

public java.io.InputStream exportImage()

Exports a map for the Image Service at the current extent.

Specified by:

exportImage in interface MapFunctionality

Returns:

a java.io.InputStream to the exported image

export

public java.io.InputStream export(ExportProperties exportProperties)

Specified by:

export in interface ExportFunctionality

getResource

public GISResource getResource()

Description copied from interface: GISFunctionality

Returns the GISResource associated with this functionality.

The resource passed to GISFunctionality.initFunctionality(GISResource) is maintained as a class variable and is accessible through this method.

Specified by:

getResource in interface GISFunctionality

Returns:

the GISResource associated with this functionality

getFullExtent

public WebExtent getFullExtent()

Description copied from interface: MapFunctionality

Returns the full extent of this map.

Typically, this extent should be determined by the functionality when it is initialized.

Specified by:

getFullExtent in interface MapFunctionality

Returns:

the full WebExtent of this map

getInitialExtent

public WebExtent getInitialExtent()

Description copied from interface: MapFunctionality

Returns the initial extent of this map.

Typically, this extent should be determined by the functionality when it is initialized.

Specified by:

getInitialExtent in interface MapFunctionality

Returns:

the initial WebExtent of this map

getCurrentExtentInContextSR

public WebExtent getCurrentExtentInContextSR()

Description copied from interface: MapFunctionality2

Returns the current extent in the Web Context's spatial reference.

Specified by:

getCurrentExtentInContextSR in interface MapFunctionality2

Returns:

the current WebExtent of this map

See Also:

WebContext.getSpatialReference()

getCurrentExtent

public WebExtent getCurrentExtent()

Description copied from interface: MapFunctionality

Returns the current extent of this map.

Specified by:

getCurrentExtent in interface MapFunctionality

Returns:

the current WebExtent of this map

setCurrentExtent

public void setCurrentExtent(WebExtent newMapExtent)

Description copied from interface: MapFunctionality

Sets the current extent of this map.

Specified by:

setCurrentExtent in interface MapFunctionality

Parameters:

newMapExtent - the current WebExtent of this map

getCurrentAGSExtent

public com.esri.arcgisws.EnvelopeN getCurrentAGSExtent()

Returns the current extent as an EnvelopeN.

Returns:

the current extent

setCurrentAGSExtent

public void setCurrentAGSExtent(com.esri.arcgisws.EnvelopeN extent)

getTransparency

public double getTransparency()

Description copied from interface: MapFunctionality

Returns the transparency factor for this map functionality. Valid values are from 0.0 through 1.0. A value of 1 means it is completely opaque while a value of 0 means it is completely transparent.

The WebMap uses this value after the map image has been exported and applies the transparency appropriately. Note that transparency will not be applied for the lower most service. In a single service application that service is the lower most service and hence transparency will not be applied for it.

Specified by:

getTransparency in interface MapFunctionality

Returns:

the transparency factor for this map functionality

setTransparency

public void setTransparency(double transparency)

Description copied from interface: MapFunctionality

Sets the transparency factor for this map functionality. Valid values are from 0.0 through 1.0. A value of 1 means it is completely opaque while a value of 0 means it is completely transparent.

The WebMap uses this value after the map image has been exported and applies the transparency appropriately. Note that transparency will not be applied for the lower most service. In a single service application that service is the lower most service and hence transparency will not be applied for it.

Specified by:

setTransparency in interface MapFunctionality

Parameters:

transparency - the transparency factor for this map functionality

isDisabled

public boolean isDisabled()

Description copied from interface: MapFunctionality

Returns true if this map functionality is disabled. If a map functionality is disabled, the WebMap will not call the MapFunctionality.exportImage() on that functionality while it is disabled.

A map functionality is typically disabled by unchecking the resource node in the Table of Contents control.

Specified by:

isDisabled in interface MapFunctionality

Returns:

true if this map functionality is disabled

setDisabled

public void setDisabled(boolean disabled)

Description copied from interface: MapFunctionality

If true, this map functionality is disabled. If a map functionality is disabled, the WebMap will not call the MapFunctionality.exportImage() on that functionality while it is disabled.

A map functionality is typically disabled by unchecking the resource node in the Table of Contents control.

Specified by:

setDisabled in interface MapFunctionality

Parameters:

disabled - true if this map functionality is disabled

getMapScale

public double getMapScale()

Description copied from interface: MapFunctionality

Returns the current scale of this map.

Specified by:

getMapScale in interface MapFunctionality

Returns:

the current scale of this map

getCompressionQuality

public int getCompressionQuality()

Returns the compression quality of the image.

Returns:

The compression quality
Default is 100

setCompressionQuality

public void setCompressionQuality(int compressionQuality)

Sets the compression quality. The value can be between 0-100.
A value of 0 means maximum compression (lowest quality).
A value of 100 means minimum compression (highest quality).

Parameters:

compressionQuality -
Default is 100

getInterpolation

public java.lang.String getInterpolation()

Returns the interpolation.

Returns:

The interpolation
Default is RSP_BilinearInterpolation

setInterpolation

public void setInterpolation(java.lang.String interpolation)

Sets the interpolation method.
Possible values are: RSP_NearestNeighbor, RSP_BilinearInterpolation, RSP_CubicConvolution, RSP_Majority.
See RstResamplingTypes for a complete list of values.

Parameters:

interpolation -
Default is RSP_BilinearInterpolation

getBandIDs

public int[] getBandIDs()

Returns the band ID's.

Returns:

The band ID's

setBandIDs

public void setBandIDs(int[] bandIDs)

Sets the band ID's that will be included in the resulting image. The resulting image can contain either 1 band for gray scale images or 3 bands for color images. The band ID's are numbered from 0 to bandCount-1, where bandCount can be retrieved from ImageServiceInfo.

Parameters:

bandIDs -