com.inrix.sdk

Class IncidentUtils

java.lang.Object

com.inrix.sdk.IncidentUtils

public class IncidentUtils
extends Object

Contains static methods that are useful in managing incidents.

Constructor Summary

Constructors

Constructor and Description
IncidentUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> List<T>	applyFilter(List<T> items, IFilter<T> filter) Filter the list with the user provided filter.
static Comparator<Incident>	getDefaultComparator() Gets the default incidents comparator for sorting for alerts.
static IFilter<Incident>	getDefaultFilter() Gets the default filter.
static Comparator<Incident>	getDefaultListComparator() Get default incidents comparator for sorting for displaying incidents in a list.
static IFilter<Incident>	getIncidentFilter(Set<Incident.IncidentType> incidentTypesAllowed) Get a custom filter which can selectively allow incidents.
static boolean	isRoadClosure(Integer eventCode) Returns whether an event code is a road closure, per ISO 14819-1:2003.

Methods inherited from class java.lang.Object

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

Constructor Detail

IncidentUtils

public IncidentUtils()

Method Detail

isRoadClosure

public static boolean isRoadClosure(Integer eventCode)

Returns whether an event code is a road closure, per ISO 14819-1:2003.

Parameters:

eventCode - The event code.

Returns:

true if the event code is a road closure; otherwise, false.

getDefaultComparator

public static Comparator<Incident> getDefaultComparator()

Gets the default incidents comparator for sorting for alerts. This comparator gives priority to most important incidents first, then prioritizes them by distance.

Returns:

The default comparator for alerts.

getDefaultListComparator

public static Comparator<Incident> getDefaultListComparator()

Get default incidents comparator for sorting for displaying incidents in a list. This comparator prioritizes them by distance first, then gives priority to most important incidents.

Returns:

The default comparator for displaying in a list.

getDefaultFilter

public static IFilter<Incident> getDefaultFilter()

Gets the default filter. This filter excludes Incident.IncidentType.CONSTRUCTION and Incident.IncidentType.UNKNOWN incidents.

Returns:

The default filter.

getIncidentFilter

public static IFilter<Incident> getIncidentFilter(@NonNull
                                  Set<Incident.IncidentType> incidentTypesAllowed)

Get a custom filter which can selectively allow incidents.

Parameters:

incidentTypesAllowed - A set of Incident.IncidentTypes that should return true when IFilter.isItemAllowed(T) is called.

Returns:

A custom Incident filter.

applyFilter

@NonNull
public static <T> List<T> applyFilter(List<T> items,
                              IFilter<T> filter)

Filter the list with the user provided filter.

Type Parameters:

T - Target list element type.

Parameters:

items - The list of items that needs to be filtered.

filter - The filter to apply to the list.

Returns:

The filtered list.