com.esri.adf.web.data.graphics
Class GraphicsMapFunctionality

java.lang.Object
  com.esri.adf.web.data.graphics.GraphicsMapFunctionality

All Implemented Interfaces:

ExportFunctionality, GISFunctionality, MapFunctionality, java.io.Serializable

public class GraphicsMapFunctionality
extends java.lang.Object
implements MapFunctionality, ExportFunctionality, java.io.Serializable

GraphicsMapFunctionality provides mapping functionality for GraphicsResource.

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

GraphicsMapFunctionality()

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) Exports this map for the provided export properties.
java.io.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.
GraphicsResource	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	setCurrentExtent(WebExtent newMapExtent) Sets the current extent of this map.
void	setDisabled(boolean disabled) If true, this map functionality is disabled.
void	setFullExtent(WebExtent fullExtent) Sets full extent of the map.
void	setInitialExtent(WebExtent initialExtent)
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

GraphicsMapFunctionality

public GraphicsMapFunctionality()

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)

getResource

public GraphicsResource 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

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()

Description copied from interface: MapFunctionality

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.

Specified by:

exportImage in interface MapFunctionality

Returns:

a java.io.InputStream to the exported image

export

public java.io.InputStream export(ExportProperties exportProperties)

Exports this map for the provided export properties.
The image format is set to PNG regardless of what is set in the export properties
When this resource is at the bottom and enabled, an opaque image is blended with it to provide a non-transparent background

Specified by:

export in interface ExportFunctionality

Returns:

a java.io.InputStream to the exported image.
if the Graphic Resource has no layers, the method returns null.

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

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

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

setFullExtent

public void setFullExtent(WebExtent fullExtent)

Sets full extent of the map.

Parameters:

fullExtent - full extent of the 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

setInitialExtent

public void setInitialExtent(WebExtent initialExtent)

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

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