com.ibm.tivoli.maximo.map

Class OpenMapControl

java.lang.Object

psdi.webclient.system.controller.BaseInstance

psdi.webclient.system.controller.ControlInstance

psdi.webclient.system.controller.DatasrcInstance

com.ibm.tivoli.maximo.map.OpenMapControl

All Implemented Interfaces:

MapClientEvents, MapControlCallbacks, java.lang.Cloneable

public class OpenMapControl
extends DatasrcInstance
implements MapControlCallbacks, MapClientEvents

Controller for the Map component. It loads the configuration and implements the action.

Field Summary

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

databean

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

amIinitialize, DATASOURCE, errorChanged, errorLevel, errorsValidated, generatedControl, INPUTMODE, labelOverride, labelParams, LOG_CATEGORY, ONDATACAHNGE, originalControl, PARAM_APP, PARAM_APPTABTYPE, PARAM_DESIGNMODE, PARAM_LIGHTNING, 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, propertyOriginator, RERENDER_PROPERTY

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

changedProperties, 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, properties, type

Constructor Summary

Constructors

Constructor and Description
OpenMapControl()

Method Summary

Modifier and Type	Method and Description
void	addEventToMap(java.lang.String eventName, com.ibm.json.java.JSONObject action)
void	addRecordsToLayer(java.lang.String layerName, MboSetRemote mboSet, boolean cleanOld) For the sake of flexibility, the interface receives a mboset, but the elements of the mboset will only be shown on the map if the mbos of the mboset implements the interface Gisable
void	clearNextEventData() Clear the event buffer
void	createMapCallback(java.lang.String actionName, com.ibm.json.java.JSONObject data)
MapControlClientEvent	getClientEventCtrl()
MapDataUtils.PROVIDER	getCurrentProvider()
com.ibm.json.java.JSONObject	getCurrentRecordData()
com.ibm.json.java.JSONArray	getCurrentState() Return the next current state with all JSON data that must be handle by the map component.
protected com.ibm.json.java.JSONObject	getCustomMapConfiguration(MboRemote mapManager) Used to allow customizations
java.lang.String	getHeight()
java.lang.Double	getInitialX()
java.lang.Double	getInitialY()
MboRemote	getMainRecordMbo()
com.ibm.json.java.JSONObject	getMapConfiguration() Creates the JSON object configuration based on data from FSM Map Manager app
protected MapControlAccessor	getMapControlAccessor()
protected MapManagerRemote	getMapManager(UserInfo user)
protected MboRemote	getMapSite(UserInfo user, MboRemote mapManager)
java.lang.String	getOpenMapReturnAttribute() Returns the attribute which called the Open Map component.
java.lang.String	getOriginalApp(java.lang.String app)
java.lang.String	getRefreshMapInterval()
java.lang.String	getWidth()
java.lang.String	getZoomLevel()
java.lang.Boolean	isContextPersistent()
protected boolean	isInMapManager()
protected boolean	isMainRecordChanged()
java.lang.Boolean	isMapViewOnly()
boolean	isMobile()
void	loadGISMapConfiguration() Sets the GIS configuration Note: The method has some side effects such as call reset on the mboset before iterate on it.
int	pushMapControlClientEventHandler()
static java.lang.String	removeCommentsFromJson(java.lang.String isStr)
void	removeRecordsFromLayer(java.lang.String layerName, MboSetRemote mboSet) For the sake of flexibility, the interface receives a mboset, but the elements of the mboset will only be removed from the map if the mbos of the mboset implements the interface Gisable
int	render() Note: The method has some side effects such as call reset on the mboset before iterate on it.
int	showErrors()
int	showErrorsParamObject()
int	showMaxMessage()
int	storeUserLocation()
protected void	updateMapControlAccessorBounds(LatLngBounds mapBounds)

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

broadcastEvent, cleanup, getDataBean, instantiatedatasrc, instantiatedatasrcdesign

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

addChild, addComponent, canInsert, canInsert, canRemove, childHasError, childHasErrorFocus, clearComponent, clearErrors, clearFlags, copy, createRenderId, determineErrorLevel, errorLevelChanged, eventCheck, findComponentByDescriptorId, findDesignerProperty, findProperty, findUseForLablledByComponent, getAdaptorInstance, getBoundComponent, getComponent, getComponents, getConditonallyChanged, 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, hasSigOptionAccess, hasVisibleChildren, initialize, isDesignerEditedProperty, isDisabled, isFirstChildVisible, isFocusable, isGenerated, isHiddenByLicense, isIncluded, isLastChild, isMainrecActionMenu, isMasked, isOnTableFilterRow, isOnTableTitleRow, isPersistentProperty, isReInitialize, isSelected, isToBeDisplayedOnCurrentTab, isToBeDisplayedOnTab, isVisible, launchexternal, licenseCheck, moveChild, needsRender, parentPropertyChanged, parseParamvalues, preRender, preRenderChecks, propertyChanged, quickinsert, registerDesignerEditedProperty, reInitialize, removeChild, renderChildren, resetDataSource, resolveParam, resolveParams, setAttributeError, setBoundComponent, setChangedFlag, setChangedFlag, setConditionalProperties, 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, sigOptionCheck, sigOptionCheckForLookups, stopRender, walkForId, walkForId

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

addChild, addChild, addRefreshListener, canSetProperty, clearChildren, clearPropChangeList, clearProperties, clone, clone, getBoolean, getChangedProperties, 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

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

Constructor Detail

OpenMapControl

public OpenMapControl()

Method Detail

getClientEventCtrl

public MapControlClientEvent getClientEventCtrl()

getCurrentProvider

public MapDataUtils.PROVIDER getCurrentProvider()

Specified by:

getCurrentProvider in interface MapControlCallbacks

getWidth

public java.lang.String getWidth()

isContextPersistent

public java.lang.Boolean isContextPersistent()

getZoomLevel

public java.lang.String getZoomLevel()

isMapViewOnly

public java.lang.Boolean isMapViewOnly()

getInitialX

public java.lang.Double getInitialX()

getInitialY

public java.lang.Double getInitialY()

isMobile

public boolean isMobile()

getHeight

public java.lang.String getHeight()

getRefreshMapInterval

public java.lang.String getRefreshMapInterval()

getMapConfiguration

public com.ibm.json.java.JSONObject getMapConfiguration()
                                                 throws MXException,
                                                        java.io.IOException

Creates the JSON object configuration based on data from FSM Map Manager app

Returns:

Throws:

MXException

java.io.IOException

getMapSite

protected MboRemote getMapSite(UserInfo user,
                               MboRemote mapManager)
                        throws MXException,
                               java.rmi.RemoteException

Parameters:

user -

mapManager -

Returns:

Throws:

MXException

java.rmi.RemoteException

isInMapManager

protected boolean isInMapManager()
                          throws java.rmi.RemoteException,
                                 MXException

Returns:

Throws:

java.rmi.RemoteException

MXException

getMapManager

protected MapManagerRemote getMapManager(UserInfo user)
                                  throws MXException,
                                         java.rmi.RemoteException

Parameters:

user -

Returns:

Throws:

MXException

java.rmi.RemoteException

loadGISMapConfiguration

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

Sets the GIS configuration Note: The method has some side effects such as call reset on the mboset before iterate on it. If there is a current record set, it MUST be restored by the application.

Throws:

MXException

java.rmi.RemoteException

getCustomMapConfiguration

protected com.ibm.json.java.JSONObject getCustomMapConfiguration(MboRemote mapManager)
                                                          throws MXException,
                                                                 java.rmi.RemoteException

Used to allow customizations

Parameters:

mapManager -

Returns:

Throws:

MXException

java.rmi.RemoteException

storeUserLocation

public int storeUserLocation()
                      throws java.rmi.RemoteException,
                             MXException

Throws:

java.rmi.RemoteException

MXException

render

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

Note: The method has some side effects such as call reset on the mboset before iterate on it. If there is a current record set, it MUST be restored by the application.

Overrides:

render in class DatasrcInstance

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

getCurrentState

public com.ibm.json.java.JSONArray getCurrentState()
                                            throws java.rmi.RemoteException,
                                                   MXException

Return the next current state with all JSON data that must be handle by the map component.

Returns:

Throws:

java.rmi.RemoteException

MXException

getCurrentRecordData

public com.ibm.json.java.JSONObject getCurrentRecordData()
                                                  throws java.rmi.RemoteException,
                                                         MXException

Throws:

java.rmi.RemoteException

MXException

getMainRecordMbo

public MboRemote getMainRecordMbo()
                           throws java.rmi.RemoteException,
                                  MXException

Specified by:

getMainRecordMbo in interface MapControlCallbacks

Throws:

java.rmi.RemoteException

MXException

showMaxMessage

public int showMaxMessage()
                   throws java.rmi.RemoteException,
                          MXException

Throws:

java.rmi.RemoteException

MXException

showErrorsParamObject

public int showErrorsParamObject()
                          throws MXException,
                                 java.lang.NullPointerException,
                                 java.io.IOException

Throws:

MXException

java.lang.NullPointerException

java.io.IOException

showErrors

public int showErrors()
               throws java.rmi.RemoteException,
                      MXException

Throws:

java.rmi.RemoteException

MXException

isMainRecordChanged

protected boolean isMainRecordChanged()
                               throws java.rmi.RemoteException,
                                      MXException

Throws:

java.rmi.RemoteException

MXException

createMapCallback

public void createMapCallback(java.lang.String actionName,
                              com.ibm.json.java.JSONObject data)
                       throws java.rmi.RemoteException,
                              MXException

Specified by:

createMapCallback in interface MapControlCallbacks

Throws:

java.rmi.RemoteException

MXException

addRecordsToLayer

public void addRecordsToLayer(java.lang.String layerName,
                              MboSetRemote mboSet,
                              boolean cleanOld)
                       throws java.rmi.RemoteException,
                              MXException

Description copied from interface: MapControlCallbacks

For the sake of flexibility, the interface receives a mboset, but the elements of the mboset will only be shown on the map if the mbos of the mboset implements the interface Gisable

Specified by:

addRecordsToLayer in interface MapControlCallbacks

cleanOld - data before add new data?

Throws:

java.rmi.RemoteException

MXException

addEventToMap

public void addEventToMap(java.lang.String eventName,
                          com.ibm.json.java.JSONObject action)

getMapControlAccessor

protected MapControlAccessor getMapControlAccessor()

updateMapControlAccessorBounds

protected void updateMapControlAccessorBounds(LatLngBounds mapBounds)

removeRecordsFromLayer

public void removeRecordsFromLayer(java.lang.String layerName,
                                   MboSetRemote mboSet)
                            throws java.rmi.RemoteException,
                                   MXException

Description copied from interface: MapControlCallbacks

For the sake of flexibility, the interface receives a mboset, but the elements of the mboset will only be removed from the map if the mbos of the mboset implements the interface Gisable

Specified by:

removeRecordsFromLayer in interface MapControlCallbacks

Throws:

java.rmi.RemoteException

MXException

removeCommentsFromJson

public static java.lang.String removeCommentsFromJson(java.lang.String isStr)

clearNextEventData

public void clearNextEventData()

Clear the event buffer

getOpenMapReturnAttribute

public java.lang.String getOpenMapReturnAttribute()

Returns the attribute which called the Open Map component.

Returns:

String containing the attribute name.

getOriginalApp

public java.lang.String getOriginalApp(java.lang.String app)
                                throws java.rmi.RemoteException,
                                       MXException

Throws:

java.rmi.RemoteException

MXException

pushMapControlClientEventHandler

public int pushMapControlClientEventHandler()

Specified by:

pushMapControlClientEventHandler in interface MapClientEvents