com.esri.adf.web.ags.data
Class AGSOverviewFunctionality

java.lang.Object
  com.esri.adf.web.ags.data.AGSOverviewFunctionality

All Implemented Interfaces:

GISFunctionality, OverviewFunctionality, Serializable

public class AGSOverviewFunctionality
extends Object
implements OverviewFunctionality, Serializable

Represents the overview functionality implementation for the ArcGIS Server services.

See Also:

Serialized Form

Field Summary

protected AGSMapResource	agsOVMapResource
protected boolean	disabled
protected com.esri.arcgisws.ImageDescription	imageDesc
protected com.esri.arcgisws.MapServerInfo	serverInfo Deprecated. As of ArcGIS Java Server 9.3, instead use getMapServerInfo()

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

FUNCTIONALITY_NAME

Constructor Summary

AGSOverviewFunctionality()

Method Summary

void	destroyFunctionality() The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
InputStream	exportImage() Exports this overview map for the extent indicated by the WebOverview.
com.esri.arcgisws.ImageDescription	getImageDescription() Returns the ImageDescription for the overview image.
com.esri.arcgisws.MapDescription	getMapDescription() Returns the MapDescription for associated ArcGIS Server service.
com.esri.arcgisws.MapServerInfo	getMapServerInfo() Returns the MapServerInfo for associated ArcGIS Server service.
AGSMapResource	getResource() Returns the GISResource associated with this functionality.
void	initFunctionality(GISResource resource) Initializes an instance of the overview functionality for this resource.
boolean	isDisabled() Returns true if this overview functionality is disabled.
void	setDisabled(boolean disabled) If true, this overview functionality is disabled.

Methods inherited from class java.lang.Object

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

Field Detail

agsOVMapResource

protected AGSMapResource agsOVMapResource

disabled

protected boolean disabled

serverInfo

@Deprecated
protected com.esri.arcgisws.MapServerInfo serverInfo

Deprecated. As of ArcGIS Java Server 9.3, instead use getMapServerInfo()

imageDesc

protected com.esri.arcgisws.ImageDescription imageDesc

Constructor Detail

AGSOverviewFunctionality

public AGSOverviewFunctionality()

Method Detail

initFunctionality

public void initFunctionality(GISResource resource)

Initializes an instance of the overview functionality for this resource.

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

getResource

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

isDisabled

public boolean isDisabled()

Description copied from interface: OverviewFunctionality

Returns true if this overview functionality is disabled. If a overview functionality is disabled, the WebOverview will not call the OverviewFunctionality.exportImage() on that functionality while it is disabled.

A overview functionality is typically disabled by using the "Disable Overview" context menu item on the resource node in the Table of Contents control. Similarly, the functionality can be enabled by using "Enable Overview".

Specified by:

isDisabled in interface OverviewFunctionality

Returns:

true if this overview functionality is disabled

setDisabled

public void setDisabled(boolean disabled)

Description copied from interface: OverviewFunctionality

If true, this overview functionality is disabled. If a overview functionality is disabled, the WebOverview will not call the OverviewFunctionality.exportImage() on that functionality while it is disabled.

A overview functionality is typically disabled by using the "Disable Overview" context menu item on the resource node in the Table of Contents control. Similarly, the functionality can be enabled by using "Enable Overview".

Specified by:

setDisabled in interface OverviewFunctionality

Parameters:

disabled - true if this overview functionality is disabled

exportImage

public InputStream exportImage()

Description copied from interface: OverviewFunctionality

Exports this overview map for the extent indicated by the WebOverview. Implementations should ensure the following:

• The map should be exported in the spatial reference of the associated WebContext.
• The map should be exported for the extent indicated by the WebOverview. The WebOverview.getDrawExtent() method can be used to get this extent.

The WebOverview calls this method on all its overview functionalities and eventually fuses all the exported maps before streaming it to the user. This method is called by the WebOverview in these scenarios:

• When the WebOverview is initialized
• When a resource is dynamically added or removed
• When any overview functionality is enabled or disabled

Specified by:

exportImage in interface OverviewFunctionality

Returns:

a java.io.InputStream to the exported image

getMapServerInfo

public com.esri.arcgisws.MapServerInfo getMapServerInfo()

Returns the MapServerInfo for associated ArcGIS Server service.

Returns:

the MapServerInfo for associated ArcGIS Server service.

getMapDescription

public com.esri.arcgisws.MapDescription getMapDescription()

Returns the MapDescription for associated ArcGIS Server service.

Returns:

the MapDescription for associated ArcGIS Server service.

getImageDescription

public com.esri.arcgisws.ImageDescription getImageDescription()

Returns the ImageDescription for the overview image.