org.rhq.enterprise.gui.common.servlet
Class MetricChartServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.rhq.enterprise.gui.common.servlet.ParameterizedServlet
              org.rhq.enterprise.gui.common.servlet.ImageServlet
                  org.rhq.enterprise.gui.common.servlet.ChartServlet
                      org.rhq.enterprise.gui.common.servlet.VerticalChartServlet
                          org.rhq.enterprise.gui.common.servlet.MetricChartServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class MetricChartServlet
extends VerticalChartServlet

Extends ChartServlet to graph one or more metrics. By default, showPeak, showHighRange, showValues, showAverage, showLowRange, showLow and showBaseline are all true.

Additional parameters are as follows (any required parameters are in italics):

key	value
chartDataKey	<string>
showEvents	(false | true)

The chartDataKey will be used to retrieve the chart data from the session. Once it is pulled, it will be removed from the session.

See Also:

Serialized Form

Field Summary

static String	CHART_DATA_KEY_PARAM Request parameter for the chart data key session attribute.
static String	SHOW_EVENTS_PARAM Request parameter for whether or not to show control actions.

Fields inherited from class org.rhq.enterprise.gui.common.servlet.VerticalChartServlet

COLLECTION_TYPE_PARAM

Fields inherited from class org.rhq.enterprise.gui.common.servlet.ChartServlet

BASELINE_PARAM, HIGHRANGE_PARAM, IMAGE_HEIGHT_DEFAULT, IMAGE_WIDTH_DEFAULT, LOWRANGE_PARAM, MEASUREMENT_UNITS_PARAM, SHOW_AVERAGE_PARAM, SHOW_BASELINE_PARAM, SHOW_HIGHRANGE_PARAM, SHOW_LOW_PARAM, SHOW_LOWRANGE_PARAM, SHOW_PEAK_PARAM, SHOW_VALUES_PARAM, units

Fields inherited from class org.rhq.enterprise.gui.common.servlet.ImageServlet

IMAGE_FORMAT_JPEG, IMAGE_FORMAT_PARAM, IMAGE_FORMAT_PNG, IMAGE_HEIGHT_PARAM, IMAGE_WIDTH_PARAM

Constructor Summary

MetricChartServlet()

Method Summary

protected Chart	createChart() Create and return the chart.
protected boolean	getDefaultShowAverage() Return the default showAverage.
protected boolean	getDefaultShowBaseline() Return the default showBaseline.
protected boolean	getDefaultShowEvents() Return the default showEvents.
protected boolean	getDefaultShowHighRange() Return the default showHighRange.
protected boolean	getDefaultShowLow() Return the default showLow.
protected boolean	getDefaultShowLowRange() Return the default showLowRange.
protected boolean	getDefaultShowPeak() Return the default showPeak.
protected boolean	getDefaultShowValues() Return the default showValues.
protected void	initializeChart(Chart chart) Initialize the chart.
protected void	parseParameters(javax.servlet.http.HttpServletRequest request) This method will be called automatically by the ChartServlet.
protected void	plotData(javax.servlet.http.HttpServletRequest request, Chart chart) This method will be called automatically by the ChartServlet.

Methods inherited from class org.rhq.enterprise.gui.common.servlet.VerticalChartServlet

getDefaultCollectionType, getTrendForCollectionType

Methods inherited from class org.rhq.enterprise.gui.common.servlet.ChartServlet

createImage, getDefaultImageHeight, getDefaultImageWidth, getShowAvg, getShowLow, getShowPeak, renderJpegImage, renderPngImage

Methods inherited from class org.rhq.enterprise.gui.common.servlet.ImageServlet

doGet, getDefaultImageFormat, getImageFormat, getImageHeight, getImageWidth, init

Methods inherited from class org.rhq.enterprise.gui.common.servlet.ParameterizedServlet

invalidParamErr, invalidParamErr, invalidParamWarn, invalidParamWarn, invalidParamWarn, invalidParamWarn, invalidParamWarn, parseBooleanParameter, parseDoubleParameter, parseEnumParameter, parseIntParameter, parseLongParameter, parseRequiredBooleanParameter, parseRequiredDoubleParameter, parseRequiredIntParameter, parseRequiredLongParameter, parseRequiredStringParameter, parseRequiredStringParameter, parseStringParameter, parseStringParameter, requiredParamErr

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

CHART_DATA_KEY_PARAM

public static final String CHART_DATA_KEY_PARAM

Request parameter for the chart data key session attribute.

See Also:

Constant Field Values

SHOW_EVENTS_PARAM

public static final String SHOW_EVENTS_PARAM

Request parameter for whether or not to show control actions.

See Also:

Constant Field Values

Constructor Detail

MetricChartServlet

public MetricChartServlet()

Method Detail

parseParameters

protected void parseParameters(javax.servlet.http.HttpServletRequest request)

This method will be called automatically by the ChartServlet. It should handle the parsing and error-checking of any specific parameters for the chart being rendered.

Overrides:

parseParameters in class VerticalChartServlet

Parameters:

request - the HTTP request object

createChart

protected Chart createChart()

Create and return the chart. This method will be called after the parameters have been parsed.

Specified by:

createChart in class ChartServlet

Returns:

the newly created chart

initializeChart

protected void initializeChart(Chart chart)

Initialize the chart. This method will be called after the parameters have been parsed and the chart has been created.

Overrides:

initializeChart in class VerticalChartServlet

Parameters:

chart - the chart

plotData

protected void plotData(javax.servlet.http.HttpServletRequest request,
                        Chart chart)
                 throws javax.servlet.ServletException

This method will be called automatically by the ChartServlet. It should handle adding data to the chart, setting up the X and Y axis labels, etc.

Specified by:

plotData in class ChartServlet

Parameters:

request - the HTTP request

Throws:

javax.servlet.ServletException

getDefaultShowPeak

protected boolean getDefaultShowPeak()

Return the default showPeak.

Overrides:

getDefaultShowPeak in class ChartServlet

getDefaultShowHighRange

protected boolean getDefaultShowHighRange()

Return the default showHighRange.

Overrides:

getDefaultShowHighRange in class ChartServlet

getDefaultShowValues

protected boolean getDefaultShowValues()

Return the default showValues.

Overrides:

getDefaultShowValues in class ChartServlet

getDefaultShowAverage

protected boolean getDefaultShowAverage()

Return the default showAverage.

Overrides:

getDefaultShowAverage in class ChartServlet

getDefaultShowLowRange

protected boolean getDefaultShowLowRange()

Return the default showLowRange.

Overrides:

getDefaultShowLowRange in class ChartServlet

getDefaultShowLow

protected boolean getDefaultShowLow()

Return the default showLow.

Overrides:

getDefaultShowLow in class ChartServlet

getDefaultShowBaseline

protected boolean getDefaultShowBaseline()

Return the default showBaseline.

Overrides:

getDefaultShowBaseline in class ChartServlet

getDefaultShowEvents

protected boolean getDefaultShowEvents()

Return the default showEvents.