oracle.panama.spatial.traffic
Interface TrafficIncident

public interface TrafficIncident

Represents a traffic incident.

Author:

Yingmei Sun

Field Summary

static java.lang.String	ACCIDENT
static java.lang.String	BADWEATHER
static java.lang.String	CONGESTION String CONGESTION, CONSTRUCTION, ACCIDENT, BADWEATHER and SPECIALEVENT are used to descibe incident type.
static java.lang.String	CONSTRUCTION
static java.lang.String	MAJOR
static java.lang.String	MINOR String MINOR, MODERATE and MAJOR are used to descibe incident severity.
static java.lang.String	MODERATE
static java.lang.String	SPECIALEVENT

Method Summary

java.lang.String	getAdvice() Return the advice for the incident.
java.lang.String	getDescription() Return the description of the incident.
java.lang.String	getDirection() Return the direction of the route on which the incident occurs.
int	getId() Return the id of the incident.
java.lang.String	getImpact() Return the impact of the incident on traffic.
Point	getIncidentLocation() Return the exact location of the incident.
TrafficRoute	getIncidentRoute() Return the route on which the incident occurs.
java.lang.String[]	getLocationRange() Return the text description of incident location range.
java.lang.String	getSeverity() Return the string indicating the severe level of the incident.
java.util.Calendar[]	getTimeRange() Return the time range of the incident.
double	getTrafficSpeed() Return the traffic speed related with the incident.
java.lang.String	getType() Return the type of the incident.

Field Detail

CONGESTION

public static final java.lang.String CONGESTION

String CONGESTION, CONSTRUCTION, ACCIDENT, BADWEATHER and SPECIALEVENT are used to descibe incident type.

See Also:

Constant Field Values

CONSTRUCTION

public static final java.lang.String CONSTRUCTION

See Also:

Constant Field Values

ACCIDENT

public static final java.lang.String ACCIDENT

See Also:

Constant Field Values

BADWEATHER

public static final java.lang.String BADWEATHER

See Also:

Constant Field Values

SPECIALEVENT

public static final java.lang.String SPECIALEVENT

See Also:

Constant Field Values

MINOR

public static final java.lang.String MINOR

String MINOR, MODERATE and MAJOR are used to descibe incident severity.

See Also:

Constant Field Values

MODERATE

public static final java.lang.String MODERATE

See Also:

Constant Field Values

MAJOR

public static final java.lang.String MAJOR

See Also:

Constant Field Values

Method Detail

getId

public int getId()

Return the id of the incident.

getSeverity

public java.lang.String getSeverity()

Return the string indicating the severe level of the incident. The value is "MINOR", "MODERATE" or "MAJOR". The default value is null.

getType

public java.lang.String getType()

Return the type of the incident. The value is "CONGESTION", "CONSTRUCTION", "ACCIDENT", "WEATHER RELATED" or "SPECIAL EVENT". If service provider does not provide this inforamtion, the default value is null.

getDescription

public java.lang.String getDescription()

Return the description of the incident. If service provider does not provide this inforamtion, the default value is null.

getImpact

public java.lang.String getImpact()

Return the impact of the incident on traffic. If service provider does not provide this inforamtion, the default value is null.

getAdvice

public java.lang.String getAdvice()

Return the advice for the incident. If service provider does not provide this inforamtion, the default value is null.

getIncidentRoute

public TrafficRoute getIncidentRoute()

Return the route on which the incident occurs.

Returns:

an instance of TrafficRoute, which is provider dependent. If service provider does not provide this inforamtion, the default value is null.

getTrafficSpeed

public double getTrafficSpeed()

Return the traffic speed related with the incident. If service provider does not provide this inforamtion, default value is Double.NAN.

getTimeRange

public java.util.Calendar[] getTimeRange()

Return the time range of the incident.

Returns:

an array of Calender. Two elements in the array means the incident has both start time and end time. One element in the array means the incident has only start time and no specified end time. If service provider does not provide this inforamtion, the default value is null.

getIncidentLocation

public Point getIncidentLocation()

Return the exact location of the incident. The location may be a point or an area which is represented by a point and a radius. See function getRadius() of Point. If service provider does not provide this inforamtion, the default value is null.

Returns:

instance of Point

See Also:

Point

getLocationRange

public java.lang.String[] getLocationRange()

Return the text description of incident location range.

Returns:

an array of String. The array has two elements if the incident is descibed by both "from" location and "to" location. The array has one element if the incident is described only by one location. If service provider does not provide this inforamtion, the default value is null.

getDirection

public java.lang.String getDirection()

Return the direction of the route on which the incident occurs. The default value is null. If service provider does not provide this inforamtion, the default value is null.