com.inrix.sdk

Class IncidentsManager.IncidentBoxOptions

java.lang.Object

com.inrix.sdk.IncidentsManager.IncidentBoxOptions

Enclosing class:

IncidentsManager

public static final class IncidentsManager.IncidentBoxOptions
extends Object

Contains options that specify which incidents in a box to return.

See Also:

IncidentsManager.getIncidentsInBox(com.inrix.sdk.IncidentsManager.IncidentBoxOptions, com.inrix.sdk.IncidentsManager.IIncidentsResponseListener)

Constructor Summary

Constructors

Constructor and Description
IncidentBoxOptions(GeoPoint corner1, GeoPoint corner2) Initializes a new instance of the IncidentsManager.IncidentBoxOptions.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
GeoPoint	getCorner1() Gets corner 1 of the bounding box.
GeoPoint	getCorner2() Gets the second corner of the bounding box.
int	hashCode()
IncidentsManager.IncidentBoxOptions	setCorner1(GeoPoint corner1) Sets the first corner of the bounding rectangle.
IncidentsManager.IncidentBoxOptions	setCorner2(GeoPoint corner2) Sets the second corner of the region in which to get data.
T	setIncidentSource(int incidentSource) Sets the requested source of the incidents.
T	setIncidentType(int incidentType) Sets the type of incidents to be returned.
T	setOutputFields(int value) Sets the output fields of the incident.
T	setSeverity(Integer[] severity) Filters incident reports based on severity level.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IncidentBoxOptions

public IncidentBoxOptions(GeoPoint corner1,
                  GeoPoint corner2)

Initializes a new instance of the IncidentsManager.IncidentBoxOptions.

Parameters:

corner1 - First corner of the bounding rectangle that contains the incidents to return. The corner specified by the corner1 parameter can be any of the four corners of the bounding rectangle.

corner2 - The second corner of the region in which to get data. The corner2 parameter is diagonally opposite of corner1.

Throws:

IncidentsManager.IncidentsManagerException - Thrown when corner1 or corner2 is invalid.

Method Detail

getCorner1

public GeoPoint getCorner1()

Gets corner 1 of the bounding box.

Returns:

First corner of the bounding box.

setCorner1

public IncidentsManager.IncidentBoxOptions setCorner1(GeoPoint corner1)

Sets the first corner of the bounding rectangle. The corner specified by the corner1 parameter can be any of the four corners of the bounding rectangle.

Parameters:

corner1 - The first corner of the bounding box.

Returns:

This instance of the class.

Throws:

IncidentsManager.IncidentsManagerException - when corner1 is invalid.

getCorner2

public GeoPoint getCorner2()

Gets the second corner of the bounding box.

Returns:

Second corner of the bounding box, diagonally opposite to corner 1.

setCorner2

public IncidentsManager.IncidentBoxOptions setCorner2(GeoPoint corner2)

Sets the second corner of the region in which to get data. The corner2 parameter is diagonally opposite of corner 1.

Parameters:

corner2 - The second corner of the bounding box.

Returns:

This instance of the class.

Throws:

IncidentsManager.IncidentsManagerException - when corner2 is invalid.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

setIncidentType

public T setIncidentType(int incidentType)

Sets the type of incidents to be returned. The default is "ALL" (see IncidentsManager.INCIDENT_RESULT_TYPE_ALL). Multiple types can be specified by using the "or" operator.

Parameters:

incidentType - One or more incident types.

Returns:

This instance of the class.

setIncidentSource

public T setIncidentSource(int incidentSource)

Sets the requested source of the incidents.

A value of IncidentsManager.INCIDENT_SOURCE_INRIXONLY specifies that incidents are compiled from non-commercial sources, such as flow incidents that are generated programmatically from Inrix traffic information or planned construction incidents. A value of IncidentsManager.INCIDENT_SOURCE_COMMUNITY specifies that incidents come from community sources, such as incidents submitted through mobile devices. The default is IncidentsManager.INCIDENT_SOURCE_ALL. *

Parameters:

incidentSource - The source of the incident information.

Returns:

This instance of the class.

setOutputFields

public T setOutputFields(int value)

Sets the output fields of the incident.

Parameters:

value - Output fields. Can be IncidentsManager.INCIDENT_OUTPUT_FIELD_ALL or any combination of the following:

• IncidentsManager.INCIDENT_OUTPUT_FIELD_ID
• IncidentsManager.INCIDENT_OUTPUT_FIELD_VERSION
• IncidentsManager.INCIDENT_OUTPUT_FIELD_TYPE
• IncidentsManager.INCIDENT_OUTPUT_FIELD_SEVERITY
• IncidentsManager.INCIDENT_OUTPUT_FIELD_EVENT_CODE
• IncidentsManager.INCIDENT_OUTPUT_FIELD_LATLONG
• IncidentsManager.INCIDENT_OUTPUT_FIELD_IMPACTING
• IncidentsManager.INCIDENT_OUTPUT_FIELD_START_TIME
• IncidentsManager.INCIDENT_OUTPUT_FIELD_END_TIME
• IncidentsManager.INCIDENT_OUTPUT_FIELD_DELAY_IMPACT
• IncidentsManager.INCIDENT_OUTPUT_FIELD_PARAMETERIZED_DESCRIPTION
• IncidentsManager.INCIDENT_OUTPUT_FIELD_SHORT_DESCRIPTION
• IncidentsManager.INCIDENT_OUTPUT_FIELD_FULL_DESCRIPTION
• IncidentsManager.INCIDENT_OUTPUT_FIELD_HEAD_TAIL

Returns:

Current instance.

setSeverity

public T setSeverity(Integer[] severity)

Filters incident reports based on severity level. This value can be in the range of IncidentsManager.INCIDENT_SEVERITY_0- IncidentsManager.INCIDENT_SEVERITY_4, with IncidentsManager.INCIDENT_SEVERITY_4 indicating the highest severity. Multiple severity values can be specified. All severities are returned by default.

Parameters:

severity - The set of incident severities.

Returns:

This instance of the class.

Throws:

IncidentsManager.IncidentsManagerException - when severity is invalid.