com.hypertrack.sdk.views.dao

Class GeofenceMarkerData

java.lang.Object

com.hypertrack.sdk.views.dao.Marker.MarkerData

com.hypertrack.sdk.views.dao.GeofenceMarkerData

public class GeofenceMarkerData
extends Marker.MarkerData

Data, that associated with current spatial region (geofence) with respect to tracking. See Docs how to specify them while creating trip.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeofenceMarkerData.Geofence Circular geofence and its data

Method Summary

Modifier and Type	Method and Description
static GeofenceMarkerData	forCircularGeofence(String geofenceId, List<Double> coordinates, Integer radius, String arrivedAt, String exitedAt, String metadataInternal, Integer duration, MarkerRoute markerRoute, Location arrivalLocation, Location exitLocation)
static GeofenceMarkerData	forPolygonGeofence(String geofenceId, List<List<Double>> vertices, String arrivedAt, String exitedAt, String metadataInternal, Integer duration, MarkerRoute markerRoute, Location arrivalLocation, Location exitLocation)
Location	getArrival()
Integer	getDuration()
Location	getExit()
Double	getGeofenceCenterLatitude()
Double	getGeofenceCenterLongitude()
Date	getGeofenceEnterDate()
String	getGeofenceEnterTimestamp()
Date	getGeofenceExitDate()
String	getGeofenceExitTimestamp()
String	getGeofenceId()
String	getGeofenceMetadata()
Integer	getGeofenceRadius()
MarkerRoute	getRouteTo()
List<Trip.Point2D>	polyline()

Methods inherited from class java.lang.Object

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

Method Detail

forCircularGeofence

public static GeofenceMarkerData forCircularGeofence(String geofenceId,
                                                     List<Double> coordinates,
                                                     Integer radius,
                                                     String arrivedAt,
                                                     String exitedAt,
                                                     String metadataInternal,
                                                     Integer duration,
                                                     MarkerRoute markerRoute,
                                                     Location arrivalLocation,
                                                     Location exitLocation)

forPolygonGeofence

public static GeofenceMarkerData forPolygonGeofence(String geofenceId,
                                                    List<List<Double>> vertices,
                                                    String arrivedAt,
                                                    String exitedAt,
                                                    String metadataInternal,
                                                    Integer duration,
                                                    MarkerRoute markerRoute,
                                                    Location arrivalLocation,
                                                    Location exitLocation)

getDuration

public Integer getDuration()

Returns:

seconds spent in current geofence.

getRouteTo

public MarkerRoute getRouteTo()

Returns:

Route to this marker.

getArrival

public Location getArrival()

Returns:

RFC 3339 compliant value of geofence enter event.

getExit

public Location getExit()

Returns:

RFC 3339 compliant value of geofence exit event.

getGeofenceCenterLatitude

public Double getGeofenceCenterLatitude()

Returns:

latitude of circular geofence center point or null for polygon geofences.

See Also:

Location.getLatitude()

getGeofenceCenterLongitude

public Double getGeofenceCenterLongitude()

Returns:

longitude of circular geofence center point or null for polygon geofences.

See Also:

Location.getLongitude()

getGeofenceId

public String getGeofenceId()

Returns:

identifier for this geofence.

getGeofenceRadius

public Integer getGeofenceRadius()

Returns:

Geofence radius in meters. Any location that is closer than radius to geofence center is considered reaching geofence. Returns null for polygon geofences.

polyline

public List<Trip.Point2D> polyline()

getGeofenceEnterTimestamp

public String getGeofenceEnterTimestamp()

Returns:

RFC 3339 compliant timestamp of first event, when device approached geofence center closer than geofence radius.

See Also:

getGeofenceRadius(), getGeofenceEnterDate()

getGeofenceEnterDate

public Date getGeofenceEnterDate()

Returns:

time of first event, when device approached geofence center closer than geofence radius or null, if such an event haven't yet occurred.

See Also:

getGeofenceEnterTimestamp(), getGeofenceRadius()

getGeofenceExitTimestamp

public String getGeofenceExitTimestamp()

Returns:

RFC 3339 compliant timestamp of first event, when device moved away from center more than geofence radius, if such an event haven't yet occurred.

See Also:

getGeofenceExitDate(), getGeofenceRadius()

getGeofenceExitDate

public Date getGeofenceExitDate()

Returns:

time of first event, when device moved away from center more than geofence radius.

See Also:

getGeofenceRadius(), getGeofenceExitTimestamp()

getGeofenceMetadata

public String getGeofenceMetadata()

Returns:

metadata, that was specified during this geofence creation, serialized as JSON.