psdi.webclient.controls

Class KPIGraph

java.lang.Object

psdi.webclient.system.controller.BaseInstance

psdi.webclient.system.controller.ControlInstance

psdi.webclient.controls.KPIGraph

All Implemented Interfaces:

java.lang.Cloneable, DataBeanListener

public class KPIGraph
extends ControlInstance
implements DataBeanListener

Represents the control instance for KPI Graph in the KPI Manager application.

Author:

KD_Singh

Field Summary

Fields inherited from class psdi.webclient.system.controller.ControlInstance

amIinitialize, DATASOURCE, INPUTMODE, labelOverride, ONDATACAHNGE, PARAM_APP, PARAM_APPTABTYPE, PARAM_DESIGNMODE, PARAM_MOBILE, PARAM_MODULE, PARAM_PAGE, PARAM_PARENTCOMPONENT, PARAM_PARENTCONTROL, PARAM_PRESENTATION, PARAM_SCREENREADER, PARAM_SKINNAME, PARAM_TAB, PARAM_TABGROUP, PARAM_TABGROUP_MAIN, PARAM_TABLE, PARAM_USERINFO, PARAM_VERTICALLABEL, RERENDER_PROPERTY

Fields inherited from class psdi.webclient.system.controller.BaseInstance

EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST

Constructor Summary

Constructors

Constructor and Description
KPIGraph()

Method Summary

Methods

Modifier and Type	Method and Description
void	dataChangedEvent(DataBean speaker) Overriddeng from DataBean
java.lang.String	formatNumber(java.lang.Object variance)
java.util.Vector	getKPIData() Returns the String of the latest date among the KPIs in the set This would be date when the one of the inlcuded KPIs were last updated
java.lang.String[]	getLabels() Returns labels for this portlet.
void	initialize() should be extended to do any setup required by the instance.
boolean	isNewKPI() Checks if the KPI is new
int	refreshchart()
void	refreshChart() Event handler method for "refreshchart" event, when clicked from Refresh Chart Button in the KPI Application in Trend Tab
int	render() Render this control's components
java.lang.String	setGraphInfo(java.lang.String graphType) Prepares graph information and graph object for image rendering, just before the graph frame is refreshed.
void	structureChangedEvent(DataBean speaker) Overridden to flag the the tree as refreshed
void	updatekpis() Called when the user clicks "Update" on the control to update the KPIs

Methods inherited from class psdi.webclient.system.controller.ControlInstance

addChild, addComponent, broadcastEvent, canInsert, canInsert, canRemove, childHasError, childHasErrorFocus, cleanup, clearComponent, clearErrors, copy, createRenderId, errorLevelChanged, eventCheck, findComponentByDescriptorId, findDesignerProperty, findProperty, findUseForLablledByComponent, getAdaptorInstance, getBoundComponent, getComponent, getComponents, getDataBean, getDataSource, getDescriptorControl, getDesignerProperty, getDesignerSelected, getDesignerSelectedControl, getElement, getErrorLevel, getGeneratedControl, getOriginalControl, getOriginalProperty, getProperties, getProperty, getProperty, getPropertyIgnoreFlags, getPropertyOriginator, getPropertyUncle, getRecordHover, getSkipPreRender, getTableControl, getTakesValueComponent, handleEvent, hasChanged, hasChangedConditionally, hasChildElements, hasMaskedChanged, hasRecordHover, hasVisibleChildren, instantiatedatasrc, isDesignerEditedProperty, isDisabled, isFocusable, isGenerated, isHiddenByLicense, isIncluded, isLastChild, isMainrecActionMenu, isMasked, isOnTableFilterRow, isOnTableTitleRow, isPersistentProperty, isReInitialize, isSelected, isToBeDisplayedOnCurrentTab, isToBeDisplayedOnTab, isVisible, launchexternal, moveChild, needsRender, parseParamvalues, preRender, preRenderChecks, quickinsert, registerDesignerEditedProperty, reInitialize, removeChild, renderChildren, resetDataSource, resolveParam, resolveParams, setAttributeError, setBoundComponent, setChangedFlag, setChangedFlag, setDesignerSelected, setDisabled, setElement, setErrorFocusOnControl, setFocus, setFocus, setFocusable, setFocusTable, setGenerated, setGeneratedControl, setIncluded, setIncluded, setNeedsRender, setOnTableFilterRow, setOnTableRow, setOnTableTitleRow, setOriginalControl, setPropertyOriginator, setPropertyUncle, setReInitialize, setReRenderFlags, setSelected, setSkipPreRender, setTableControl, setVisibility, stopRender, walkForId, walkForId

Methods inherited from class psdi.webclient.system.controller.BaseInstance

addChild, addChild, addRefreshListener, clearChildren, clearProperties, clone, clone, getBoolean, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getId, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRenderId, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, hasAnyPropertyChanged, hasLocalProperty, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, isOnTableRow, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

KPIGraph

public KPIGraph()

Method Detail

initialize

public void initialize()

Description copied from class: BaseInstance

should be extended to do any setup required by the instance. for example, the DatasrcInstance will call initialize to create data sources found in the bind list.

Overrides:

initialize in class ControlInstance

getKPIData

public java.util.Vector getKPIData()
                            throws MXException,
                                   java.rmi.RemoteException

Returns the String of the latest date among the KPIs in the set This would be date when the one of the inlcuded KPIs were last updated

Returns:

String - latest date string

Throws:

MXException

java.rmi.RemoteException

getLabels

public java.lang.String[] getLabels()

Returns labels for this portlet. Following list shows list of keys to be used and the labels they stand for

• drillreport - Drill Down Report
• drillkpi - Dril Down in KPI
• updatelbl - Update
• statuslbl - Status
• lastreadlbl - Last KPI Value
• actuallbl - Actual
• targetlbl - Target
• variancelbl - Variance
• kpilbl - KPI
• lastrunlbl - Last Run
• lastvaluelbl - Last Value

Returns:

String array of locale specific labels

updatekpis

public void updatekpis()
                throws MXException,
                       java.rmi.RemoteException

Called when the user clicks "Update" on the control to update the KPIs

Throws:

MXException

java.rmi.RemoteException

setGraphInfo

public java.lang.String setGraphInfo(java.lang.String graphType)
                              throws MXException,
                                     java.rmi.RemoteException

Prepares graph information and graph object for image rendering, just before the graph frame is refreshed.

Parameters:

graphType -

Returns:

graphTitle

Throws:

MXException

java.rmi.RemoteException

refreshChart

public void refreshChart()
                  throws MXException,
                         java.rmi.RemoteException

Event handler method for "refreshchart" event, when clicked from Refresh Chart Button in the KPI Application in Trend Tab

Throws:

MXException

java.rmi.RemoteException

formatNumber

public java.lang.String formatNumber(java.lang.Object variance)

Parameters:

variance - as Double

Returns:

number as String

isNewKPI

public boolean isNewKPI()

Checks if the KPI is new

Returns:

render

public int render()
           throws java.lang.NoSuchMethodException,
                  java.lang.IllegalAccessException,
                  java.lang.reflect.InvocationTargetException

Description copied from class: ControlInstance

Render this control's components

Overrides:

render in class ControlInstance

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

refreshchart

public int refreshchart()
                 throws MXException

Throws:

MXException

dataChangedEvent

public void dataChangedEvent(DataBean speaker)

Overriddeng from DataBean

Specified by:

dataChangedEvent in interface DataBeanListener

Parameters:

speaker -

structureChangedEvent

public void structureChangedEvent(DataBean speaker)

Overridden to flag the the tree as refreshed

Specified by:

structureChangedEvent in interface DataBeanListener

See Also:

DataBeanListener.structureChangedEvent(psdi.webclient.system.beans.DataBean)