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

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

All Implemented Interfaces:

GISFunctionality, OverviewFunctionality, Serializable

public class AGSImageOverviewFunctionality
extends Object
implements OverviewFunctionality, Serializable

Represents the overview functionality implementation for the ArcGIS Server Image Services.

See Also:

Serialized Form

Field Summary

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

FUNCTIONALITY_NAME

Constructor Summary

AGSImageOverviewFunctionality()

Method Summary

void	destroyFunctionality() The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
InputStream	exportImage() Exports the overview image for this Image Service.
com.esri.arcgisws.EnvelopeN	getImageDescExtent() Return the current extent of the image overview
com.esri.arcgisws.GeoImageDescription	getImageDescription() Returns the GeoImageDescription for the overview image.
AGSImageResource	getResource() Returns the AGSImageResource this functionality belongs to
void	initFunctionality(GISResource resource) Initializes an instance of the AGSImageOverviewFunctionality for this resource.
boolean	isDisabled() Returns the state of this functionality
void	setDisabled(boolean disabled) Sets the state of this functionality

Methods inherited from class java.lang.Object

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

Constructor Detail

AGSImageOverviewFunctionality

public AGSImageOverviewFunctionality()

Method Detail

initFunctionality

public void initFunctionality(GISResource resource)

Initializes an instance of the AGSImageOverviewFunctionality 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 AGSImageResource getResource()

Returns the AGSImageResource this functionality belongs to

Specified by:

getResource in interface GISFunctionality

Returns:

The image resource

getImageDescription

public com.esri.arcgisws.GeoImageDescription getImageDescription()

Returns the GeoImageDescription for the overview image.

isDisabled

public boolean isDisabled()

Returns the state of this functionality

Specified by:

isDisabled in interface OverviewFunctionality

Returns:

true if this overview functionality is disabled

setDisabled

public void setDisabled(boolean disabled)

Sets the state of this functionality

Specified by:

setDisabled in interface OverviewFunctionality

Parameters:

disabled - true if this overview functionality is disabled

getImageDescExtent

public com.esri.arcgisws.EnvelopeN getImageDescExtent()

Return the current extent of the image overview

Returns:

The current extent

exportImage

public InputStream exportImage()

Exports the overview image for this Image Service.

Specified by:

exportImage in interface OverviewFunctionality

Returns:

The InputStream containing the image data