com.sas.servlet.tbeans.olapgraphics.html
Class OLAPESRIMapChart

com.sas.servlet.tbeans.olapgraphics.html.OLAPESRIMapChart

All Implemented Interfaces:

ActionProviderViewInterface, HttpActionProviderInterface, HttpActionProviderViewInterface, com.sas.beans.PropertyChangeSource, com.sas.collection.ContentsChangedListener, com.sas.lang.ObjectDataInterface, ComplexStyleInterface, com.sas.servlet.tbeans.features.FeatureListInterface, com.sas.servlet.tbeans.olapgraphics.html.OLAPGraphCompositeStyleKeysInterface, RenderableInterface, TransformationInterface, com.sas.util.WriteToPrintWriterInterface, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener

public class OLAPESRIMapChart
implements com.sas.collection.ContentsChangedListener, java.beans.PropertyChangeListener, ComplexStyleInterface, com.sas.servlet.tbeans.olapgraphics.html.OLAPGraphCompositeStyleKeysInterface

The OLAPESRIMapChart TransformationBean is a servlet component that produces maps that support the visualisation of a single response variable. The maps are drawn using a connection to an ESRI server, where regions of the map are colored based on the response value (measure). The map allows for OLAP exploration, such as drilldown and expand, as well as traditional mapping tools, such as zoom and pan.

Note. This class uses an ESRIMapOLAPDataModel. to map OLAP data to server-side graphs in Java servlets or JavaServer Pages (JSP). This class uses the models in the com.sas.graphics.components package. It is also possible to directly use the image renderer class, com.sas.graphics.map.ESRIMap.

Topics:

Functional Overview for ESRI Map Chart
Display Properties
Behavior

Servlet-based ESRIMapChart Samples

See Also:

ESRIMapModel, ESRIMapDataModel, ESRIMapOLAPDataModel, GraphStyle, Serialized Form

Field Summary

Fields inherited from class com.sas.servlet.tbeans.graphics.BaseESRIMapChart

graphStyle, mode

Constructor Summary

OLAPESRIMapChart()
Constructs a new MapComponent Transformation Bean

Method Summary

java.lang.String	getFormAction() Returns the FormAction used for this object
java.util.List	getPopupModel() Builds the model for popup menu.
byte[]	getPrintImage() Creates an image suitable for printing, containing the map, the legend, and a text string for the measure combo box.
java.lang.String	getReportLinkingText() Returns the text used for the report linking popup menu
java.lang.String[]	identify(int x, int y) This method returns an array of Strings that represent the known information about the map feature found at the coordinate (x,y).
boolean	isReportLinkingOn() Returns the visibility of the popup menu used for report linking.
boolean	isShowCrossing() Returns whether the map is currently displaying the crossing information.
void	performAction() Do the real work for rendering a map.
void	printDebugInfo(ESRIMap myMap) Prints debug information about the map, map service, OLAP config info, etc to the output log.
void	setDataModel(ESRIMapDataModel model) Sets the model on the viewer.
void	setFormAction(java.lang.String action) Sets the FormAction for use on this object
void	setReportLinkingOn(boolean reportLinkingOn) Controls the display of the popup menu for report linking.
void	setReportLinkingText(java.lang.String reportLinkingText) Sets the text used for the report linking popup menu
void	setShowCrossing(boolean showCrossing) Sets whether the map should show crossing information underneath the map image.
void	setSize(int width, int height) This sets the size of the MapComponent.
void	write(java.io.PrintWriter out) Writes the component to the passed-in output stream.

Methods inherited from class com.sas.servlet.tbeans.graphics.BaseESRIMapChart

applyGraphStyle, getDataModel, getDefaultLayerVisibilities, getGraphModel, getImageLocation, getLayerVisibilities, getLegendImageMimeData, getLegendSize, getLocale, getMapExtents, getMapImageMimeData, getMapSize, getStyleMap, isAutoZoom, isDebug, isDisabledImage, isRedrawMap, isUseSession, setAutoZoom, setDebug, setDisabledImage, setGraphModel, setImageLocation, setLayerVisibilities, setLayerVisibility, setLocale, setMapExtents, setMapExtents, setRedrawMap, setStyleMap, setUseSavedMapExtents, setUseSession

Methods inherited from class com.sas.servlet.tbeans.BaseActionTransformation

dispose, getActionProvider, getActionSupportType, getUniqueId, isActionVisible, listActionTypes, listAreaTypes, setActionProvider, setActionSupportType, setActionVisible, setUniqueId

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getName, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCleanUpResourcesOn, setCustomAttributes, setDescription, setId, setInputTransform, setLocaleDependentProperties, setName, setObjectData, setObjectDataProperty, setOutputTransform, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Methods inherited from interface com.sas.servlet.tbeans.ComplexStyleInterface

getStyleMap

Methods inherited from interface com.sas.actionprovider.HttpActionProviderViewInterface

getRequest, setRequest

Constructor Detail

OLAPESRIMapChart

public OLAPESRIMapChart()

Constructs a new MapComponent Transformation Bean

Method Detail

performAction

public void performAction()

Do the real work for rendering a map. This method connects to the server, sets up the categorizations and the other settings on the map service, renders the map and legend, and stores them as MIME data.

printDebugInfo

public void printDebugInfo(ESRIMap myMap)

Prints debug information about the map, map service, OLAP config info, etc to the output log.

Specified by:

printDebugInfo in class BaseESRIMapChart

Parameters:

myMap - The ESRIMap to use.

write

public void write(java.io.PrintWriter out)
           throws java.io.IOException

Writes the component to the passed-in output stream.

Specified by:

write in interface TransformationInterface

Specified by:

write in interface com.sas.util.WriteToPrintWriterInterface

Overrides:

write in class BaseActionTransformation

Parameters:

out - The output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs

getPrintImage

public byte[] getPrintImage()

Creates an image suitable for printing, containing the map, the legend, and a text string for the measure combo box. The returned image is MIME data.

Returns:

A byte stream of MIME data containing the image

identify

public java.lang.String[] identify(int x,
                                   int y)

This method returns an array of Strings that represent the known information about the map feature found at the coordinate (x,y).

Parameters:

x - the x location

y - the y location

Returns:

an array of property values

setFormAction

public void setFormAction(java.lang.String action)

Sets the FormAction for use on this object

Parameters:

action -

getFormAction

public java.lang.String getFormAction()

Returns the FormAction used for this object

Returns:

Returns the FormAction used for this object

setDataModel

public void setDataModel(ESRIMapDataModel model)

Sets the model on the viewer.

Overrides:

setDataModel in class BaseESRIMapChart

Parameters:

model - an instance of the ESRIMapDataModel

See Also:

ESRIMapDataModel

setSize

public void setSize(int width,
                    int height)

This sets the size of the MapComponent. The overall size is then separated into parts for the map, measure ComboBox, and legend.

Overrides:

setSize in class BaseESRIMapChart

Parameters:

width - The chart width

height - The chart height

See Also:

BaseGraphics.setSize(int, int), BaseESRIMapChart.getMapSize(), BaseESRIMapChart.getLegendSize()

isShowCrossing

public boolean isShowCrossing()

Returns whether the map is currently displaying the crossing information.

Returns:

boolean whether the map is currently displaying the crossing information

See Also:

setShowCrossing(boolean)

setShowCrossing

public void setShowCrossing(boolean showCrossing)

Sets whether the map should show crossing information underneath the map image. The information is displayed as a series of labels underneath the main map image.

Parameters:

showCrossing -

getPopupModel

public java.util.List getPopupModel()

Builds the model for popup menu. Currently this is only used for report linking.

isReportLinkingOn

public boolean isReportLinkingOn()

Returns the visibility of the popup menu used for report linking.

Returns:

The visibility

See Also:

setReportLinkingOn(boolean)

setReportLinkingOn

public void setReportLinkingOn(boolean reportLinkingOn)

Controls the display of the popup menu for report linking.

Parameters:

reportLinkingOn -

See Also:

setReportLinkingOn(boolean)

getReportLinkingText

public java.lang.String getReportLinkingText()

Returns the text used for the report linking popup menu

Returns:

The text

See Also:

setReportLinkingText(String)

setReportLinkingText

public void setReportLinkingText(java.lang.String reportLinkingText)

Sets the text used for the report linking popup menu

Parameters:

reportLinkingText -

See Also:

getReportLinkingText()