com.esri.adf.web.aws.data
Class AWSMapFunctionality

java.lang.Object
  com.esri.adf.web.aws.data.AWSMapFunctionality

All Implemented Interfaces:

ExportFunctionality, GISFunctionality, MapFunctionality, java.io.Serializable

Deprecated. This class is deprecated as of ArcGIS Java Server 9.3.1, no replacement

@Deprecated
public class AWSMapFunctionality
extends java.lang.Object
implements MapFunctionality, ExportFunctionality, java.io.Serializable

See Also:

Serialized Form

Field Summary

protected AWSMapResource	awsMapResource Deprecated.
protected com.esri.aws.Envelope	currentEnvelope Deprecated.
protected com.esri.aws.CoordSys	currentSR Deprecated.
protected com.esri.aws.CoordSys	defaultSR Deprecated.
protected boolean	disabled Deprecated.
protected WebExtent	fullExtent Deprecated.
protected WebExtent	initialExtent Deprecated.
protected com.esri.aws.LayerInfo[]	layerInfoForCurrentExtent Deprecated.
protected com.esri.aws.Layer[]	layers Deprecated.
protected double	mapScale Deprecated.
protected double	transparency Deprecated.

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

AWSMapFunctionality()
Deprecated.

Method Summary

void	destroyFunctionality() Deprecated. The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
java.io.InputStream	export(ExportProperties exportProperties) Deprecated.
java.io.InputStream	exportImage() Deprecated. Exports this map for the current extent.
WebExtent	getCurrentExtent() Deprecated. Returns the current extent of this map.
WebExtent	getFullExtent() Deprecated. Returns the full extent of this map.
WebExtent	getInitialExtent() Deprecated. Returns the initial extent of this map.
com.esri.aws.LayerInfo[]	getLayerInfoForCurrentExtent() Deprecated.
com.esri.aws.Layer[]	getLayers() Deprecated.
double	getMapScale() Deprecated. Returns the current scale of this map.
AWSMapResource	getResource() Deprecated. Returns the GISResource associated with this functionality.
double	getTransparency() Deprecated. Returns the transparency factor for this map functionality.
void	initFunctionality(GISResource resource) Deprecated. The initialization chores for the functionality must be performed in this method.
boolean	isDisabled() Deprecated. Returns true if this map functionality is disabled.
void	setCurrentExtent(WebExtent newMapExtent) Deprecated. Sets the current extent of this map.
void	setDisabled(boolean disabled) Deprecated. If true, this map functionality is disabled.
void	setFullExtent(WebExtent extent) Deprecated.
void	setInitialExtent(WebExtent extent) Deprecated.
void	setLayers(com.esri.aws.Layer[] layers) Deprecated.
void	setTransparency(double transparency) Deprecated. 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

Field Detail

awsMapResource

protected AWSMapResource awsMapResource

Deprecated.

fullExtent

protected WebExtent fullExtent

Deprecated.

disabled

protected boolean disabled

Deprecated.

mapScale

protected double mapScale

Deprecated.

currentEnvelope

protected com.esri.aws.Envelope currentEnvelope

Deprecated.

layers

protected com.esri.aws.Layer[] layers

Deprecated.

layerInfoForCurrentExtent

protected com.esri.aws.LayerInfo[] layerInfoForCurrentExtent

Deprecated.

initialExtent

protected WebExtent initialExtent

Deprecated.

transparency

protected double transparency

Deprecated.

currentSR

protected com.esri.aws.CoordSys currentSR

Deprecated.

defaultSR

protected com.esri.aws.CoordSys defaultSR

Deprecated.

Constructor Detail

AWSMapFunctionality

public AWSMapFunctionality()

Deprecated.

Method Detail

initFunctionality

public void initFunctionality(GISResource resource)

Deprecated.

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

Deprecated.

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

getCurrentExtent

public WebExtent getCurrentExtent()

Deprecated.

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)

Deprecated.

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

isDisabled

public boolean isDisabled()

Deprecated.

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)

Deprecated.

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

Deprecated.

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)

Deprecated.

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

getFullExtent

public WebExtent getFullExtent()

Deprecated.

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

Deprecated.

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

getMapScale

public double getMapScale()

Deprecated.

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

exportImage

public java.io.InputStream exportImage()

Deprecated.

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)

Deprecated.

Specified by:

export in interface ExportFunctionality

getResource

public AWSMapResource getResource()

Deprecated.

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

getLayerInfoForCurrentExtent

public com.esri.aws.LayerInfo[] getLayerInfoForCurrentExtent()

Deprecated.

getLayers

public com.esri.aws.Layer[] getLayers()

Deprecated.

setFullExtent

public void setFullExtent(WebExtent extent)

Deprecated.

setInitialExtent

public void setInitialExtent(WebExtent extent)

Deprecated.

setLayers

public void setLayers(com.esri.aws.Layer[] layers)

Deprecated.