com.ibm.tivoli.maximo.map

Class MapControl

java.lang.Object

psdi.webclient.system.controller.BaseInstance

psdi.webclient.system.controller.ControlInstance

psdi.webclient.system.controller.DatasrcInstance

com.ibm.tivoli.maximo.map.MapControl

All Implemented Interfaces:

MapControlCallbacks, java.lang.Cloneable

public class MapControl
extends DatasrcInstance
implements MapControlCallbacks

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

Author:

rcouto, thadeurc

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
MapControl()

Method Summary

Methods

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)
com.ibm.json.java.JSONObject	getBingMapConfiguration(MboRemote mbo) Creates a specific configuration object for Bing Maps
int	getCrewLaborByQueryParams() Gets the crew labor by coords.
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.
com.ibm.json.java.JSONObject	getGoogleMapConfiguration(MboRemote mbo) Creates a specific configuration object for Google Maps
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
java.lang.String	getRefreshMapInterval()
com.ibm.json.java.JSONObject	getRouteConfiguration()
int	getShowMarkersOnRouteError() Gets the action to be executed when the map provider fails to return a valid route: 0 -> show provider error and don't try to draw anything (default) 1 -> try to at least draw the markers
com.ibm.json.java.JSONObject	getSpatialMapConfiguration(MboRemote mbo) Creates a specific configuration object for Spatial Maps
java.lang.String	getWidth()
java.lang.String	getZoomLevel()
java.lang.Boolean	isContextPersistent()
java.lang.Boolean	isDataSourceDynamic()
java.lang.Boolean	isMapViewOnly()
boolean	isMobile()
java.lang.Boolean	isZoomToDataInput()
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	loadMapTipSummaryTemplate()
int	loadMapTipTemplate()
int	loadMenuItems()
int	NOOP()
int	queryUnassignedWorkDispatcher() Queries unassigned work using the Graphical Assignment query.
int	refreshMarkersPositions() Refreshes the position of markers in the current map.
int	refreshQueryUnassignedWork()
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	setCurrentSALocation() Sets the current record location.
int	showDialog()
int	showErrors()
int	showMaxMessage()
int	storeUserLocation()

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, copy, createRenderId, errorLevelChanged, eventCheck, findComponentByDescriptorId, findDesignerProperty, findProperty, findUseForLablledByComponent, getAdaptorInstance, getBoundComponent, getComponent, getComponents, 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, initialize, 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

MapControl

public MapControl()

Method Detail

getCurrentProvider

public MapDataUtils.PROVIDER getCurrentProvider()

Specified by:

getCurrentProvider in interface MapControlCallbacks

getWidth

public java.lang.String getWidth()

isContextPersistent

public java.lang.Boolean isContextPersistent()

isZoomToDataInput

public java.lang.Boolean isZoomToDataInput()

isDataSourceDynamic

public java.lang.Boolean isDataSourceDynamic()

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()

getRouteConfiguration

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

Throws:

MXException

java.rmi.RemoteException

getMapConfiguration

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

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

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

getGoogleMapConfiguration

public com.ibm.json.java.JSONObject getGoogleMapConfiguration(MboRemote mbo)
                                                       throws MXException,
                                                              java.rmi.RemoteException

Creates a specific configuration object for Google Maps

Parameters:

mbo - - Map Manager Mbo

Returns:

Configured JSONObject

Throws:

MXException

java.rmi.RemoteException

getBingMapConfiguration

public com.ibm.json.java.JSONObject getBingMapConfiguration(MboRemote mbo)
                                                     throws MXException,
                                                            java.rmi.RemoteException

Creates a specific configuration object for Bing Maps

Parameters:

mbo - - Map Manager Mbo

Returns:

Configured JSONObject

Throws:

MXException

java.rmi.RemoteException

getSpatialMapConfiguration

public com.ibm.json.java.JSONObject getSpatialMapConfiguration(MboRemote mbo)
                                                        throws MXException,
                                                               java.rmi.RemoteException

Creates a specific configuration object for Spatial Maps

Parameters:

mbo - - Map Manager Mbo

Returns:

Configured JSONObject

Throws:

MXException

java.rmi.RemoteException

storeUserLocation

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

Throws:

java.rmi.RemoteException

MXException

loadMenuItems

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

Throws:

java.rmi.RemoteException

MXException

setCurrentSALocation

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

Sets the current record location. If a new SA is created it will save the current record.

Returns:

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

showErrors

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

Throws:

java.rmi.RemoteException

MXException

showDialog

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

Throws:

MXException

java.rmi.RemoteException

refreshQueryUnassignedWork

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

Throws:

java.rmi.RemoteException

MXException

queryUnassignedWorkDispatcher

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

Queries unassigned work using the Graphical Assignment query. This is supposed to be called only from the Graphical Assignment application.

Throws:

java.rmi.RemoteException

MXException

loadMapTipTemplate

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

Throws:

java.rmi.RemoteException

MXException

loadMapTipSummaryTemplate

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

Throws:

java.rmi.RemoteException

MXException

refreshMarkersPositions

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

Refreshes the position of markers in the current map. If the current mbo is not to be saved, loads the information from the database. 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:

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)

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

getCrewLaborByQueryParams

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

Gets the crew labor by coords.

Returns:

the crews and labors by coords

Throws:

java.rmi.RemoteException - the remote exception

MXException - the mX exception

getShowMarkersOnRouteError

public int getShowMarkersOnRouteError()
                               throws java.rmi.RemoteException

Gets the action to be executed when the map provider fails to return a valid route: 0 -> show provider error and don't try to draw anything (default) 1 -> try to at least draw the markers

Returns:

int

Throws:

java.rmi.RemoteException - the remote exception

NOOP

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

Throws:

MXException

java.rmi.RemoteException

clearNextEventData

public void clearNextEventData()

Clear the event buffer