com.ibm.tivoli.maximo.map

Class MapDataUtils

java.lang.Object

com.ibm.tivoli.maximo.map.MapDataUtils

public class MapDataUtils
extends java.lang.Object

Common methods for map control (and other classes that access map related features).

Author:

rcouto

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapDataUtils.PROVIDER

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTOLOCATEDATA
static java.lang.String	GISDATA
static java.lang.String	LAT_PROPERTY
static java.lang.String	LNG_PROPERTY
static java.lang.String	MXDATA

Constructor Summary

Constructors

Constructor and Description
MapDataUtils()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearMapTipTemplateCache() Clears the maptip template cache
static java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getAllSymbologyAttributes()
com.ibm.json.java.JSONObject	getGISData(MboRemote currentMbo) Return GIS data for the current MBO.
com.ibm.json.java.JSONObject	getGISDataFromGisable(GISable gisMbo)
com.ibm.json.java.JSONArray	getLBSAuditData(MboRemote currentMbo, java.util.Date startDate, java.util.Date endDate) Return the current LBS audit data (if any).
com.ibm.json.java.JSONObject	getLBSData(MboRemote currentMbo) Return the current LBS data.
MboRemote	getMapManager(UserInfo user)
java.lang.String	getMapProvider(MboRemote mapManager)
java.lang.String	getMapTipData(MboRemote mbo, java.lang.String mboName, java.lang.String templateField, UserInfo userInfo, com.ibm.json.java.JSONArray mapTipOverrides)
com.ibm.json.java.JSONObject	getMboAsJSONObject(MboRemote mbo) Transform an mbo into a JSONobject with gis,mx and lbs data, and eventually Autolocate data
com.ibm.json.java.JSONArray	getMboSetAsJSONArray(MboSetRemote mboSet) Transform a mboSet into a JSONArray with gis,mx and lbs data, and eventually Autolocate data
java.util.Date	getMinimumLastUpdateTimestamp() Get the current date minus the mxe.lbs.lastupdate.maxTime
com.ibm.json.java.JSONObject	getMXData(MboRemote currentMbo) Return the current Mbo Maximo data.
java.lang.Long	getObjectIdFromRecordData(com.ibm.json.java.JSONObject recordData)
java.lang.String	getObjectNameFromRecordData(com.ibm.json.java.JSONObject recordData)
com.ibm.json.java.JSONArray	getParamsAsJsonArray(java.lang.String jsonAsString) Gets the params as json array.
com.ibm.json.java.JSONObject	getParamsAsJsonObject(java.lang.String jsonAsString) Gets the params as json object.
boolean	hasIfAnyGISInfo(com.ibm.json.java.JSONObject recordData)
void	setGisableAttributes(MboRemote mbo, com.ibm.json.java.JSONObject recordData, com.ibm.json.java.JSONObject gisData)
java.lang.Boolean	setJSONAutoLocateAttributes(MboRemote mbo, com.ibm.json.java.JSONObject recordData) Sets the auto locate attributes into the Json Object passed as a parameter.

Methods inherited from class java.lang.Object

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

Field Detail

MXDATA

public static final java.lang.String MXDATA

See Also:

Constant Field Values

LNG_PROPERTY

public static final java.lang.String LNG_PROPERTY

See Also:

Constant Field Values

LAT_PROPERTY

public static final java.lang.String LAT_PROPERTY

See Also:

Constant Field Values

AUTOLOCATEDATA

public static final java.lang.String AUTOLOCATEDATA

See Also:

Constant Field Values

GISDATA

public static final java.lang.String GISDATA

See Also:

Constant Field Values

Constructor Detail

MapDataUtils

public MapDataUtils()

Method Detail

getGISData

public com.ibm.json.java.JSONObject getGISData(MboRemote currentMbo)
                                        throws java.rmi.RemoteException,
                                               MXException

Return GIS data for the current MBO.

Parameters:

currentMbo - the current mbo

Returns:

the gIS data

Throws:

java.rmi.RemoteException - the remote exception

MXException - the mX exception

getGISDataFromGisable

public com.ibm.json.java.JSONObject getGISDataFromGisable(GISable gisMbo)
                                                   throws java.rmi.RemoteException,
                                                          MXException

Throws:

java.rmi.RemoteException

MXException

getLBSData

public com.ibm.json.java.JSONObject getLBSData(MboRemote currentMbo)
                                        throws MXException,
                                               java.rmi.RemoteException

Return the current LBS data.

Parameters:

currentMbo - the current mbo

Returns:

currentLBS data or null if currentMbo is not LBS

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception

getMXData

public com.ibm.json.java.JSONObject getMXData(MboRemote currentMbo)
                                       throws java.rmi.RemoteException,
                                              MXException

Return the current Mbo Maximo data.

Parameters:

currentMbo - the current mbo

Returns:

the mX data

Throws:

java.rmi.RemoteException - the remote exception

MXException - the mX exception

getParamsAsJsonObject

public com.ibm.json.java.JSONObject getParamsAsJsonObject(java.lang.String jsonAsString)

Gets the params as json object.

Parameters:

jsonAsString - the json as string

Returns:

the params as json object

getParamsAsJsonArray

public com.ibm.json.java.JSONArray getParamsAsJsonArray(java.lang.String jsonAsString)

Gets the params as json array.

Parameters:

jsonAsString - the json as string

Returns:

the params as json array

getMboSetAsJSONArray

public com.ibm.json.java.JSONArray getMboSetAsJSONArray(MboSetRemote mboSet)
                                                 throws java.rmi.RemoteException,
                                                        MXException

Transform a mboSet into a JSONArray with gis,mx and lbs data, and eventually Autolocate data

Parameters:

mboSet - the Gisable mboset

Returns:

the mboset as json array

Throws:

java.rmi.RemoteException - the remote exception

MXException - the mX exception

getMboAsJSONObject

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

Transform an mbo into a JSONobject with gis,mx and lbs data, and eventually Autolocate data

Parameters:

mbo - the Gisable mbo

Returns:

the mbo as json object

Throws:

java.rmi.RemoteException - the remote exception

MXException - the mX exception

setGisableAttributes

public void setGisableAttributes(MboRemote mbo,
                        com.ibm.json.java.JSONObject recordData,
                        com.ibm.json.java.JSONObject gisData)
                          throws java.rmi.RemoteException,
                                 MXException

Parameters:

the - Gisable mbo

Json - object recordData

gisData -

Throws:

java.rmi.RemoteException

MXException

setJSONAutoLocateAttributes

public java.lang.Boolean setJSONAutoLocateAttributes(MboRemote mbo,
                                            com.ibm.json.java.JSONObject recordData)
                                              throws MXException,
                                                     java.rmi.RemoteException

Sets the auto locate attributes into the Json Object passed as a parameter.

Parameters:

mbo - the Gisable mbo

recordData - th Json object

Returns:

true if exists an autolocation for the mbo passed as parameter.

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception

hasIfAnyGISInfo

public boolean hasIfAnyGISInfo(com.ibm.json.java.JSONObject recordData)

getAllSymbologyAttributes

public static java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getAllSymbologyAttributes()
                                                                                                 throws MXException,
                                                                                                        java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getObjectNameFromRecordData

public java.lang.String getObjectNameFromRecordData(com.ibm.json.java.JSONObject recordData)

getObjectIdFromRecordData

public java.lang.Long getObjectIdFromRecordData(com.ibm.json.java.JSONObject recordData)

getMapTipData

public java.lang.String getMapTipData(MboRemote mbo,
                             java.lang.String mboName,
                             java.lang.String templateField,
                             UserInfo userInfo,
                             com.ibm.json.java.JSONArray mapTipOverrides)
                               throws java.rmi.RemoteException,
                                      MXException

Throws:

java.rmi.RemoteException

MXException

getMinimumLastUpdateTimestamp

public java.util.Date getMinimumLastUpdateTimestamp()
                                             throws java.rmi.RemoteException

Get the current date minus the mxe.lbs.lastupdate.maxTime

Returns:

the minimum "last update" date

Throws:

java.rmi.RemoteException - the remote exception

getMapManager

public MboRemote getMapManager(UserInfo user)
                        throws MXException,
                               java.rmi.RemoteException

Parameters:

user -

Returns:

Throws:

MXException

java.rmi.RemoteException

getMapProvider

public java.lang.String getMapProvider(MboRemote mapManager)
                                throws java.rmi.RemoteException,
                                       MXException

Throws:

java.rmi.RemoteException

MXException

clearMapTipTemplateCache

public void clearMapTipTemplateCache()

Clears the maptip template cache

getLBSAuditData

public com.ibm.json.java.JSONArray getLBSAuditData(MboRemote currentMbo,
                                          java.util.Date startDate,
                                          java.util.Date endDate)
                                            throws MXException,
                                                   java.rmi.RemoteException

Return the current LBS audit data (if any).

Parameters:

currentMbo - the current mbo

Returns:

currentLBS data or null if currentMbo is not LBS or if currentMbo does not have any LBSLOCATION attribute enabled for auditing

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception