Oracle Application Server Wireless Java API Reference
B10400-01

oracle.panama.spatial.router
Class RoutingResult

java.lang.Object
  |
  +--oracle.panama.spatial.router.RoutingResult
All Implemented Interfaces:
java.io.Serializable

public class RoutingResult
extends java.lang.Object
implements java.io.Serializable

This class defines the result of a routing service. Such a result contains a list of single maneuvers that are part of the complete route. This class defines immutable objects and is thread-safe.

See Also:
Serialized Form

Field Summary
static int HOUR
           
static int KILOMETERS
           
static int METERS
           
static int MILES
           
static int MINUTE
           
static int SECOND
           

 

Constructor Summary
RoutingResult(double time, int timeUnit, double distance, int distUnit, Point[] geometry, Maneuver[] maneuvers, java.awt.Image[] overviewMaps, java.net.URL[] overviewMapURLs)
          Constructor

 

Method Summary
 double getDistance()
          Get the total driving distance.
 double getDistanceInMeters()
           
 int getDistanceUnit()
          Get the distance unit.
 java.lang.String getDistanceUnitString()
          Get the distance unit in string format.
 Maneuver[] getManeuvers()
          Get the Maneuver array of the result.
 Point[] getOverviewGeometry()
          Get the geometry, i.e., shape points along the route.
 java.awt.Image[] getOverviewMap()
          Get the overview maps in Java Image.
 java.net.URL[] getOverviewMapURL()
          Get the URL of overview maps.
 ProviderCredit getRoutingProvider()
           
 double getTime()
          Get the total driving time.
 double getTimeInMinutes()
           
 int getTimeUnit()
          Get the time unit.
 java.lang.String getTimeUnitString()
          Get the time unit in string format.
 void setRoutingProvider(ProviderCredit credit)
           
 java.lang.String toString()
           
 java.lang.String toString(boolean reqMapURL, boolean reqGeometry)
           

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

MILES

public static final int MILES
See Also:
Constant Field Values

KILOMETERS

public static final int KILOMETERS
See Also:
Constant Field Values

SECOND

public static final int SECOND
See Also:
Constant Field Values

MINUTE

public static final int MINUTE
See Also:
Constant Field Values

HOUR

public static final int HOUR
See Also:
Constant Field Values

METERS

public static final int METERS
See Also:
Constant Field Values
Constructor Detail

RoutingResult

public RoutingResult(double time,
                     int timeUnit,
                     double distance,
                     int distUnit,
Point[] geometry,
Maneuver[] maneuvers,
                     java.awt.Image[] overviewMaps,
                     java.net.URL[] overviewMapURLs)
Constructor
Method Detail

getRoutingProvider

public ProviderCredit getRoutingProvider()

setRoutingProvider

public void setRoutingProvider(ProviderCredit credit)

getTime

public double getTime()
Get the total driving time.

getTimeInMinutes

public double getTimeInMinutes()

getDistance

public double getDistance()
Get the total driving distance.

getDistanceInMeters

public double getDistanceInMeters()

getTimeUnit

public int getTimeUnit()
Get the time unit. Currently supported time units are: SECOND -- second MINUTE -- minute HOUR -- hour

getTimeUnitString

public java.lang.String getTimeUnitString()
Get the time unit in string format.

getDistanceUnit

public int getDistanceUnit()
Get the distance unit. Currently supported distance units are: KILOMETERS -- Kilometer MILES -- Miles

getDistanceUnitString

public java.lang.String getDistanceUnitString()
Get the distance unit in string format.

getManeuvers

public Maneuver[] getManeuvers()
Get the Maneuver array of the result.

getOverviewMapURL

public java.net.URL[] getOverviewMapURL()
Get the URL of overview maps. Note that a route can have multiple overview maps because of possible via points.

getOverviewMap

public java.awt.Image[] getOverviewMap()
Get the overview maps in Java Image. This is currently not supported.

getOverviewGeometry

public Point[] getOverviewGeometry()
Get the geometry, i.e., shape points along the route.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toString

public java.lang.String toString(boolean reqMapURL,
                                 boolean reqGeometry)

Oracle Application Server Wireless Java API Reference
B10400-01

Copyright © 2003 Oracle Corporation. All Rights Reserved.