netcharts.server.api
Class NSPortletToolKit

java.lang.Object
  |
  +--netcharts.server.api.NSToolKit
        |
        +--netcharts.server.api.NSPortletToolKit

public class NSPortletToolKit

extends NSToolKit

Extends NSToolkit and provides methods to simplify the display of charts via portlets.

Fields inherited from class netcharts.server.api.NSToolKit

PARAM_NODATA_MESSAGE, PROJECTS, TOOLKIT_USER_AGENT

Constructor Summary

NSPortletToolKit()
Constructs a local toolkit with no communication information and no security credentials.

NSPortletToolKit(java.lang.String projectName)
Constructs a local toolkit with no security credentials.

NSPortletToolKit(java.lang.String serverName, int portNumber, java.lang.String projectName)
Constructs a toolkit with communication information and no security credentials.

NSPortletToolKit(java.lang.String serverName, int portNumber, java.lang.String projectName, java.lang.String userName, java.lang.String userPassword)
Constructs a toolkit with communication information and security credentials.

NSPortletToolKit(java.lang.String serverName, int portNumber, java.lang.String projectName, java.lang.String userName, java.lang.String userPassword, boolean secure)
Constructs a toolkit with communication information and security credentials.

NSPortletToolKit(java.lang.String projectName, java.lang.String userName, java.lang.String userPassword)
Constructs a local toolkit with security credentials.

Method Summary

java.lang.String	getChartAsImageAndMap(java.lang.String chartFile, java.util.Hashtable variables, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, boolean includeJavaScript) Retrieves a chart and returns the HTML tags representing the chart and imagemap.
java.lang.String	getChartAsImageAndMap(java.lang.String chartFile, java.util.Hashtable variables, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, boolean includeJavaScript, java.lang.String defaultHREF) Retrieves a chart and returns the HTML tags representing the chart and imagemap.
java.lang.String	getChartAsImageAndMap(java.lang.String chartFile, java.util.Hashtable variables, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, boolean includeJavaScript, java.lang.String defaultHREF, java.lang.String returnPath)
java.lang.String	getChartAsImageTag(java.lang.String chartFile, java.util.Hashtable variables, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response) Retrieves a chart and returns the HTML <img> tag representing the chart.

Methods inherited from class netcharts.server.api.NSToolKit

getAccessibilityMode, getAMActiveLabelTextTemplate, getAMChartDescription, getChart, getChart, getChartPage, getChartPage, getDataCacheEntry, getDataCacheEntryAsNCXML, getDataCacheEntryAsResultSet, getEncoding, getNDSData, getNDSDataAsCSV, getNDSDataAsNCXML, getNDSDataAsResultSet, getNDSDataAsVector, getPDFReport, getPDFTable, getProject, getRolloverJavaScript, getServer, getServerGeneratedTable, getServerGeneratedTable, getServerPort, getServerReply, getTable, getTable, getUserAgent, purgeDataCache, putDataCacheEntry, putDataCacheEntry, putDataCacheEntry, putDataCacheEntry, removeDataCacheEntry, removeHeader, setAccessibilityMode, setAMActiveLabelTextTemplate, setAMChartDescription, setEncoding, setHeader, setProject, setServerInfo, setServerName, setServerPort, setUserAgent, setUserCredentials

Methods inherited from class java.lang.Object

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

Constructor Detail

NSPortletToolKit

public NSPortletToolKit()

Constructs a local toolkit with no communication information and no security credentials.

NSPortletToolKit

public NSPortletToolKit(java.lang.String projectName)

Constructs a local toolkit with no security credentials.

Parameters:

projectName - The project within NetCharts Server to access files.

NSPortletToolKit

public NSPortletToolKit(java.lang.String projectName,
                        java.lang.String userName,
                        java.lang.String userPassword)

Constructs a local toolkit with security credentials.

Parameters:

projectName - The project within NetCharts Server to access files.

userName - The name of a NetCharts Server user with proper security credentials.

userPassword - The password of a NetCharts Server user with proper security credentials.

NSPortletToolKit

public NSPortletToolKit(java.lang.String serverName,
                        int portNumber,
                        java.lang.String projectName)

Constructs a toolkit with communication information and no security credentials.

Parameters:

serverName - The name of the server.

portNumber - The port of the server.

projectName - The project to consider the root directory of the server files.

NSPortletToolKit

public NSPortletToolKit(java.lang.String serverName,
                        int portNumber,
                        java.lang.String projectName,
                        java.lang.String userName,
                        java.lang.String userPassword)

Constructs a toolkit with communication information and security credentials.

Parameters:

serverName - The name of the server.

portNumber - The port of the server.

projectName - The project to consider the root directory of the server files.

userName - The name of a user with proper security credentials.

userPassword - The password of a user with proper security credentials.

NSPortletToolKit

public NSPortletToolKit(java.lang.String serverName,
                        int portNumber,
                        java.lang.String projectName,
                        java.lang.String userName,
                        java.lang.String userPassword,
                        boolean secure)

Constructs a toolkit with communication information and security credentials.

Parameters:

serverName - The name of the server.

portNumber - The port of the server.

projectName - The project to consider the root directory of the server files.

userName - The name of a user with proper security credentials.

userPassword - The password of a user with proper security credentials.

secure - Whether we are connected to a SSL based port.

Method Detail

getChartAsImageTag

public java.lang.String getChartAsImageTag(java.lang.String chartFile,
                                           java.util.Hashtable variables,
                                           javax.portlet.PortletRequest request,
                                           javax.portlet.PortletResponse response)
                                    throws java.lang.IllegalArgumentException,
                                           NSToolKitException

Retrieves a chart and returns the HTML <img> tag representing the chart.

Parameters:

chartFile - The specified chart template to retrieve.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

Returns:

The HTML tags to include the chart image in the page.

getChartAsImageAndMap

public java.lang.String getChartAsImageAndMap(java.lang.String chartFile,
                                              java.util.Hashtable variables,
                                              javax.portlet.PortletRequest request,
                                              javax.portlet.PortletResponse response,
                                              boolean includeJavaScript)
                                       throws java.lang.IllegalArgumentException,
                                              NSToolKitException

Retrieves a chart and returns the HTML tags representing the chart and imagemap.

Parameters:

chartFile - The specified chart template to retrieve.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

includeJavaScript - Whether or not to include the JavaScript for chart interaction with the returned tags.

Returns:

The HTML tags and image related code to include the chart image in the page.

getChartAsImageAndMap

public java.lang.String getChartAsImageAndMap(java.lang.String chartFile,
                                              java.util.Hashtable variables,
                                              javax.portlet.PortletRequest request,
                                              javax.portlet.PortletResponse response,
                                              boolean includeJavaScript,
                                              java.lang.String defaultHREF)
                                       throws java.lang.IllegalArgumentException,
                                              NSToolKitException

Retrieves a chart and returns the HTML tags representing the chart and imagemap.

Parameters:

chartFile - The specified chart template to retrieve.

request - The current request handed to the portlet.

response - The current response handed to the portlet.

includeJavaScript - Whether or not to include the JavaScript for chart interaction with the returned tags.

defaultHREF - The URL to place in the HREF attribute of the imagemap <area> tags if no URL has been configured.

Returns:

The HTML tags and image related code to include the chart image in the page.

getChartAsImageAndMap

public java.lang.String getChartAsImageAndMap(java.lang.String chartFile,
                                              java.util.Hashtable variables,
                                              javax.portlet.PortletRequest request,
                                              javax.portlet.PortletResponse response,
                                              boolean includeJavaScript,
                                              java.lang.String defaultHREF,
                                              java.lang.String returnPath)
                                       throws java.lang.IllegalArgumentException,
                                              NSToolKitException