com.esri.adf.web.aims.data
Class AIMSOverviewFunctionality

java.lang.Object
  com.esri.adf.web.aims.data.AIMSOverviewFunctionality

All Implemented Interfaces:

GISFunctionality, OverviewFunctionality

public class AIMSOverviewFunctionality

extends java.lang.Object

implements OverviewFunctionality

The AIMSOverviewFunctionality maintains the reference to the Map object.

When initFunctionality(com.esri.adf.web.data.GISResource) method is called, the GET_SERVICE_INFO request is sent to the ArcIMS Server.

Calling exportImage(), the GET_IMAGE AXL request is sent to the ArcIMS Server.

ArcIMS Overview Functionality can be added using JSF managed bean configuration as shown below,

 <managed-bean>
  <managed-bean-name>aimsOverview</managed-bean-name>
  <managed-bean-class>com.esri.adf.web.aims.data.AIMSOverviewFunctionality</managed-bean-class>
   <managed-bean-scope>none</managed-bean-scope>
 </managed-bean>
 

Field Summary

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

FUNCTIONALITY_NAME

Constructor Summary

AIMSOverviewFunctionality()

Method Summary

void	destroyFunctionality() The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
java.io.InputStream	exportImage() Exports this overview map for the extent indicated by the WebOverview.
java.lang.String	getDefaultDataFrame() Returns the default dataframe name.
int	getDPI() Returns the DPI from the overview functionality.
com.esri.aims.mtier.model.map.Map	getMap() Returns the Map object.
GISResource	getResource() Returns the GISResource associated with this functionality.
void	initFunctionality(GISResource resource) The initialization chores for the functionality must be performed in this method.
boolean	isDisabled() Returns true if this overview functionality is disabled.
void	setDefaultDataFrame(java.lang.String defaultDataFrame) Sets the default data frame in which the overview functionality should work with.
void	setDisabled(boolean disabled) If true, this overview functionality is disabled.
void	setDPI(int dpi) Sets the DPI(dots per square inch) for the overview functionality output image.

Methods inherited from class java.lang.Object

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

Constructor Detail

AIMSOverviewFunctionality

public AIMSOverviewFunctionality()

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)

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 GISResource 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

exportImage

public java.io.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.
• If this is not the bottom-most overview functionality referenced by the WebMap, the image should exported by setting its background color as the transparent color. The WebOverview#isLastEnabledOverviewFunctionality(this) can be used to determine this condition.

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

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

getMap

public com.esri.aims.mtier.model.map.Map getMap()

Returns the Map object.

Returns:

the map object

setDPI

public void setDPI(int dpi)

Sets the DPI(dots per square inch) for the overview functionality output image.

Parameters:

dpi - the DPI for the overview functionality output image

getDPI

public int getDPI()

Returns the DPI from the overview functionality.

Returns:

the DPI from the overview functionality

setDefaultDataFrame

public void setDefaultDataFrame(java.lang.String defaultDataFrame)

Sets the default data frame in which the overview functionality should work with.

This property is valid only if the associated resource service type is ImageServerArcMap.

Parameters:

defaultDataFrame - the default dataframe name

getDefaultDataFrame

public java.lang.String getDefaultDataFrame()

Returns the default dataframe name.

Returns:

the default dataframe name