com.ibm.tivoli.maximo.srvad.app

Class ServiceAddressService

java.lang.Object

psdi.server.AppService

com.ibm.tivoli.maximo.srvad.app.ServiceAddressService

All Implemented Interfaces:

ServiceAddressServiceRemote, java.rmi.Remote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers

public class ServiceAddressService
extends AppService
implements ServiceAddressServiceRemote

Field Summary

Fields inherited from class psdi.server.AppService

currentState, dbManager, INIT, liveObjCount, load, LOAD, mxServer, name, RUN, running, stateCmdList, stateList, STOP, url

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
ServiceAddressService(MXServer mxServer)

Method Summary

Modifier and Type	Method and Description
com.ibm.json.java.JSONObject	getLatLngFromAddressableMbo(MboRemote mboWithXY) Based on a mbo with GIS data it gets the mbo WGS coordinates (lat/lng). With Bingmaps or Googlemaps providers the LATITUDEY and LONGITUDEX double attributes are already in WGS84. With Maximo Spatial maps this is not always true.
java.util.List	getLatLngFromAutolocatableMbos(MboSetRemote mboSet) Runs getLatLngFromAddressableMbo(mbo) for every mbo in the mboSet after retrieving the mboWithXY . from each mbo (by calling mbo.getAutoLocateObject()) The execution will split into threads because retrieving the x/y can be slow when coordinate system conversion and feature class fetching take place.
SpatialMapConfServiceRemote	getSpatialMapConfService(UserInfo userInfo) Checks if Spatial is installed and if the map provider is correctly configured to "Spatial". If both conditions are true, return the reference to SpatialMapConfService. If the map provider is "Spatial" but Spatial is not installed, show an error message.
java.lang.String[]	getStreetOrderFormat(MboRemote mbo) Returns an array with the field's order that is set in STREETORDERNUM maxvar
boolean	hasServiceAddressData(MboRemote mbo)
boolean	isAddressDetailRequired(MboRemote mbo) Returns true if the maxvar STRADDRDETAIL is set to "REQUIRED"
boolean	isAddressMasterMaximo(MboRemote mbo) Returns true if the maxvar ADDRMASTER is set to "MAXIMO"
boolean	isCoordinatesLatLong(MboRemote mbo) Returns true if the maxvar COORDINATE is set to "LATLONG"
boolean	isCoordinatesLatLong(java.lang.String orgid)
boolean	isSAInfoEditable(MboRemote mbo) Returns true if the maxvar SAEDITABLE is set to "1"
boolean	isSAMessagePrompt(MboRemote mbo) Returns true if the maxvar SAMSGPROMPT is set to "1"

Methods inherited from class psdi.server.AppService

checkSecurity, configure, destroy, freeDBConnection, freeMboSet, getCriteria, getCriteriaList, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, init, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setName, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService, restart

Constructor Detail

ServiceAddressService

public ServiceAddressService(MXServer mxServer)
                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

hasServiceAddressData

public boolean hasServiceAddressData(MboRemote mbo)
                              throws MXException,
                                     java.rmi.RemoteException

Specified by:

hasServiceAddressData in interface ServiceAddressServiceRemote

Throws:

MXException

java.rmi.RemoteException

isSAInfoEditable

public boolean isSAInfoEditable(MboRemote mbo)
                         throws java.rmi.RemoteException,
                                MXException

Description copied from interface: ServiceAddressServiceRemote

Returns true if the maxvar SAEDITABLE is set to "1"

Specified by:

isSAInfoEditable in interface ServiceAddressServiceRemote

Parameters:

mbo - - Current mbo record to recover Org. values

Throws:

java.rmi.RemoteException

MXException

isAddressMasterMaximo

public boolean isAddressMasterMaximo(MboRemote mbo)
                              throws java.rmi.RemoteException,
                                     MXException

Description copied from interface: ServiceAddressServiceRemote

Returns true if the maxvar ADDRMASTER is set to "MAXIMO"

Specified by:

isAddressMasterMaximo in interface ServiceAddressServiceRemote

Parameters:

mbo - - Current mbo record to recover Org. values

Throws:

java.rmi.RemoteException

MXException

isAddressDetailRequired

public boolean isAddressDetailRequired(MboRemote mbo)
                                throws java.rmi.RemoteException,
                                       MXException

Description copied from interface: ServiceAddressServiceRemote

Returns true if the maxvar STRADDRDETAIL is set to "REQUIRED"

Specified by:

isAddressDetailRequired in interface ServiceAddressServiceRemote

Parameters:

mbo - - Current mbo record to recover Org. values

Throws:

java.rmi.RemoteException

MXException

isCoordinatesLatLong

public boolean isCoordinatesLatLong(java.lang.String orgid)
                             throws java.rmi.RemoteException,
                                    MXException

Specified by:

isCoordinatesLatLong in interface ServiceAddressServiceRemote

Throws:

java.rmi.RemoteException

MXException

isCoordinatesLatLong

public boolean isCoordinatesLatLong(MboRemote mbo)
                             throws java.rmi.RemoteException,
                                    MXException

Description copied from interface: ServiceAddressServiceRemote

Returns true if the maxvar COORDINATE is set to "LATLONG"

Specified by:

isCoordinatesLatLong in interface ServiceAddressServiceRemote

Parameters:

mbo - - Current mbo record to recover Org. values

Throws:

java.rmi.RemoteException

MXException

getStreetOrderFormat

public java.lang.String[] getStreetOrderFormat(MboRemote mbo)
                                        throws java.rmi.RemoteException,
                                               MXException

Description copied from interface: ServiceAddressServiceRemote

Returns an array with the field's order that is set in STREETORDERNUM maxvar

Specified by:

getStreetOrderFormat in interface ServiceAddressServiceRemote

Parameters:

mbo - - Current mbo record to recover Org. values

Returns:

A String array with all field's name in correct order

Throws:

java.rmi.RemoteException

MXException

isSAMessagePrompt

public boolean isSAMessagePrompt(MboRemote mbo)
                          throws java.rmi.RemoteException,
                                 MXException

Description copied from interface: ServiceAddressServiceRemote

Returns true if the maxvar SAMSGPROMPT is set to "1"

Specified by:

isSAMessagePrompt in interface ServiceAddressServiceRemote

Parameters:

mbo - - Current mbo record to recover Org. values

Throws:

java.rmi.RemoteException

MXException

getSpatialMapConfService

public SpatialMapConfServiceRemote getSpatialMapConfService(UserInfo userInfo)
                                                     throws java.rmi.RemoteException,
                                                            MXException

Checks if Spatial is installed and if the map provider is correctly configured to "Spatial".
If both conditions are true, return the reference to SpatialMapConfService.
If the map provider is "Spatial" but Spatial is not installed, show an error message.

Specified by:

getSpatialMapConfService in interface ServiceAddressServiceRemote

Throws:

java.rmi.RemoteException

MXException

getLatLngFromAddressableMbo

public com.ibm.json.java.JSONObject getLatLngFromAddressableMbo(MboRemote mboWithXY)
                                                         throws MXException,
                                                                java.rmi.RemoteException

Description copied from interface: ServiceAddressServiceRemote

Based on a mbo with GIS data it gets the mbo WGS coordinates (lat/lng).
With Bingmaps or Googlemaps providers the LATITUDEY and LONGITUDEX double attributes are already in WGS84.
With Maximo Spatial maps this is not always true. The Map could use a different coordinate system, so it's
necessary to convert to the WGS84 coordinate system. Also if Spatial map provider is being used, it is also
needed to look for linked records. This method does convert the feature class to lat/lng coordinages.
The JsonObject returned has 2 properties: {lat:DOUBLE, lng:DOUBLE}

Specified by:

getLatLngFromAddressableMbo in interface ServiceAddressServiceRemote

Parameters:

mboWithXY - mbo that is the result of calling getAutoLocateObject in an AutoLocatable mbo

Returns:

{lat:DOUBLE, lng:DOUBLE}

Throws:

MXException

java.rmi.RemoteException

getLatLngFromAutolocatableMbos

public java.util.List getLatLngFromAutolocatableMbos(MboSetRemote mboSet)
                                              throws MXException,
                                                     java.rmi.RemoteException

Description copied from interface: ServiceAddressServiceRemote

Runs getLatLngFromAddressableMbo(mbo) for every mbo in the mboSet after retrieving the mboWithXY .
from each mbo (by calling mbo.getAutoLocateObject())
The execution will split into threads because retrieving the x/y can be slow
when coordinate system conversion and feature class fetching take place.

Specified by:

getLatLngFromAutolocatableMbos in interface ServiceAddressServiceRemote

Parameters:

mboSet - mboSet containing the mbos for which the x/y will be retrieved

Returns:

List<{lat:DOUBLE, lng:DOUBLE}>

Throws:

MXException

java.rmi.RemoteException