Oracle Application Server Wireless Java API Reference
B14043-01


oracle.panama.spatial.traffic
Interface TrafficReporter


public interface TrafficReporter

Provide functions that return traffic report with different queries.


Field Summary
static java.lang.String DAY
          A constant to indicate the day time unit
static java.lang.String EAST
          A constant to indicate east
static java.lang.String HOUR
          A constant to indicate the hour time unit
static int KILOMETERS
          A constant to indicate the kilometers unit
static int MILES
          A constant to indicate the miles unit
static java.lang.String MINUTE
          A constant to indicate the minute time unit
static java.lang.String MONTH
          A constant to indicate the month time unit
static java.lang.String NORTH
          A constant to indicate north
static double RADIUS
          The default radius for a location/address query
static java.lang.String SOUTH
          A constant to indicate south
static java.lang.String UNKNOWN
          A constant to indicate an unknown direction
static java.lang.String WEST
          A constant to indicate west
static java.lang.String YEAR
          A constant to indicate the year time unit

 

Method Summary
 TrafficCityManager getCityManager()
          Returns the city manager
 TrafficReport getReportViaAddress(Location address, double radius, int unit)
          Return a report with the incidents information on a circle area.
 TrafficReport getReportViaCity(CityInfo city)
          Return a report with the incidents information all over the city.
 TrafficReport getReportViaLocation(Point location, double radius, int unit)
          Return a report with the incidents information on the requested circle area.
 TrafficReport getReportViaLocation(Point location, double radius, int unit, CityInfo city)
          Return a report with the incidents information on a requested circle area.
 TrafficReport getReportViaRoute(RouteInfo route, CityInfo city)
          Return a report with the incidents information only on the requested route.
 TrafficReport getReportViaRoute(RouteInfo route, java.lang.String direction, CityInfo city)
          Return a report with the incidents information only on the requested direction of the route.
 java.lang.String xmlTraffic(org.w3c.dom.Document xmlRequest)
           

 

Field Detail

DAY

public static final java.lang.String DAY
A constant to indicate the day time unit
See Also:
Constant Field Values

EAST

public static final java.lang.String EAST
A constant to indicate east
See Also:
Constant Field Values

HOUR

public static final java.lang.String HOUR
A constant to indicate the hour time unit
See Also:
Constant Field Values

KILOMETERS

public static final int KILOMETERS
A constant to indicate the kilometers unit
See Also:
Constant Field Values

MILES

public static final int MILES
A constant to indicate the miles unit
See Also:
Constant Field Values

MINUTE

public static final java.lang.String MINUTE
A constant to indicate the minute time unit
See Also:
Constant Field Values

MONTH

public static final java.lang.String MONTH
A constant to indicate the month time unit
See Also:
Constant Field Values

NORTH

public static final java.lang.String NORTH
A constant to indicate north
See Also:
Constant Field Values

RADIUS

public static final double RADIUS
The default radius for a location/address query
See Also:
Constant Field Values

SOUTH

public static final java.lang.String SOUTH
A constant to indicate south
See Also:
Constant Field Values

UNKNOWN

public static final java.lang.String UNKNOWN
A constant to indicate an unknown direction
See Also:
Constant Field Values

WEST

public static final java.lang.String WEST
A constant to indicate west
See Also:
Constant Field Values

YEAR

public static final java.lang.String YEAR
A constant to indicate the year time unit
See Also:
Constant Field Values

Method Detail

getCityManager

public TrafficCityManager getCityManager()
Returns the city manager
Returns:
the instance of TrafficCityManager which is used for querying cities and routes information.
See Also:
TrafficCityManager

getReportViaAddress

public TrafficReport getReportViaAddress(Location address,
                                         double radius,
                                         int unit)
                                  throws LBSException
Return a report with the incidents information on a circle area.
Parameters:
address - an Location instance including the address information
Returns:
the instance of TrafficReport
Throws:
LBSException
See Also:
TrafficReport

getReportViaCity

public TrafficReport getReportViaCity(CityInfo city)
                               throws LBSException
Return a report with the incidents information all over the city.
Returns:
the instance of TrafficReport
Throws:
LBSException
See Also:
TrafficReport

getReportViaLocation

public TrafficReport getReportViaLocation(Point location,
                                          double radius,
                                          int unit)
                                   throws LBSException
Return a report with the incidents information on the requested circle area.
Returns:
the instance of TrafficReport
Throws:
LBSException
See Also:
TrafficReport

getReportViaLocation

public TrafficReport getReportViaLocation(Point location,
                                          double radius,
                                          int unit,
                                          CityInfo city)
                                   throws LBSException
Return a report with the incidents information on a requested circle area.
Returns:
the instance of TrafficReport
Throws:
LBSException
See Also:
TrafficReport

getReportViaRoute

public TrafficReport getReportViaRoute(RouteInfo route,
                                       CityInfo city)
                                throws LBSException
Return a report with the incidents information only on the requested route.
Returns:
the instance of TrafficReport
Throws:
LBSException
See Also:
TrafficReport

getReportViaRoute

public TrafficReport getReportViaRoute(RouteInfo route,
                                       java.lang.String direction,
                                       CityInfo city)
                                throws LBSException
Return a report with the incidents information only on the requested direction of the route.
Returns:
the instance of TrafficReport
Throws:
LBSException
See Also:
TrafficReport

xmlTraffic

public java.lang.String xmlTraffic(org.w3c.dom.Document xmlRequest)
                            throws LBSException
Throws:
LBSException

Oracle Application Server Wireless Java API Reference
B14043-01


Copyright © 2004 Oracle Corporation. All Rights Reserved.