netcharts.server.util
Class PortletPageCreator

java.lang.Object
  |
  +--netcharts.server.util.PageCreator
        |
        +--netcharts.server.util.PortletPageCreator

All Implemented Interfaces:

netcharts.server.util.PageCreator.Processor

public class PortletPageCreator

extends PageCreator

implements netcharts.server.util.PageCreator.Processor

Utility class for adding basic drill down and popup label capability to portlets.

Field Summary

static java.lang.String

DEFAULT_SERVLET_NAME

Fields inherited from class netcharts.server.util.PageCreator

ACCESSIBLE_IMAGE_PAGE, ACCESSIBLE_PAGE, ALT_VAR, DEFAULT_ALT_TEMPLATE, DEFAULT_URL, DRILLDOWN_PAGE, HEIGHT_VAR, IMAGE_PAGE, IMAGE_PARAMETER, MAP_VAR, MAPNAME_VAR, MIN_DRILLDOWN_PAGE, SRC_VAR, WIDTH_VAR

Method Summary

static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, boolean fullPage, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, boolean fullPage, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String defaultImageMapURL) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, boolean fullPage, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String defaultImageMapURL, boolean accessible, java.lang.String altTemplate, java.lang.String chartDescription) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, boolean fullPage, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String defaultImageMapURL, boolean accessible, java.lang.String altTemplate, java.lang.String chartDescription, java.lang.String encoding) Deprecated. Encoding is no longer needed, instead use getDrillDownPage(ServerGeneratedImage, boolean, PortletRequest, PortletResponse, String, boolean, String, String)
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String defaultImageMapURL) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String unencodedServletURL, boolean fullPage, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String unencodedServletURL, boolean fullPage, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String defaultImageMapURL) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String unencodedServletURL, boolean fullPage, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String defaultImageMapURL, boolean accessible, java.lang.String altTemplate, java.lang.String chartDescription) Get the HTML which allows drill down and popup labels on the given chart.
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String unencodedServletURL, boolean fullPage, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String defaultImageMapURL, boolean accessible, java.lang.String altTemplate, java.lang.String chartDescription, java.lang.String encoding) Deprecated. Encoding is no longer used, instead use getDrillDownPage(ServerGeneratedImage, String, boolean, PortletRequest, PortletResponse, String, boolean, String, String)
static java.lang.String	getDrillDownPage(ServerGeneratedImage chart, java.lang.String unencodedServletURL, boolean fullPage, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String defaultImageMapURL, java.lang.String encoding) Deprecated. Encoding is no longer needed, instead use getDrillDownPage(ServerGeneratedImage, String, boolean, PortletRequest, PortletResponse, String)
static java.lang.String	getImagePage(ServerGeneratedImage chart, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, boolean accessible, java.lang.String chartDescription) Get the HTML which only shows the image of the given chart.
static java.lang.String	getImagePage(ServerGeneratedImage chart, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, boolean accessible, java.lang.String chartDescription, java.lang.String encoding) Deprecated. Encoding is no longer needed, instead use getImagePage(ServerGeneratedImage, PortletRequest, PortletResponse, boolean, String)
static java.lang.String	getImagePage(ServerGeneratedImage chart, java.lang.String unencodedServletURL, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, boolean accessible, java.lang.String chartDescription) Get the HTML which only shows the image of the given chart.
static java.lang.String	getImagePage(ServerGeneratedImage chart, java.lang.String unencodedServletURL, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, boolean accessible, java.lang.String chartDescription, java.lang.String encoding) Deprecated. Encoding is no longer needed, instead use getImagePage(ServerGeneratedImage, String, PortletRequest, PortletResponse, boolean, String)
static java.lang.String	getUnencodedServletName(javax.portlet.PortletRequest request)
static java.lang.String	getUnencodedServletNameWithSessionId(javax.portlet.PortletRequest request)
void	process(ServerGeneratedImage chart, java.lang.String imgSRC, boolean fullPage, java.lang.String defaultImageMapURL, java.lang.Object arg)

Methods inherited from class netcharts.server.util.PageCreator

getDrillDownPage, getDrillDownPage, getDrillDownPage, getDrillDownPage, getDrillDownPage, getDrillDownPage, getImagePage, getImagePage, getRolloverJavaScript

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SERVLET_NAME

public static java.lang.String DEFAULT_SERVLET_NAME

Method Detail

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the default servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                boolean fullPage,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the default servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                boolean fullPage,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response,
                                                java.lang.String defaultImageMapURL)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the default servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                boolean fullPage,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response,
                                                java.lang.String defaultImageMapURL,
                                                boolean accessible,
                                                java.lang.String altTemplate,
                                                java.lang.String chartDescription,
                                                java.lang.String encoding)

Deprecated. Encoding is no longer needed, instead use getDrillDownPage(ServerGeneratedImage, boolean, PortletRequest, PortletResponse, String, boolean, String, String)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the default servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

accessible - Whether accessibility features (like alt tags) should be used in the drill down page instead of javascript based popup labels

altTemplate - The text template used to construct alt tags on the active regions of a drill down image (map area tags).

chartDescription - The description to be used in the alt tag on chart images.

encoding - The encoding used by the server to convert Strings to bytes.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                boolean fullPage,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response,
                                                java.lang.String defaultImageMapURL,
                                                boolean accessible,
                                                java.lang.String altTemplate,
                                                java.lang.String chartDescription)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. By default the browser will ask the default servlet for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

accessible - Whether accessibility features (like alt tags) should be used in the drill down page instead of javascript based popup labels

altTemplate - The text template used to construct alt tags on the active regions of a drill down image (map area tags).

chartDescription - The description to be used in the alt tag on chart images.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response,
                                                java.lang.String defaultImageMapURL)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object.

Parameters:

chart - The chart to convert to an image.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String unencodedServletURL,
                                                boolean fullPage,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. The browser will ask the servlet specifed in the servletName parameter for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

servletName - The servlet the browser should ask for the image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart. data after it reads the HTML.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String unencodedServletURL,
                                                boolean fullPage,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response,
                                                java.lang.String defaultImageMapURL)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. The browser will ask the servlet specifed in the servletName parameter for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

servletName - The servlet the browser should ask for the image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart. data after it reads the HTML.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String unencodedServletURL,
                                                boolean fullPage,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response,
                                                java.lang.String defaultImageMapURL,
                                                java.lang.String encoding)

Deprecated. Encoding is no longer needed, instead use getDrillDownPage(ServerGeneratedImage, String, boolean, PortletRequest, PortletResponse, String)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. The browser will ask the servlet specifed in the servletName parameter for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

servletName - The servlet the browser should ask for the image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

encoding - The encoding used by the server to convert Strings to bytes.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart. data after it reads the HTML.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String unencodedServletURL,
                                                boolean fullPage,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response,
                                                java.lang.String defaultImageMapURL,
                                                boolean accessible,
                                                java.lang.String altTemplate,
                                                java.lang.String chartDescription,
                                                java.lang.String encoding)

Deprecated. Encoding is no longer used, instead use getDrillDownPage(ServerGeneratedImage, String, boolean, PortletRequest, PortletResponse, String, boolean, String, String)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. The browser will ask the servlet specifed in the servletName parameter for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

servletName - The servlet the browser should ask for the image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

accessible - Whether accessibility features (like alt tags) should be used in the drill down page instead of javascript based popup labels

altTemplate - The text template used to construct alt tags on the active regions of a drill down image (map area tags).

chartDescription - The description to be used in the alt tag on chart images.

encoding - The encoding used by the server to convert Strings to bytes.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart. data after it reads the HTML.

getDrillDownPage

public static java.lang.String getDrillDownPage(ServerGeneratedImage chart,
                                                java.lang.String unencodedServletURL,
                                                boolean fullPage,
                                                javax.portlet.PortletRequest request,
                                                javax.portlet.PortletResponse response,
                                                java.lang.String defaultImageMapURL,
                                                boolean accessible,
                                                java.lang.String altTemplate,
                                                java.lang.String chartDescription)

Get the HTML which allows drill down and popup labels on the given chart. This should be written to the browser via the response object. The browser will ask the servlet specifed in the servletName parameter for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

servletName - The servlet the browser should ask for the image.

fullPage - Specifies whether or not to return the full HTML code or just the image related elements only.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

defaultImageMapURL - The URL to use when creating imagemap HREF attributes.

accessible - Whether accessibility features (like alt tags) should be used in the drill down page instead of javascript based popup labels

altTemplate - The text template used to construct alt tags on the active regions of a drill down image (map area tags).

chartDescription - The description to be used in the alt tag on chart images.

Returns:

A String containing HTML which supports drill down and popup labels on an image of the given chart. data after it reads the HTML.

getImagePage

public static java.lang.String getImagePage(ServerGeneratedImage chart,
                                            javax.portlet.PortletRequest request,
                                            javax.portlet.PortletResponse response,
                                            boolean accessible,
                                            java.lang.String chartDescription,
                                            java.lang.String encoding)

Deprecated. Encoding is no longer needed, instead use getImagePage(ServerGeneratedImage, PortletRequest, PortletResponse, boolean, String)

Get the HTML which only shows the image of the given chart. This should be written to the browser via the response object. The browser will ask the servlet specifed in the servletName parameter for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

accessible - Whether accessibility features (like alt tags) should be used in the page.

chartDescription - The description to be used in the alt tag on chart images.

encoding - The encoding used by the server to convert Strings to bytes.

Returns:

A String containing HTML which only shows the image of the given chart.

getImagePage

public static java.lang.String getImagePage(ServerGeneratedImage chart,
                                            javax.portlet.PortletRequest request,
                                            javax.portlet.PortletResponse response,
                                            boolean accessible,
                                            java.lang.String chartDescription)

Get the HTML which only shows the image of the given chart. This should be written to the browser via the response object. The browser will ask the servlet specifed in the servletName parameter for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

accessible - Whether accessibility features (like alt tags) should be used in the page.

chartDescription - The description to be used in the alt tag on chart images.

Returns:

A String containing HTML which only shows the image of the given chart.

getImagePage

public static java.lang.String getImagePage(ServerGeneratedImage chart,
                                            java.lang.String unencodedServletURL,
                                            javax.portlet.PortletRequest request,
                                            javax.portlet.PortletResponse response,
                                            boolean accessible,
                                            java.lang.String chartDescription,
                                            java.lang.String encoding)

Deprecated. Encoding is no longer needed, instead use getImagePage(ServerGeneratedImage, String, PortletRequest, PortletResponse, boolean, String)

Get the HTML which only shows the image of the given chart. This should be written to the browser via the response object. The browser will ask the servlet specifed in the servletName parameter for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

servletName - The servlet the browser should ask for the image.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

accessible - Whether accessibility features (like alt tags) should be used in the page.

chartDescription - The description to be used in the alt tag on chart images.

encoding - The encoding used by the server to convert Strings to bytes.

Returns:

A String containing HTML which only shows the image of the given chart.

getImagePage

public static java.lang.String getImagePage(ServerGeneratedImage chart,
                                            java.lang.String unencodedServletURL,
                                            javax.portlet.PortletRequest request,
                                            javax.portlet.PortletResponse response,
                                            boolean accessible,
                                            java.lang.String chartDescription)

Get the HTML which only shows the image of the given chart. This should be written to the browser via the response object. The browser will ask the servlet specifed in the servletName parameter for the image data after it reads the HTML.

Parameters:

chart - The chart to convert to an image.

servletName - The servlet the browser should ask for the image.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

accessible - Whether accessibility features (like alt tags) should be used in the page.

chartDescription - The description to be used in the alt tag on chart images.

Returns:

A String containing HTML which only shows the image of the given chart.

getUnencodedServletName

public static java.lang.String getUnencodedServletName(javax.portlet.PortletRequest request)

getUnencodedServletNameWithSessionId

public static java.lang.String getUnencodedServletNameWithSessionId(javax.portlet.PortletRequest request)

process

public void process(ServerGeneratedImage chart,
                    java.lang.String imgSRC,
                    boolean fullPage,
                    java.lang.String defaultImageMapURL,
                    java.lang.Object arg)

Specified by:

process in interface netcharts.server.util.PageCreator.Processor