com.esri.adf.web.data
Interface MapFunctionality

All Superinterfaces:

GISFunctionality

All Known Subinterfaces:

MapFunctionality2

All Known Implementing Classes:

AGSImageMapFunctionality, AGSMapFunctionality, AIMSMapFunctionality, GraphicsMapFunctionality, VEImageryFunctionality, WMSMapFunctionality

public interface MapFunctionality
extends GISFunctionality

The MapFunctionality interface is implemented by functionalities to provide mapping capability for the resource. For instance, the AGSMapFunctionality provides mapping for ArcGIS Server resources, the AIMSMapFunctionality provides mapping for ArcIMS resources, et al.

The WebMap works with several map functionalities referenced by the resources by the name FUNCTIONALITY_NAME. The WebMap fuses the map images exported by these map functionalities, applies the correct transparencies, sets and gets the extents, etc.

Field Summary

static String

FUNCTIONALITY_NAME The name that should be given to the MapFunctionality in order for it to be consumed by the WebMap

Method Summary

InputStream	exportImage() Exports this map for the current extent.
WebExtent	getCurrentExtent() Returns the current extent of this map.
WebExtent	getFullExtent() Returns the full extent of this map.
WebExtent	getInitialExtent() Returns the initial extent of this map.
double	getMapScale() Returns the current scale of this map.
double	getTransparency() Returns the transparency factor for this map functionality.
boolean	isDisabled() Returns true if this map functionality is disabled.
void	setCurrentExtent(WebExtent newMapExtent) Sets the current extent of this map.
void	setDisabled(boolean disabled) If true, this map functionality is disabled.
void	setTransparency(double transparency) Sets the transparency factor for this map functionality.

Methods inherited from interface com.esri.adf.web.data.GISFunctionality

destroyFunctionality, getResource, initFunctionality

Field Detail

FUNCTIONALITY_NAME

static final String FUNCTIONALITY_NAME

The name that should be given to the MapFunctionality in order for it to be consumed by the WebMap

See Also:

Constant Field Values

Method Detail

exportImage

InputStream exportImage()

Exports this map for the current extent. Implementations should ensure the following:

• The map should be exported in the spatial reference of the associated WebContext.
• If this is not the bottom-most map functionality referenced by the WebMap, the image should exported by setting its background color as the transparent color. The WebMap.isLastEnabledMapFunctionality(MapFunctionality) can be used to determine this condition.

The WebMap calls this method on all its map functionalities and eventually fuses all the exported maps before streaming it to the user.

Returns:

a java.io.InputStream to the exported image

getCurrentExtent

WebExtent getCurrentExtent()

Returns the current extent of this map.

Returns:

the current WebExtent of this map

setCurrentExtent

void setCurrentExtent(WebExtent newMapExtent)

Sets the current extent of this map.

Parameters:

newMapExtent - the current WebExtent of this map

getFullExtent

WebExtent getFullExtent()

Returns the full extent of this map.

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

Returns:

the full WebExtent of this map

getInitialExtent

WebExtent getInitialExtent()

Returns the initial extent of this map.

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

Returns:

the initial WebExtent of this map

getMapScale

double getMapScale()

Returns the current scale of this map.

Returns:

the current scale of this map

isDisabled

boolean isDisabled()

Returns true if this map functionality is disabled. If a map functionality is disabled, the WebMap will not call the 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.

Returns:

true if this map functionality is disabled

setDisabled

void setDisabled(boolean disabled)

If true, this map functionality is disabled. If a map functionality is disabled, the WebMap will not call the 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.

Parameters:

disabled - true if this map functionality is disabled

setTransparency

void setTransparency(double transparency)

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.

Parameters:

transparency - the transparency factor for this map functionality

getTransparency

double getTransparency()

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.

Returns:

the transparency factor for this map functionality