|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines routing service providers. Any class implementing this interface should be thread-safe.
Method Summary | |
RoutingResult |
computeRoute(Location source, Location destination, Location[] viaPoints, RoutingSettings opt, java.util.Locale locale) This function computes a route from a start address to an end address, possibly including via points. |
RoutingResult |
computeRoute(Point source, Point destination, Point[] viaPoints, RoutingSettings opt, java.util.Locale locale) This function computes a route from a start point to an end point, possibly including via points. |
Ranking |
rankByDrivingDistance(Point source, Point[] locations) This function ranks an array of Point objects by driving distance from a common source Point. |
java.lang.String |
xmlRoute(org.w3c.dom.Document xmlRequest) This function performs routing based on an XML request (eLocation XML). |
Method Detail |
public RoutingResult computeRoute(Location source, Location destination, Location[] viaPoints, RoutingSettings opt, java.util.Locale locale)
source
- a Location object representing the start addressdestination
- a Location object representing the end addressviaPoints
- an array of Location objects representing the via addresses (might be null)opt
- a RoutingSettings object representing the detail options for routing, such as whether a routing map is requestedlocale
- a Locale object that might be used to affect the language of the result text or other settings (often, this Locale might not affect the result)public RoutingResult computeRoute(Point source, Point destination, Point[] viaPoints, RoutingSettings opt, java.util.Locale locale)
source
- a Point object representing the start pointdestination
- a Point object representing the end pointviaPoints
- an array of Point objects representing the via points (might be null)opt
- a RoutingSettings object representing the detail options for routing, such as whether a routing map is requestedlocale
- a Locale object that might be used to affect the language of the result text or other settings (often, this Locale might not affect the result)public Ranking rankByDrivingDistance(Point source, Point[] locations)
source
- a Point representing the common sourcelocations
- an array of Point objects representing the list to be sorted (ranked)public java.lang.String xmlRoute(org.w3c.dom.Document xmlRequest)
xmlRequest
- a Document object representing the XMl document of the routing request.
|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |