com.hypertrack.sdk.views.dao

Class Trip

java.lang.Object

com.hypertrack.sdk.views.dao.Trip

public class Trip
extends Object

Data representation of device's trip. Serialization with Gson will create string same object as API returns. *

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Trip.Destination Encapsulates data related to trip destination.
static class	Trip.Estimate Encapsulates data related to estimated arrival at destination for current trip.
static class	Trip.Point2D Represents point on map.
static class	Trip.Route Route to trip's destination, that was assumed during estimation.
static class	Trip.Views

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARRIVAL_DELAYED
static String	COMPLETED
static String	DESTINATION_ARRIVAL
static String	DESTINATION_EXIT
static String	GEOFENCE_ENTERED
static String	GEOFENCE_EXIT
static String	METADATA_CHANGED
static String	REMAINING_DURATION_UPDATE
static String	ROUTE_RECALCULATED

Constructor Summary

Constructors

Constructor and Description
Trip(String tripId, String startedAt, String completedAt, String status, Trip.Destination destination, Trip.Estimate estimate, String metadata, Summary summary, Trip.Views views, List<GeofenceMarkerData.Geofence> geofences, String lastChangeReason)

Method Summary

Modifier and Type	Method and Description
String	getCompletedAt()
Trip.Destination	getDestination()
Date	getEndDate()
Trip.Estimate	getEstimate()
String	getMetadata()
Date	getStartDate()
String	getStartedAt()
String	getStatus()
Summary	getSummary()
String	getTripChangeReason()
String	getTripId()
Trip.Views	getViews()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DESTINATION_ARRIVAL

public static final String DESTINATION_ARRIVAL

See Also:

Constant Field Values

DESTINATION_EXIT

public static final String DESTINATION_EXIT

See Also:

Constant Field Values

ROUTE_RECALCULATED

public static final String ROUTE_RECALCULATED

See Also:

Constant Field Values

METADATA_CHANGED

public static final String METADATA_CHANGED

See Also:

Constant Field Values

COMPLETED

public static final String COMPLETED

See Also:

Constant Field Values

ARRIVAL_DELAYED

public static final String ARRIVAL_DELAYED

See Also:

Constant Field Values

REMAINING_DURATION_UPDATE

public static final String REMAINING_DURATION_UPDATE

See Also:

Constant Field Values

GEOFENCE_ENTERED

public static final String GEOFENCE_ENTERED

See Also:

Constant Field Values

GEOFENCE_EXIT

public static final String GEOFENCE_EXIT

See Also:

Constant Field Values

Constructor Detail

Trip

public Trip(String tripId,
            String startedAt,
            String completedAt,
            String status,
            Trip.Destination destination,
            Trip.Estimate estimate,
            String metadata,
            Summary summary,
            Trip.Views views,
            List<GeofenceMarkerData.Geofence> geofences,
            String lastChangeReason)

Method Detail

getViews

public Trip.Views getViews()

Returns:

Pair of urls, that could be used for sharing/embedding current trip.

getTripId

public String getTripId()

Returns:

unique identifier for this trip.

getStartedAt

public String getStartedAt()

Returns:

RFC 3339 compliant timestamp of start time.

See Also:

getStartDate()

getStartDate

public Date getStartDate()

Returns:

time of trip start.

See Also:

getStartedAt()

getCompletedAt

public String getCompletedAt()

Returns:

null, if trip haven't been completed yet, or RFC 3339 timestamp of end time.

See Also:

getEndDate()

getEndDate

public Date getEndDate()

Returns:

null, if trip haven't been completed yet, or time of trip end.

See Also:

getCompletedAt()

getStatus

public String getStatus()

Returns:

one of active, completed or processing_completion strings.

getDestination

public Trip.Destination getDestination()

Returns:

null if trip has no destination, or Trip.Destination object otherwise.

getEstimate

public Trip.Estimate getEstimate()

Returns:

null if estimate is not available for this trip or Trip.Estimate object otherwise.

getMetadata

public String getMetadata()

Returns:

device's metadata serialized as JSON.

getSummary

public Summary getSummary()

Returns:

null if trip haven't yet been completed or its summary otherwise.

getTripChangeReason

public String getTripChangeReason()

Returns:

null if this is the first trip object, that is delivered to subscribed receiver for each trip id, and one of DESTINATION_ARRIVAL, DESTINATION_EXIT, ROUTE_RECALCULATED, COMPLETED, ARRIVAL_DELAYED, GEOFENCE_ENTERED, GEOFENCE_EXIT, METADATA_CHANGED, REMAINING_DURATION_UPDATE constants otherwise.

toString

public String toString()

Overrides:

toString in class Object