oracle.panama.spatial.router
Class Maneuver

java.lang.Object
  |
  +--oracle.panama.spatial.router.Maneuver

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ManeuverStructured

public class Maneuver

extends java.lang.Object

implements java.io.Serializable

This class defines a single maneuver on a route. A single maneuver can be a turn that the driver has to make or any other non-trivial decision necessary to take the correct route.

This class defines immutable objects and is thread-safe.

See Also:

Serialized Form

Constructor Summary

Maneuver(java.lang.String narrative, double distance, int distUnit, java.awt.Image mapImg, java.net.URL mapImgURL, Point[] geometry)
Constructor.

Method Summary

double	getDistance() This returns the distance over which this maneuver spans.
double	getDistanceInMeters() This returns the distance over which this maneuver spans.
Point[]	getManeuverGeometry() This returns a list of points (lat/lon) along the maneuver.
java.awt.Image	getManeuverMap() This returns a map of this maneuver.
java.net.URL	getManeuverMapURL() This returns the URL of a map of this maneuver.
java.lang.String	getNarrative() This returns a textual representation of the directions of this maneuver.
java.lang.String	toString() This returns a textual representation of this Maneuver object.
java.lang.String	toString(boolean reqMapURL, boolean reqGeometry) This returns a textual representation of this Maneuver object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Maneuver

public Maneuver(java.lang.String narrative,
                double distance,
                int distUnit,
                java.awt.Image mapImg,
                java.net.URL mapImgURL,
Point[] geometry)

Constructor. Creates a Maneuver.

Parameters:

narrative - a String representing the textual directions

distance - a double representing the distance over which this maneuver spans

distUnit - the distance unit (see routing result)

mapImg - an Image representing a map of this maneuver

mapImgURL - a URL representing the URL of a map of this maneuver

geometry - an array of PointImpl representing a list of points (lat/lon) along the maneuver

Method Detail

getNarrative

public java.lang.String getNarrative()

This returns a textual representation of the directions of this maneuver.

Returns:

a String with the textual representation of the directions of this maneuver

getDistance

public double getDistance()

This returns the distance over which this maneuver spans.

Returns:

A double representing the distance over which this maneuver spans. The distance unit is meters.

getDistanceInMeters

public double getDistanceInMeters()

This returns the distance over which this maneuver spans.

Returns:

A double representing the distance over which this maneuver spans. The distance unit is meters.

getManeuverMap

public java.awt.Image getManeuverMap()

This returns a map of this maneuver.

Returns:

an Image representing a map of this maneuver

getManeuverMapURL

public java.net.URL getManeuverMapURL()

This returns the URL of a map of this maneuver.

Returns:

a URL representing the URL of a map of this maneuver

getManeuverGeometry

public Point[] getManeuverGeometry()

This returns a list of points (lat/lon) along the maneuver.

Returns:

an array of PointImpl representing a list of points (lat/lon) along the maneuver

toString

public java.lang.String toString()

This returns a textual representation of this Maneuver object.

Overrides:

toString in class java.lang.Object

Returns:

a String representing a textual representation of this Maneuver object

toString

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

This returns a textual representation of this Maneuver object.

Parameters:

reqMapURL - a boolean representing whether the map URLs should be included in the textual representation

reqGeometry - a boolean representing whether the point lists (lat/lon) should be included in the textual representation

Returns:

a String representing a textual representation of this Maneuver object