es.situm.sdk.model.directions

Class Route

java.lang.Object

es.situm.sdk.model.directions.Route

All Implemented Interfaces:

android.os.Parcelable, Graph<Point,RouteStep>

public class Route
extends Object
implements Graph<Point,RouteStep>, android.os.Parcelable

Route between two points.

Instances are immutable.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<Route>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Route(DirectionsRequest request, List<RouteStep> steps, List<Indication> indications, Building building, Collection<Floor> buildingFloors) Just for internal SDK use

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
Collection<RouteStep>	getEdges() Equal to getSteps().
RouteStep	getFirstStep() Returns first step
Point	getFrom() Point where the route starts.
List<Indication>	getIndications() Return ordered list of instructions to go to the destination
RouteStep	getLastStep() Returns last step
Collection<Point>	getNodes() Returns a collection of points of the route (not ordered)
List<Point>	getPoints() Returns list of ordered points of the route
DirectionsRequest	getRequest() Returns the search criteria, provided to DirectionsManager, whose result is the current Route.
InternalRouteInfo	getRouteInfo() Just for internal SDK use.
RouteStep	getStep(int stepId) Returns a route step by its RouteStep.getId()
List<RouteStep>	getSteps() Returns ordered list of steps to go to the goal point
Point	getTo() Last point and goal of the route.
int	hashCode()
Indication	indicationForNextStep(int routeStepIndex) Returns the next indication to a given step.
boolean	isAccessible() Returns whether the current route is suitable to wheel chairs (true) or not (false).
String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<Route> CREATOR

Constructor Detail

Route

public Route(DirectionsRequest request,
             List<RouteStep> steps,
             List<Indication> indications,
             Building building,
             Collection<Floor> buildingFloors)

Just for internal SDK use

Throws:

IllegalArgumentException - if null value is provided to NonNull parameter, or empty list is provided to size(min = 1) parameter

Method Detail

getEdges

public Collection<RouteStep> getEdges()

Equal to getSteps(). Allows handling Route as a Graph.

Specified by:

getEdges in interface Graph<Point,RouteStep>

getNodes

public Collection<Point> getNodes()

Returns a collection of points of the route (not ordered)

Specified by:

getNodes in interface Graph<Point,RouteStep>

Returns:

non-empty group of points

getPoints

public List<Point> getPoints()

Returns list of ordered points of the route

Returns:

non-empty group of points

getSteps

public List<RouteStep> getSteps()

Returns ordered list of steps to go to the goal point

Returns:

non-empty list of RouteStep

getFirstStep

public RouteStep getFirstStep()

Returns first step

Returns:

step whose RouteStep.getFrom() is the request parameter DirectionsRequest.getFrom()

getLastStep

public RouteStep getLastStep()

Returns last step

Returns:

step whose RouteStep.getTo() is the request parameter DirectionsRequest.getTo()

getStep

public RouteStep getStep(int stepId)

Returns a route step by its RouteStep.getId()

Parameters:

stepId - id of step (RouteStep.getId())

Returns:

step with provided id, or null if there is no match.

getRouteInfo

public InternalRouteInfo getRouteInfo()

Just for internal SDK use. This method can be changed at any version without previous deprecation warn.

getIndications

public List<Indication> getIndications()

Return ordered list of instructions to go to the destination

getRequest

public DirectionsRequest getRequest()

Returns the search criteria, provided to DirectionsManager, whose result is the current Route.

Returns:

original DirectionsRequest

isAccessible

public boolean isAccessible()

Returns whether the current route is suitable to wheel chairs (true) or not (false). Wraps DirectionsRequest.isAccessible() from getRequest().

Returns:

true if the route is suitable to wheel chairs

getFrom

public Point getFrom()

Point where the route starts. The same as DirectionsRequest.getFrom() from getRequest().

Returns:

Point

getTo

public Point getTo()

Last point and goal of the route. The same as DirectionsRequest.getTo() from getTo().

Returns:

Point

indicationForNextStep

public Indication indicationForNextStep(int routeStepIndex)

Returns the next indication to a given step. The indication can be associated to more than one steps.

Parameters:

routeStepIndex - the index of a route step inside a route

Returns:

Indication object or empty if the routeStepIndex is not valid

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable