ilog.views.maps.servlet
Class IlvFacesMapsServletSupport

java.lang.Object
  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

All Implemented Interfaces:

IlvFacesDiagrammerConstants, IlvDHTMLConstants, IlvDHTMLFrameworkConstants, IlvFacesConstants, IlvFrameworkConstants

public class IlvFacesMapsServletSupport
extends IlvFacesDiagrammerServletSupport

The IlvFacesMapsServletSupport class is an extension of the IlvFacesDiagrammerServletSupport that handles requests coming from the DHTML faces maps component.

Since:

JViews 8.0

Field Summary

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

ACTION_NAME, AUTO_REFRESH, BOUNDING_BOX, CONSTRAINED_ON_CONTENTS, INTERACTOR, INTERACTOR_ID, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, NB_BUTTONS, ORIENTATION, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, PAN_FACTOR, STATIC_LAYERS_COUNT, TILE_SIZE, VISIBLE_LAYERS, ZOOM_FACTOR, ZOOM_LEVELS

Fields inherited from interface ilog.views.faces.IlvFacesConstants

BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CORE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, ENABLED, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, GANTT_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_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, PROJECT, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

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

AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, 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, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE

Fields inherited from interface ilog.views.faces.IlvFacesConstants

BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CORE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, ENABLED, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, GANTT_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_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, PROJECT, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

IlvFacesMapsServletSupport()
Constructs an IlvFacesMapsServletSupport.

IlvFacesMapsServletSupport(javax.servlet.ServletContext context)
Constructs an IlvFacesMapsServletSupport by passing a ServletContext.

Method Summary

float	getDynamicJPEGQuality() Returns the JPEGQuality to be used for dynamic objects.
IlvManagerLayer[]	getDynamicLayers(javax.servlet.http.HttpServletRequest request, IlvManagerView view) Returns an array of IlvManagerLayer instances that are known to be dynamic. 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.
IlvManagerLayer[]	getLayers(javax.servlet.http.HttpServletRequest request, IlvManagerView view) Returns only the nonempty layers.
float	getStaticJPEGQuality() Returns the JPEGQuality used for static objects.
double[]	getZoomLevels(javax.servlet.http.HttpServletRequest request, IlvManagerView view) Returns the zoom levels that a client of this servlet should use to take advantage of the tiling and caching mechanisms. Overridden to read the scales specified in map file, if any.
boolean	handleRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is overridden to handle the "project" parameter.
protected boolean	isOverviewLayer(javax.servlet.http.HttpServletRequest request, IlvManagerLayer layer) Indicates if the specified layer is a visible layer in the overview.
protected void	prepareManagerView(javax.servlet.http.HttpServletRequest request, IlvManagerView view) This method is overridden to set the reference zoom of the view and to add support for IlvJComponentGraphic objects. This method has been overridden to configure the manager view for tiling.
void	setDynamicJPEGQuality(float dynamicJPEGQuality) Sets the JPEGQuality to be used for dynamic objects (the default value is 1).
void	setStaticJPEGQuality(float staticJPEGQuality) Sets the JPEGQuality used for static objects (the default value is 0.75).

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

additionalCapabilities, addJSFActionListeners, createPopupMenuSupport, createSelectionSupport, findFile, generateImage, 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, getManagerView, installImageMapAreaGenerator, isMultiSession, setDataURL, setDefaultStyleSheet, setDefaultXmlFile, setMultiSession, setStyleSheet, setXmlFile

Methods inherited from class ilog.views.servlet.IlvManagerServletSupport

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFacesMapsServletSupport

public IlvFacesMapsServletSupport()

Constructs an IlvFacesMapsServletSupport.

IlvFacesMapsServletSupport

public IlvFacesMapsServletSupport(javax.servlet.ServletContext context)

Constructs an IlvFacesMapsServletSupport by passing a ServletContext.

Parameters:

context - The ServletContext.

Method Detail

isOverviewLayer

protected boolean isOverviewLayer(javax.servlet.http.HttpServletRequest request,
                                  IlvManagerLayer layer)

Indicates if the specified layer is a visible layer in the overview. Layers visible in the overview are those associated with an IlvMapLayer and that have their IlvMapStyle.VISIBLE_IN_OVERVIEW style attribute set to true. Labeling layers are not visible in the overview.

Overrides:

isOverviewLayer in class IlvManagerServletSupport

Parameters:

request - The current HttpRequest.

layer - The layer to check.

Returns:

If true, the layer is visible in the overview, otherwise false.

See Also:

IlvManagerServletSupport.getLayers(HttpServletRequest, IlvManagerView)

prepareManagerView

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

This method is overridden to set the reference zoom of the view and to add support for IlvJComponentGraphic objects. This method has been overridden to configure the manager view for tiling.

Overrides:

prepareManagerView in class IlvFacesDiagrammerServletSupport

Parameters:

request - The current HTTP request.

view - The manager view.

Throws:

javax.servlet.ServletException

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.

Overrides:

getDynamicLayers in class IlvManagerServletSupport

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

getLayers

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

Returns only the nonempty layers.

Overrides:

getLayers in class IlvSDMServletSupport

Parameters:

request - The current HTTP request.

view - The manager view.

See Also:

IlvSDMServletSupport.getLayers(javax.servlet.http.HttpServletRequest, ilog.views.IlvManagerView)

getZoomLevels

public double[] getZoomLevels(javax.servlet.http.HttpServletRequest request,
                              IlvManagerView view)

Returns the zoom levels that a client of this servlet should use to take advantage of the tiling and caching mechanisms. This default implementation returns null. Overridden to read the scales specified in map file, if any.

Overrides:

getZoomLevels in class IlvManagerServletSupport

Parameters:

request - The current HTTP request.

view - The view returned by getManagerView().

Returns:

An array of double values or null if no zoom level is provided.

getDynamicJPEGQuality

public float getDynamicJPEGQuality()

Returns the JPEGQuality to be used for dynamic objects.

Returns:

The JPEGQuality used for dynamic objects.

setDynamicJPEGQuality

public void setDynamicJPEGQuality(float dynamicJPEGQuality)

Sets the JPEGQuality to be used for dynamic objects (the default value is 1).

Parameters:

dynamicJPEGQuality - The JPEGQuality to be used for dynamic objects.

getStaticJPEGQuality

public float getStaticJPEGQuality()

Returns the JPEGQuality used for static objects.

Returns:

The JPEGQuality used for static objects.

setStaticJPEGQuality

public void setStaticJPEGQuality(float staticJPEGQuality)

Sets the JPEGQuality used for static objects (the default value is 0.75).

Parameters:

staticJPEGQuality - The JPEGQuality to be used for static objects.

handleRequest

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

This method is overridden to handle the "project" parameter.

Overrides:

handleRequest in class IlvFacesDiagrammerServletSupport

Parameters:

request - The current HTTP request.

response - The HTTP response.

Returns:

false when the request is not recognized by this servlet.

Throws:

IOException

javax.servlet.ServletException

See Also:

IlvFacesDiagrammerServletSupport.handleRequest(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)