ilog.views.chart.faces.servlet

Class IlvFacesChartServletSupport

java.lang.Object

ilog.views.util.servlet.IlvServletSupport

ilog.views.chart.servlet.IlvChartServletSupport

ilog.views.chart.faces.servlet.IlvFacesChartServletSupport

All Implemented Interfaces:

IlvChartConstants, IlvFacesConstants

public class IlvFacesChartServletSupport
extends IlvChartServletSupport
implements IlvChartConstants, IlvFacesConstants

A IlvChart servlet that implements useful predefined actions and methods.

Since:

JViews 6.0

Field Summary

Fields inherited from class ilog.views.chart.servlet.IlvChartServletSupport

ACTION_PARAM, AREA_COMPONENT, BG_COLOR_PARAM, CAP_FORMAT_PARAM, CAPABILITIES_REQUEST, CHART_COMPONENT, COMPONENT_PARAM, HITMAP_REQUEST, HTML_CAP_FORMAT, IMAGE_FORMAT_PARAM, IMAGE_REQUEST, IMAGEMAP_NAME, IMAGEMAP_REQUEST, JPEG_IMAGE_FORMAT, JSON_CAP_FORMAT, LEGEND_COMPONENT, OCTET_CAP_FORMAT, OVERVIEW_COMPONENT, PNG_IMAGE_FORMAT, REQUEST_PARAM, VALID_CAP_FORMATS, VALID_COMPONENTS, VERBOSE_PARAM, X_MAX_PARAM, X_MIN_PARAM, Y_MAX_PARAM, Y_MIN_PARAM

Fields inherited from interface ilog.views.chart.faces.IlvChartConstants

AUTO_REFRESH, CHART, DATA_SOURCE, DATA_SOURCE_ID, DATABASE_DRIVER, DATABASE_PASSWORD, DATABASE_QUERY, DATABASE_RESULT_SET, DATABASE_URL, DATABASE_USER, FILENAME, INTERACTOR, INTERACTOR_ID, ITEM_PICKING, KEEP_VISIBLE_WINDOW, LABEL_COLUMN_MAPPING, LAYOUT, LEGEND_LAYOUT, MESSAGEBOX, NEAREST_ITEM_PICKING, NEAREST_POINT_PICKING, OVERVIEW_ACTION_NAME, PAN_ACTION_NAME, PICKING_MODE, REFRESH_DATA, SESSION_ID_PREFIX, STATE_URL, STYLE_SHEET, STYLE_SHEETS, TYPE, UPDATE_INTERVAL, X_COLUMN_MAPPING, X_PAN_ALLOWED, X_ZOOM_ALLOWED, X_ZOOM_FACTOR, Y_COLUMN_MAPPING, Y_PAN_ALLOWED, Y_ZOOM_ALLOWED, Y_ZOOM_FACTOR, ZOOM_ACTION_NAME

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
IlvFacesChartServletSupport() Constructs an IlvFacesChartServletSupport.

Method Summary

Modifier and Type	Method and Description
void	addOverviewAction() Add a default server side overview action.
void	addPanAction() Add a default server side pan action.
void	addSelectAction() Adds a default server side selection action.
void	addZoomAction() Add a default server side zoom action.
protected IlvChart	createChart() Creates the chart instance that will generate the view to display.
protected IlvLegend	createLegend() Creates the chart legend instance.
protected IlvPopupMenuServletSupport	createPopupMenuSupport() Creates a new instance of pop-up menu servlet support.
protected BufferedImage	generateImageCT(IlvServletRequestParameters params, IlvChart chart, String compName, int width, int height) Generates the requested image.
protected IlvChart	getChart(IlvServletRequestParameters params) Returns the chart instance that will generate the view to display.
protected jakarta.faces.context.FacesContext	getFacesContext(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Returns an artificial faces context to retrieve value bindings, or null if no faces context is attached to this thread.
protected jakarta.faces.context.FacesContext	getFacesContext(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean forceCreation) Returns an artificial faces context to retrieve value bindings.
protected IlvIMapDefinition	getIMapDefinition(IlvServletRequestParameters params, IlvChart chart) Returns the IlvIMapDefinition used by the IlvImageMapBuilder to generate the image map tags.
protected IlvLegend	getLegend(IlvServletRequestParameters params) Returns the chart legend instance to display.
protected IlvMenuFactory	getMenuFactory(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Retrieves or creates the menu factory used in this pop-up menu request.
protected IlvChart	getOverview(jakarta.servlet.http.HttpServletRequest req) Returns the chart overview instance from the session.
protected IlvChart	getOverview(jakarta.servlet.http.HttpSession session, String id) Returns the chart overview instance from the session.
protected IlvChart	getOverviewChart(IlvServletRequestParameters params) Returns the chart overview instance to display.
boolean	handleRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) This method overrides the handleRequest method of the IlvChartServletSupport.
protected boolean	isSessionExpired(jakarta.servlet.http.HttpServletRequest request) Returns true if the session has expired between two requests.
void	setDataSource(jakarta.servlet.http.HttpServletRequest request, String source) Sets the specified data source to the chart.
void	setLegendLayout(jakarta.servlet.http.HttpServletRequest request, String layout) Sets the legend layout of the legend view.
void	setProject(jakarta.servlet.http.HttpServletRequest request, String project) Sets the project passed as parameter.
void	setStyleSheet(jakarta.servlet.http.HttpServletRequest request, String styleSheet) Apply a stylesheet
void	setStyleSheets(jakarta.servlet.http.HttpServletRequest request, String styleSheets) Apply the stylesheets

Methods inherited from class ilog.views.chart.servlet.IlvChartServletSupport

additionalBinaryCapabilities, additionalOverviewBinaryCapabilities, additionalOverviewTextCapabilities, additionalTextCapabilities, addServerAction, createImageMapBuilder, executeAction, generateImageAWT, generateMapAreaTags, getAdditionalCapabilities, getAdditionalOverviewCapabilities, getConfigParameters, getContext, getHitmapSupport, getImageEncoder, getPopupMenuSupport, getRequestedVisibleWindow, getServlet, isPopupEnabled, isVerbose, prepareChart, prepareOverviewChart, prepareVisibleWindow, removeServerAction, setConfigParameters, setImageEncoder, setPopupEnabled, setServlet, toChartArea, toChartArea, toRefComp, toRefComp

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

Constructor Detail

IlvFacesChartServletSupport

public IlvFacesChartServletSupport()

Constructs an IlvFacesChartServletSupport. This constructor registers an IlvZoomAction, an IlvPanAction and an IlvOverviewAction.

Method Detail

getFacesContext

protected jakarta.faces.context.FacesContext getFacesContext(jakarta.servlet.http.HttpServletRequest request,
                                                             jakarta.servlet.http.HttpServletResponse response)

Returns an artificial faces context to retrieve value bindings, or null if no faces context is attached to this thread.

Parameters:

request - The HTTP request.

response - The HTTP response.

Returns:

A faces context instance or null.

Since:

JViews 7.5

getFacesContext

protected jakarta.faces.context.FacesContext getFacesContext(jakarta.servlet.http.HttpServletRequest request,
                                                             jakarta.servlet.http.HttpServletResponse response,
                                                             boolean forceCreation)

Returns an artificial faces context to retrieve value bindings.

Parameters:

request - The HTTP request.

response - The HTTP response.

forceCreation - Force creation of faces context even if FacesContext.getCurrentInstance() does not return nulll.

Returns:

A faces context instance or null.

Since:

JViews 7.5

getIMapDefinition

protected IlvIMapDefinition getIMapDefinition(IlvServletRequestParameters params,
                                              IlvChart chart)

Returns the IlvIMapDefinition used by the IlvImageMapBuilder to generate the image map tags. The default implementation returns null, meaning an empty image map.

Overrides:

getIMapDefinition in class IlvChartServletSupport

See Also:

IlvChartServletSupport.createImageMapBuilder(ilog.views.chart.servlet.IlvServletRequestParameters, ilog.views.chart.IlvChart)

createPopupMenuSupport

protected IlvPopupMenuServletSupport createPopupMenuSupport()

Creates a new instance of pop-up menu servlet support.

Overrides:

createPopupMenuSupport in class IlvChartServletSupport

Returns:

A new pop-up menu support.

addSelectAction

public void addSelectAction()

Adds a default server side selection action. This method is called by the IlvFacesChartServletSupport at construction time. This method calls addServerAction(IlvFacesChartSelectAction.ACTION_NAME, new IlvFacesChartSelectAction());.

Since:

JViews 7.5

addZoomAction

public void addZoomAction()

Add a default server side zoom action. This method is called by the IlvFacesChartServletSupport at construction time. This method calls addServerAction(ZOOM_ACTION_NAME, new IlvZoomAction())

addPanAction

public void addPanAction()

Add a default server side pan action. This method is called by the IlvFacesChartServletSupport at construction time. This method calls addServerAction(PAN_ACTION_NAME, new IlvPanAction())

addOverviewAction

public void addOverviewAction()

Add a default server side overview action. This method is called by the IlvFacesChartServletSupport at construction time. This method calls addServerAction(OVERVIEW_ACTION_NAME, new IlvOverviewAction())

getMenuFactory

protected IlvMenuFactory getMenuFactory(jakarta.servlet.http.HttpServletRequest request,
                                        jakarta.servlet.http.HttpServletResponse response)
                                 throws jakarta.servlet.ServletException

Retrieves or creates the menu factory used in this pop-up menu request.

Parameters:

request - The http request.

response - The http response.

Returns:

The factory that will generate the requested pop-up menu.

Throws:

jakarta.servlet.ServletException

Since:

JViews 7.5

handleRequest

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

This method overrides the handleRequest method of the IlvChartServletSupport.

Overrides:

handleRequest in class IlvChartServletSupport

Parameters:

request - The current HTTP request.

response - The HTTP response.

Returns:

true if a recognized request was handled successfully or false if the request type was not recognized. The recognized request types are IlvChartServletSupport.IMAGE_REQUEST, IlvChartServletSupport.IMAGEMAP_REQUEST and IlvChartServletSupport.CAPABILITIES_REQUEST. An exception is thrown if a recognized request is not handled successfully.

Throws:

IOException - If an input or output error is detected when the servlet handles the request.

jakarta.servlet.ServletException - If the request could not be handled.

createChart

protected IlvChart createChart()

Creates the chart instance that will generate the view to display.

Returns:

The chart instance to display.

getChart

protected IlvChart getChart(IlvServletRequestParameters params)
                     throws jakarta.servlet.ServletException

Returns the chart instance that will generate the view to display.

Specified by:

getChart in class IlvChartServletSupport

Parameters:

params - The request parameters.

Throws:

jakarta.servlet.ServletException

getOverviewChart

protected IlvChart getOverviewChart(IlvServletRequestParameters params)
                             throws jakarta.servlet.ServletException

Returns the chart overview instance to display.

Overrides:

getOverviewChart in class IlvChartServletSupport

Parameters:

params - The request parameters.

Returns:

The chart instance used to render the overview.

Throws:

jakarta.servlet.ServletException

getLegend

protected IlvLegend getLegend(IlvServletRequestParameters params)
                       throws jakarta.servlet.ServletException

Returns the chart legend instance to display.

Overrides:

getLegend in class IlvChartServletSupport

Parameters:

params - The request parameters.

Throws:

jakarta.servlet.ServletException

createLegend

protected IlvLegend createLegend()

Creates the chart legend instance.

Returns:

The legend instance.

getOverview

protected IlvChart getOverview(jakarta.servlet.http.HttpServletRequest req)

Returns the chart overview instance from the session.

Parameters:

req - The http servlet request.

Returns:

The overview chart object.

getOverview

protected IlvChart getOverview(jakarta.servlet.http.HttpSession session,
                               String id)

Returns the chart overview instance from the session.

Parameters:

session - The HTTP session.

id - The ID of the chart overview to retrieve.

Returns:

The overview chart object.

setStyleSheets

public void setStyleSheets(jakarta.servlet.http.HttpServletRequest request,
                           String styleSheets)

Apply the stylesheets

Parameters:

request - The HTTP request.

styleSheets - The stylesheets to apply.

setStyleSheet

public void setStyleSheet(jakarta.servlet.http.HttpServletRequest request,
                          String styleSheet)

Apply a stylesheet

Parameters:

request - The HTTP request.

styleSheet - The stylesheet to apply.

Since:

JViews 6.5

setDataSource

public void setDataSource(jakarta.servlet.http.HttpServletRequest request,
                          String source)

Sets the specified data source to the chart.

Parameters:

request - The HTTP request

source - The data source ID.

setProject

public void setProject(jakarta.servlet.http.HttpServletRequest request,
                       String project)

Sets the project passed as parameter.

Parameters:

request - The http request.

project - The project URL.

Since:

JViews 6.5

setLegendLayout

public void setLegendLayout(jakarta.servlet.http.HttpServletRequest request,
                            String layout)

Sets the legend layout of the legend view.

Parameters:

request - The HTTP request.

layout - The desired layout. Valid values are "vertical" or "horizontal"

isSessionExpired

protected boolean isSessionExpired(jakarta.servlet.http.HttpServletRequest request)

Returns true if the session has expired between two requests.

Parameters:

request - The HTTP request.

Since:

JViews 6.5

generateImageCT

protected BufferedImage generateImageCT(IlvServletRequestParameters params,
                                        IlvChart chart,
                                        String compName,
                                        int width,
                                        int height)
                                 throws jakarta.servlet.ServletException

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

Overrides:

generateImageCT in class IlvChartServletSupport

Parameters:

params - The parameters parsed from the request.

chart - The chart to be displayed.

compName - The name of the component of the chart that shall be displayed.

width - The requested width of the image.

height - The requested height of the image.

Throws:

jakarta.servlet.ServletException