Class MQExec

Object
   |
   +--MQExec

class MQExec

Provides communication layer for requests to a server. Most, but not all, of the functions generate actual requests to the MapQuest Server. Within the context of this object, a Session object is used to maintain information concerning the current client's requests.
Defined in mqexec.js

See:

- MQDBLayerQueryCollection
- MQDTCollection
- MQFeatureCollection
- MQLocation
- MQLocationCollection
- MQMapState
- MQLatLng
- MQPoint
- MQSession
- MQRouteOptions
- MQRouteResults
- MQGeocodeOptionsCollection
- MQStringCollection
- MQRecordSet
- MQLatLngCollection
- MQPointCollection
- MQSearchCriteria
- MQMapCommand
- MQQualityType
- MQMatchType

Field Detail

GEOCODE_VERSION

Object GEOCODE_VERSION

GETRECORDINFO_VERSION

Object GETRECORDINFO_VERSION

GETSESSION_VERSION

Object GETSESSION_VERSION

m_strXInfo

<private> Object m_strXInfo

REVERSEGEOCODE_VERSION

Object REVERSEGEOCODE_VERSION

ROUTE_VERSION

Object ROUTE_VERSION

ROUTEMATRIX_VERSION

Object ROUTEMATRIX_VERSION

SEARCH_VERSION

Object SEARCH_VERSION

MQExec

MQExec( <String/MQExec> strServerNameORmqeObj, <String> strPathToServer, <int> nServerPort, <String> strProxyServerName, strPathToProxyServerPage, <int> nProxyServerPort )

Constructs new MQExec Object

Parameters:
strServerNameORmqeObj - MapQuest Server name (or) MQExec object to copy the server information.
strPathToServer - Path to the Server
nServerPort - HTTP Port of the Server
strProxyServerName - Name of the server hosting the Proxy page
nProxyServerPort - Port of the Server hosting the Proxy page strServerName, strPathToServer, and nServerPort are required properties that need to be set before the first request. If these properties are not specified, the defaults used for initialization are: MapServer = localhost PathToServer = mq HTTPPort = 80 Please Note: These defaults are not likely to match your configuration. If MQExec object is provided as the first parameter, remaining parameters will be ignored and server information will be copied from the provided object.
String - } strPathToProxyServerPage Path to the Proxy Server page

See:
- MQDBLayerQueryCollection
- MQDTCollection
- MQFeatureCollection
- MQLocation
- MQLocationCollection
- MQMapState
- MQLatLng
- MQPoint
- MQSession
- MQRouteOptions
- MQRouteResults
- MQGeocodeOptionsCollection
- MQStringCollection
- MQRecordSet
- MQLatLngCollection
- MQPointCollection
- MQSearchCriteria
- MQMapCommand
- MQQualityType
- MQMatchType

batchGeocode

void batchGeocode(<MQLocationCollection> mqlcLocations, <MQLocationCollectionCollection> mqlccLocations, <MQAutoGeocodeCovSwitch/MQGeocodeOptionsCollection> theOptions)

Method to batch geocode a collection of locations. Geocode options supply the QualityType and MatchType.

Parameters:
mqlcLocations - The LocationCollection containing the necessary info for the addresses to be geocode. (Please Note: This object will not be updated, it is simply used for the request.)
mqlccLocations - The LocationCollectionCollection used to hold the results of the geocode.
theOptions - The AutoGeocodeCovSwitch or MQGeocodeOptionsCollection to select a set of options stored on the server. (Please Note: This object will not be updated, it is simply used for the request.)

createSessionEx

String createSessionEx(<MQSession> mqsSession)

Generates a request to the MapQuest server (as specified by the server name, path, and port number) to create a user Session. The Session is assigned a unique identifier which is used to access and update the Session information.

Parameters:
mqsSession - Object containing objects for the session. (Please Note: This object will not be updated, it is simply used for the request.)

Returns:
The unique Session identifier.

doRoute

void doRoute(<MQLocationCollection> mqlcLocations, <MQRouteOptions> mqroOptions, <MQRouteResults> mqrrResults, <String> strSessionUID, <MQRectLL> mqRectLL)

Calculates a route using a collection of locations as origin and destination. These locations can be Address, GeoAddress, Intersection, or GeoIntersection objects.

Parameters:
mqlcLocations - Collection of locations. (Please Note: This object will not be updated, it is simply used for the request.)
mqroOptions - Route options object, to modify behavior of route. (Please Note: This object will not be updated, it is simply used for the request.)
mqrrResults - The results of the route request.
strSessionUID - The unique Session ID.
mqRectLL - The bounding box to provide to the TileMap ToolKit. This parameter is optional

doRouteMatrix

void doRouteMatrix(<MQLocationCollection> mqlcLocations, <boolean> bAllToAll, <MQRouteOptions> mqroOptions, <MQRouteMatrixResults> mqrmrResults)

Calculates a route matrix. Either a drive time (many-to-many) or a multi-destination (one-to-many) route.

Parameters:
mqlcLocations - Collection of location objects. The first member of the collection is the origin. If allToAll is true then the last member is the destination. Each location must be a GeoAddress (Please Note: This object will not be updated, it is simply used for the request.)
bAllToAll - If true then a matrix of time and distance from each location to all others is found. If false, time and distance from the first location (origin) to all others is found.
mqroOptions - Specifies options for the route (fastest vs. shortest, coverage to use, roads to avoid, etc.). (Please Note: This object will not be updated, it is simply used for the request.)
mqrmrResults - Contains the time and distance matrix as well as the status of the call (success, failure, partial success)

doTransaction

 <private> void doTransaction(<String> strTransaction, <Array> arrRequest, strVersion )

Performs the given transaction by making AJAX call to the Proxy Server page.

Parameters:
strTransaction - Name of the transaction
arrRequest - Array of request objects

geocode

void geocode(<MQAddress> mqaAddress, <MQLocationCollection> mqlcLocations, <MQAutoGeocodeCovSwitch/MQGeocodeOptionsCollection> theOptions)

Method to geocode an address or an intersection. Geocode options supply the QualityType and MatchType.

Parameters:
mqaAddress - The Address object containing the necessary info for the address. (Please Note: This object will not be updated, it is simply used for the request.)
mqlcLocations - The LocationCollection to hold the results of the geocode.
theOptions - The AutoGeocodeCovSwitch or MQGeocodeOptionsCollection to select a set of options stored on the server. (Please Note: This object will not be updated, it is simply used for the request.)

getProxyServerName

String getProxyServerName()

Returns the name or IP of the proxy server to connect to.

Returns:
The name of the proxy server.

getRecordInfo

void getRecordInfo(<MQStringCollection> mqscFieldNames, <MQDBLayerQuery> mqdlqQuery, <MQRecordSet> mqrsResults, <MQStringCollection> mqscRecIds)

Generates a request to the MapQuest server (as specified by the server name, path, and port number) to perform a DB Search based on either the recordIds received or the extraCriteria info of the dblayerquery. The resulting recordset contains fields specified by the scFieldNames param.

Parameters:
mqscFieldNames - containing the names of the fields to return, or blank for all fields. (Please Note: This object will not be updated, it is simply used for the request.)
mqdlqQuery - Contains the name of the dblayer/table to query. Optionally contains ExtraCriteria. Utilized only if RecordIds are empty. (Please Note: This object will not be updated, it is simply used for the request.)
mqrsResults - The Returned RecordSet containg the records and fields matching the input parameters.
mqscRecIds - RecordIdentifiers of the records to return stored in a StringCollection. (Please Note: This object will not be updated, it is simply used for the request.)

getRequestXml

 <private> void getRequestXml(<String> strTransaction, <Array> arrRequest, <String> strVersion)

Prepares request XML data to be sent to the server for a given transaction and set of request objects.

Parameters:
strTransaction - Name of the transaction
arrRequest - Array of request objects to form the XML
strVersion - Version of the transaction implementation

getRouteBoundingBoxFromSessionResponse

 <private> void getRouteBoundingBoxFromSessionResponse(sessionId, <MQRectLL> mqRectLL)

Sets the mqRectLL appropriately for tilemaps routing

Parameters:
mqRectLL - The bounding box for the route in the session.
strSessionUID - The unique Session ID.

getServerInfo

Document getServerInfo( <int> lType )

Returns the string which specifies the coverage information requested directly via an http request.

Parameters:
lType - Type of info to return, 0=CoverageInfo, 1=MapDataSelectorInfo.

Returns:
The string which specifies the server information.

getServerName

String getServerName()

Returns the name of the server which will be used to satisfy this request.

Returns:
The name of the server which will be used to satisfy this request.

getServerPath

String getServerPath()

Returns the path to the server which will be used to satisfy this request.

Returns:
The path to the server which will be used to satisfy this request.

getServerPort

int getServerPort()

Returns the port number of the server which will be used to satisfy this request.

Returns:
The port number of the server which will be used to satisfy this request.

getSession

void getSession(strSessionID, mqObj)

isAlive

 <private> boolean isAlive()

Returns a value indicating whether or not this object has been initialized to a map server and port number.

Returns:
true if the port number or the Server name is not equal to their uninitialized values, false otherwise.

reverseGeocode

void reverseGeocode(<MQLatLng> mqllLatLng, <MQLocationCollection> mqlcLocations, <String> strMapCovName, <String> strGeocodeCovName)

Finds the address at a given latitude/longitude position.

Parameters:
mqllLatLng - The latitude/longitude position to use for the reverse geocode. (Please Note: This object will not be updated, it is simply used for the request.)
mqlcLocations - A LocationCollection in which to return the results of the reverse geocode. It will contain only GeoAddress objects.
strMapCovName - The name of the mapping coverage to be used for the reverse geocode.
strGeocodeCovName - An optional parameter, specifies the geocode coverage to use for the reverse geocode. If specified, using this geocode coverage, a ZIP code lookup will be performed on the addresses found in the mapping data to verify and fill in the city/state information for the address. If not specified, only ZIP code and, if available, street information found in the mapping data will be returned.

search

void search(<MQSearchCriteria> mqscCriteria, <MQFeatureCollection> mqfcSearchResults, <String> strCoverageName, <MQDBLayerQueryCollection> mqdlqcDbLayers, <MQFeatureCollection> mqfcFeatures, <MQDTCollection> mqdcDisplayTypes)

Generates a request to the MapQuest server (as specified by the server name, path, and port number) to perform a search and return the results in a FeatureCollection object.

Parameters:
mqscCriteria - Spatial parameters for the search. (Please Note: This object will not be updated, it is simply used for the request.)
mqfcSearchResults - Search results.
strCoverageName - The name of the map data coverage if searching for features in the map data.
mqdlqcDbLayers - Database parameters for the search. (Please Note: This object will not be updated, it is simply used for the request.)
mqfcFeatures - A FeatureCollection to also be searched based on the spatial criteria. (Please Note: This object will not be updated, it is simply used for the request.)
mqdcDisplayTypes - A DTCollection to narrow the search. Only those features with display types corresponding to those in this collection will be returned. (Please Note: This object will not be updated, it is simply used for the request.)

setProxyServerName

void setProxyServerName(<String> strProxyServerName)

Sets the name or IP of the proxy server to connect to. The name should not contain any leading or trailing slashes ("/").

Parameters:
strProxyServerName - The name of the proxy server.

setServerName

void setServerName(<String> strServerName)

Sets the name of the server which is to be used to satisfy this request.

Parameters:
strServerName - The name of the MapQuest Server which is to be used to satisfy this request.

setServerPath

void setServerPath(<String> strServerPath)

Sets the path to the server which is to be used to satisfy this request.

Parameters:
strServerPath - The path to the server which is to be used to satisfy this request.

setServerPort

void setServerPort(<int> nServerPort)

Sets the port number to the server which is to be used to satisfy this request.

Parameters:
nServerPort - The port number of the server which is to be used to satisfy this request.