planetj.chart
Class ChartRequest

java.lang.Object
  |
  +--planetj.html.AbstractHTMLRenderer
        |
        +--planetj.magic.AbstractMagicRequest
              |
              +--planetj.magic.MagicRequest
                    |
                    +--planetj.magic.RowCollectionRequest
                          |
                          +--planetj.chart.ChartRequest

All Implemented Interfaces:

Cloneable, IFeature, IHTMLRenderer, IMagicRequest, IRenderer, Serializable

public class ChartRequest

extends RowCollectionRequest

Request a chart to be created and written to the output stream.

Author:

PlanetJ Corporation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.dataengine.IFeature

IFeature.OperationCountFeature

Field Summary

String

className

Fields inherited from interface planetj.magic.IMagicRequest

IS_COMPLETE, MAGIC_REQUEST, MAGIC_REQUEST_PARAM1, MAGIC_REQUEST_RC, SAME_URI, TYPE, TYPE_PAGE, TYPE_SESSION, TYPE_STATIC, USER_REQUEST_ATTRIBUTES_STORED

Fields inherited from interface planetj.html.IHTMLRenderer

HTML

Fields inherited from interface planetj.dataengine.IFeature

DEFAULT_MESSAGE_FEATURE, FEATURE_DELETE, FEATURE_INSERT, FEATURE_LEVEL_ENTERPRISE, FEATURE_LEVEL_ENTRY, FEATURE_LEVEL_PROFESSIONAL, FEATURE_LEVEL_STANDARD, FEATURE_UPDATE, MESSAGE_END, MESSAGE_START

Constructor Summary

ChartRequest(String id, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String rcId, String chartId)
Deprecated. Pass in the RC itself, not its navigation id

ChartRequest(String id, RowCollection rc, String chartId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
ChartRequest constructor

Method Summary

IMagicRequest	execute(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DataEngineServlet servlet) Creates a chart for the RowCollection pertaining to the RowCollection's session id set in the constructor.
String	getChartId(javax.servlet.http.HttpServletRequest request) Gets the chart id set for the chart this ChartRequest is to generate.
ChartSpecificationPG	getChartSpecifications(String chartId, javax.servlet.http.HttpServletRequest request) Gets the RowCollection's chart specifications for the given chart id.
int	getFeatureLevel() Gets the minimum feature level requried to execute this operation
boolean	isReturnToRequester() ChartRequest only writes a chart to the output stream and does not need to call any other page.

Methods inherited from class planetj.magic.RowCollectionRequest

getRowCollection, getRowCollectionSessionId, setRowCollectionSessionId

Methods inherited from class planetj.magic.MagicRequest

getType, store

Methods inherited from class planetj.magic.AbstractMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, appendUnsupportedHTMLMessage, clone, clone, equals, executeAll, getAnchorName, getBaseField, getBaseRow, getBaseRowCollection, getCurrentURI, getDefaultEndNavigationGroup, getFailMessage, getFirstRequest, getId, getKey, getLastRequest, getMagicServletURI, getMagicURI, getNextURI, getRequestAttribute, getRequestParameter, getRequestParameterValues, getSessionAttribute, getSharedSessionAttribute, getSuccessMessage, hasLinkedRequestsAfter, hasLinkedRequestsBefore, isApplicable, isCompleted, isEndNavigationGroup, isPopup, isSaveResults, isStartNewNavigationGroup, preexecute, removeRequestAttribute, removeSessionAttribute, removeSharedSessionAttribute, setAnchorName, setBaseField, setBaseRow, setBaseRowCollection, setCompleted, setEndNavigationGroup, setFailMessage, setId, setNextURI, setNextURI, setNextURIs, setPopup, setRequestGroupAttribute, setRequestPageAttribute, setRequestPersistentAttribute, setRequestTransientAttribute, setReturnToRequester, setRowEventListener, setSessionAttribute, setSessionSharedAttribute, setStartNewNavigationGroup, setSuccessMessage

Methods inherited from class planetj.html.AbstractHTMLRenderer

append, generate, getDisplayType

Methods inherited from class java.lang.Object

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

Methods inherited from interface planetj.magic.IMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, executeAll, getBaseField, getBaseRow, getCurrentURI, getFirstRequest, getId, getKey, getLastRequest, getMagicURI, getNextURI, isCompleted, isEndNavigationGroup, isSaveResults, isStartNewNavigationGroup, setBaseField, setBaseRow, setRowEventListener

Methods inherited from interface planetj.html.IHTMLRenderer

append, generate

Methods inherited from interface planetj.dataengine.display.IRenderer

getDisplayType

Methods inherited from interface planetj.dataengine.IFeature

appendUnsupportedHTMLMessage, isApplicable

Field Detail

className

public final String className

Constructor Detail

ChartRequest

public ChartRequest(String id,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response,
                    String rcId,
                    String chartId)

Deprecated. Pass in the RC itself, not its navigation id

ChartRequest constructor.

ChartRequest

public ChartRequest(String id,
                    RowCollection rc,
                    String chartId,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)

ChartRequest constructor

Method Detail

execute

public IMagicRequest execute(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             DataEngineServlet servlet)
                      throws CMException

Creates a chart for the RowCollection pertaining to the RowCollection's session id set in the constructor. The chart is created with the RowCollection's ChartSpecifications.

Specified by:

execute in interface IMagicRequest

Specified by:

execute in class AbstractMagicRequest

CMException

getChartId

public String getChartId(javax.servlet.http.HttpServletRequest request)

Gets the chart id set for the chart this ChartRequest is to generate.

getChartSpecifications

public ChartSpecificationPG getChartSpecifications(String chartId,
                                                   javax.servlet.http.HttpServletRequest request)
                                            throws CMException

Gets the RowCollection's chart specifications for the given chart id. If no chart id is specified, then the first chart specification is returned.

Parameters:

chartId - Id of the chart to retrieve chart specs

CMException

getFeatureLevel

public int getFeatureLevel()

Gets the minimum feature level requried to execute this operation

Specified by:

getFeatureLevel in interface IFeature

Overrides:

getFeatureLevel in class AbstractMagicRequest

isReturnToRequester

public boolean isReturnToRequester()

ChartRequest only writes a chart to the output stream and does not need to call any other page.

Specified by:

isReturnToRequester in interface IMagicRequest

Overrides:

isReturnToRequester in class AbstractMagicRequest