ilog.views.maps.servlet

Class IlvFacesGoogleViewServletSupport

java.lang.Object

ilog.views.util.servlet.IlvServletSupport

ilog.views.servlet.IlvManagerServletSupport

ilog.views.sdm.servlet.IlvSDMServletSupport

ilog.views.diagrammer.servlet.IlvDiagrammerServletSupport

ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServletSupport

ilog.views.maps.servlet.IlvFacesMapsServletSupport

ilog.views.maps.servlet.IlvFacesGoogleViewServletSupport

All Implemented Interfaces:

IlvFacesDiagrammerConstants, IlvDHTMLConstants, IlvDHTMLFrameworkConstants, IlvFacesConstants, IlvFrameworkConstants

public class IlvFacesGoogleViewServletSupport
extends IlvFacesMapsServletSupport

The IlvFacesGoogleViewServletSupport class is an extension of the IlvFacesMapsServletSupport that handles synchronization with a Google(TM) Map client side component.

Since:

JViews 8.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	GET_PROPERTIES Request parameter to retrieve a symbol properties
static String	ICON Request parameter to retrieve a symbol icon
static String	ID Request parameter to retrieve a symbol properties
static String	LIST Request parameter to retrieve the symbol list
static String	SELECTED_SYMBOL Request parameter that indicates that we want the selected icon
static String	SELECTION_TYPE Request parameter to retrieve the symbol list
static String	SET_PROPERTIES Request parameter to retrieve a symbol properties

Fields inherited from class ilog.views.servlet.IlvManagerServletSupport

ImageMapAreaGeneratorProperty

Fields inherited from interface ilog.views.diagrammer.faces.IlvFacesDiagrammerConstants

DASHBOARD_DIAGRAM, DATA_SOURCE, DATA_URL, DIAGRAMMER, EDITABLE, INPUT_XSL, OUTPUT_XSL, PARAM_CSS, PARAM_XML, PROPERTY_ACCESSOR, STYLE_SHEETS

Fields inherited from interface ilog.views.faces.dhtml.IlvDHTMLFrameworkConstants

SESSION_ID_PREFIX, STATE_URL, STATIC_LAYERS_COUNT_PARAM, TILE_MANAGER, UPDATE_INTERVAL

Fields inherited from interface ilog.views.faces.IlvFrameworkConstants

AUTO_REFRESH, BOUNDING_BOX, COLOR, CONSTRAINED_ON_CONTENTS, GROUPABLE, HITMAP_LAYERS, IGNORE_CONTENT_ASPECT_RATIO, INTERACTOR, INTERACTOR_ID, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, NB_BUTTONS, OPACITY, ORIENTATION, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, PAN_FACTOR, STATIC_LAYERS_COUNT, TEMPLATE, TILE_SIZE, TOLERANCE, VISIBLE_LAYERS, ZOOM_FACTOR, ZOOM_LEVELS

Fields inherited from interface ilog.views.faces.dhtml.IlvDHTMLConstants

ACCESSIBLE, ACTION_NAME, AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, HOTKEYS, IMAGE_FORMAT, IMAGE_LOADED_HANDLER, IMAGE_MAP_GENERATOR, IMAGE_MAP_GENERATOR_CLASS, IMAGE_MAP_VISIBLE, IMAGE_SERVLET_CONTEXT, INVOCATION_CONTEXT, JSF_CONTEXT, ON_CLICK, ON_SELECTION_CHANGED, PARTIAL_SUBMIT, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SELECTION_RESIZABLE_CLASS, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE

Fields inherited from interface ilog.views.faces.IlvFacesConstants

AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvFacesGoogleViewServletSupport(javax.servlet.ServletContext context) Creates a new GoogleServletSupport instance.

Method Summary

Modifier and Type	Method and Description
protected IlvHitmapSupport	createHitmapSupport() Returns the IlvFacesGoogleViewHitmapSupport.
protected IlvSelectionSupport	createSelectionSupport() Overrides IlvManagerServletSupport.createSelectionSupport() to return an IlvDiagrammerSelectionSupport selection support.
protected BufferedImage	generateImage(javax.servlet.http.HttpServletRequest request, IlvRect bbox, int width, int height, String[] requestedLayers, Color bgColor, boolean transparent) Generates the image.
IlvManagerLayer[]	getDynamicLayers(javax.servlet.http.HttpServletRequest request, IlvManagerView view) Returns an array of IlvManagerLayer instances that are known to be dynamic.
protected IlvCoordinate[]	getNodeLocation(IlvSDMEngine engine, IlvSDMNode obj) Method that computes the coordinate (marker) or set of coordinates (polylines) for an SDM node.
String	getNodeProperties(IlvSDMEngine engine, IlvSDMNode node) Returns a JSON string containing the properties of the node.
boolean	getSymbolIcon(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Sends an image for the symbol to the response output stream
boolean	getSymbolList(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Sends the list of symbols and their properties to the response output stream as JSON array
boolean	getSymbolProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Sends the list of symbols and their properties to the response output stream as JSON array
protected void	prepareManagerView(javax.servlet.http.HttpServletRequest request, IlvManagerView view) Specific for Google(TM): Do not keep aspect ratio because mercator tiles are higher than large
boolean	setSymbolProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Sets the properties changed client side and POSTed.
protected static IlvRect	transformBox(IlvRect bbox, IlvCoordinateTransformation ct) Transforms the latitude/longitude bounding box into view coordinates
protected IlvRect	transformCoordinates(javax.servlet.http.HttpServletRequest request, IlvRect bbox) Thransforms the given bbox from latitude/longitude to JViews manager coordinates.

Methods inherited from class ilog.views.maps.servlet.IlvFacesMapsServletSupport

getDynamicJPEGQuality, getLayers, getStaticJPEGQuality, getZoomLevels, handleRequest, isOverviewLayer, setDynamicJPEGQuality, setStaticJPEGQuality

Methods inherited from class ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServletSupport

additionalCapabilities, addJSFActionListeners, createPopupMenuSupport, findFile, getFacesContext, getImageMapAreaGenerator, getImageMapAreaGenerator, getLock, getMenuFactory, getSDMView, getTileManager, getValue, isSessionExpired, setDataSource, setValue, shouldGenerateImageMap

Methods inherited from class ilog.views.diagrammer.servlet.IlvDiagrammerServletSupport

getDefaultProject, getDiagrammer, initSDMView, setDefaultProject, setProject

Methods inherited from class ilog.views.sdm.servlet.IlvSDMServletSupport

getDataURL, getDefaultStyleSheet, getDefaultXmlFile, getImageMapAreaGenerator, getManagerView, installImageMapAreaGenerator, installImageMapAreaGenerator, isMultiSession, setDataURL, setDefaultStyleSheet, setDefaultXmlFile, setMultiSession, setStyleSheet, setXmlFile

Methods inherited from class ilog.views.servlet.IlvManagerServletSupport

additionalCapabilities, addServerActionListener, addServerActionListener, beforeDraw, encodeImage, generateImageWhenSessionExpired, getAdditionalCapabilities, getAntialiasing, getContentLengthEnable, getContext, getDefaultImageMapHREF, getExpirationDate, getGraphicObjectComparator, getHitmapSupport, getInternalLock, getJPEGQuality, getKey, getManagerBBox, getManagerLayerComparator, getMaxZoomLevel, getMinZoomLevel, getPopupMenuSupport, getSelectionSupport, isPopupEnabled, isSelectionEnabled, isVerbose, removeServerActionListener, removeServerActionListener, setAntialiasing, setContentLengthEnable, setImageResponseCachePolicy, setJPEGQuality, setPopupEnabled, setSelectionEnabled, setVerbose, useTileManager

Methods inherited from class ilog.views.util.servlet.IlvServletSupport

doGetScriptMessage, getParameterValidationListener, getScriptMessageSupport, setParameterValidationListener

Methods inherited from class java.lang.Object

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

Field Detail

SELECTED_SYMBOL

public static final String SELECTED_SYMBOL

Request parameter that indicates that we want the selected icon

See Also:

Constant Field Values

ICON

public static final String ICON

Request parameter to retrieve a symbol icon

See Also:

Constant Field Values

GET_PROPERTIES

public static final String GET_PROPERTIES

Request parameter to retrieve a symbol properties

See Also:

Constant Field Values

SET_PROPERTIES

public static final String SET_PROPERTIES

Request parameter to retrieve a symbol properties

See Also:

Constant Field Values

ID

public static final String ID

Request parameter to retrieve a symbol properties

See Also:

Constant Field Values

LIST

public static final String LIST

Request parameter to retrieve the symbol list

See Also:

Constant Field Values

SELECTION_TYPE

public static final String SELECTION_TYPE

Request parameter to retrieve the symbol list

See Also:

Constant Field Values

Constructor Detail

IlvFacesGoogleViewServletSupport

public IlvFacesGoogleViewServletSupport(javax.servlet.ServletContext context)

Creates a new GoogleServletSupport instance.

Parameters:

context - The servlet context.

Method Detail

createHitmapSupport

protected IlvHitmapSupport createHitmapSupport()

Returns the IlvFacesGoogleViewHitmapSupport.

Returns:

The IlvFacesGoogleViewHitmapSupport.

Since:

JViews 8.8

createSelectionSupport

protected IlvSelectionSupport createSelectionSupport()

Overrides IlvManagerServletSupport.createSelectionSupport() to return an IlvDiagrammerSelectionSupport selection support.

During the creation of this support, listeners to handle selection and move are installed.

Overrides:

createSelectionSupport in class IlvFacesDiagrammerServletSupport

Returns:

A selection servlet support.

See Also:

IlvFacesDiagrammerServletSupport.createSelectionSupport()

prepareManagerView

protected void prepareManagerView(javax.servlet.http.HttpServletRequest request,
                                  IlvManagerView view)
                           throws javax.servlet.ServletException

Specific for Google(TM): Do not keep aspect ratio because mercator tiles are higher than large

Overrides:

prepareManagerView in class IlvFacesMapsServletSupport

Parameters:

request - The current HTTP request.

view - The manager view.

Throws:

javax.servlet.ServletException

transformCoordinates

protected IlvRect transformCoordinates(javax.servlet.http.HttpServletRequest request,
                                       IlvRect bbox)

Thransforms the given bbox from latitude/longitude to JViews manager coordinates.

Parameters:

request - The http request.

bbox - The bbox in latitude/longitude.

Returns:

The bbox in JViews manager coordinates.

Since:

JViews 8.8

generateImage

protected BufferedImage generateImage(javax.servlet.http.HttpServletRequest request,
                                      IlvRect bbox,
                                      int width,
                                      int height,
                                      String[] requestedLayers,
                                      Color bgColor,
                                      boolean transparent)
                               throws javax.servlet.ServletException

Generates the image. You may override this method to add additional information on the generated image.

Overrides:

generateImage in class IlvFacesDiagrammerServletSupport

Parameters:

request - The current HTTP request.

bbox - The area of the manager to draw.

width - The width of the image.

height - The height of the image.

requestedLayers - An array of layer names to draw.

bgColor - The background color of the image

transparent - Indicates if the image should be transparent.

Throws:

javax.servlet.ServletException

See Also:

IlvFacesDiagrammerServletSupport.generateImage(javax.servlet.http.HttpServletRequest, ilog.views.IlvRect, int, int, java.lang.String[], java.awt.Color, boolean)

transformBox

protected static IlvRect transformBox(IlvRect bbox,
                                      IlvCoordinateTransformation ct)

Transforms the latitude/longitude bounding box into view coordinates

Parameters:

bbox - Bounding box decoded from request parameters

ct - Coordinate transformation

Returns:

The view coordinate rectangle

getSymbolIcon

public boolean getSymbolIcon(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws IOException

Sends an image for the symbol to the response output stream

Parameters:

request - The request It must contain the following parameters:

• "selectionType" with a value "icon"
• "id" parameter pointing to the correct SDM Symbol id
• (optionally) "selected". If present, this means we want the selected icon

response - The response where the PNG image will be streamed.

Returns:

true if the request succeeded.

Throws:

IOException

getSymbolList

public boolean getSymbolList(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws IOException,
                             javax.servlet.ServletException

Sends the list of symbols and their properties to the response output stream as JSON array

Parameters:

request - The request It must contain the following parameters:

• "selectionType" with a value "list"
• "bbox" parameter pointing to a lat/lon (in degrees) rectangle
• "layer" parameter pointing to list of symbol layers

response - The response where we will stream the JSON array where each member

Returns:

true if the request succeeded.

Throws:

IOException

javax.servlet.ServletException

See Also:

getNodeProperties(IlvSDMEngine, IlvSDMNode)

getSymbolProperties

public boolean getSymbolProperties(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
                            throws IOException

Sends the list of symbols and their properties to the response output stream as JSON array

Parameters:

request - The request It must contain the following parameters:

• "selectionType" with a value "properties"
• "id" parameter pointing to the correct SDM Symbol id

response - The response where the JSON list of properties for this symbol will be streamed.

Returns:

true if the request succeeded.

Throws:

IOException

See Also:

getNodeProperties(IlvSDMEngine, IlvSDMNode)

setSymbolProperties

public boolean setSymbolProperties(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
                            throws IOException,
                                   javax.servlet.ServletException

Sets the properties changed client side and POSTed.

Parameters:

request - The request It should be a "POST" request containing the following parameters:

• "selectionType" with a value "setProperties"
• "id" parameter pointing to the correct SDM Symbol id

It should also provide a data stream of the properties changes in the form acceptable by Properties.load(java.io.InputStream)

response - The response. Not used here.

Returns:

true if the request succeeded

Throws:

IOException

javax.servlet.ServletException

getNodeProperties

public String getNodeProperties(IlvSDMEngine engine,
                                IlvSDMNode node)

Returns a JSON string containing the properties of the node.

Parameters:

engine - The SDM engine. Used both to retrieve the model and to compute the node size.

node - The node.

Returns:

The JSON string of the node properties. this will contain :

• "sId", the SDM id
• "sWidth", the width of the graphical representation
• "sHeight", the height of the graphical representation
• "sTooltip", the tooltip selected
• "sLon", the longitude of symbol center or "sLons" the array of longitudes of the points
• "sLat", the latitude of symbol center or "sLats" the array of latitudes of the points
• "sLayer", the layer name
• "sColor", the color (for links)
• "sWeight", the width of the line (for links)
• "sProps", an array containing all SDM properties

getNodeLocation

protected IlvCoordinate[] getNodeLocation(IlvSDMEngine engine,
                                          IlvSDMNode obj)

Method that computes the coordinate (marker) or set of coordinates (polylines) for an SDM node.

Parameters:

engine - The engine where the object resides.

obj - The sdm object.

Returns:

The array of latitude/longitude coordinates in degrees.

getDynamicLayers

public IlvManagerLayer[] getDynamicLayers(javax.servlet.http.HttpServletRequest request,
                                          IlvManagerView view)

Returns an array of IlvManagerLayer instances that are known to be dynamic.

This implementation returns the layers that have an index greater or equal to the value returned by IlvManagerView.getTripleBufferedLayerCount().

Layers that have an associated IlvMapLayer and have a style that specifies the THIN_CLIENT_BACKGROUND property to false are also considered as dynamic layers. Layers that have an associated IlvMapLayer and have a style that specifies the THIN_CLIENT_BACKGROUND property as false are also considered as dynamic layers. Note: This method is overridden to prevent having links appear on Google(TM) maps as polygons because of a bug with large polygons.

Overrides:

getDynamicLayers in class IlvFacesMapsServletSupport

Parameters:

request - The current HttpServletRequest.

view - The IlvManagerView returned by getManagerView().

Returns:

An array containing all the dynamic layers or an empty array if no layer is dynamic.

See Also:

IlvManagerView.getTripleBufferedLayerCount()