Package globus.glroute

Class GLRouteRequest

java.lang.Object
globus.glmap.GLNativeObject
globus.glroute.GLRouteRequest
public class GLRouteRequest extends GLNativeObject
Builds and executes online or offline route requests (Valhalla-based).

  • Constructor Details

    • GLRouteRequest

      public GLRouteRequest()
      Default constructor

    • GLRouteRequest

      public GLRouteRequest(@NonNull String userJSON)
      Constructor with custom json request to valhalla
      Parameters:
      userJSON - json request to valhalla

  • Method Details

    • startOnline

      public long startOnline(@NonNull GLRouteRequest.ResultsCallback callback)
      Starts an online route request.

      The callback may be invoked on a background thread.

      Parameters:
      callback - results callback
      Returns:
      id of task

    • startOffline

      public long startOffline(@NonNull String config, @NonNull GLRouteRequest.ResultsCallback callback)
      Starts an offline route request.

      The callback may be invoked on a background thread.

      Parameters:
      config - Contents of configuration file for routing engine Valhalla. See valhalla3.json inside the demoApp.
      callback - results callback
      Returns:
      id of task

    • offlineActionOrError

      @Nullable public static Object offlineActionOrError(@NonNull String action, @NonNull String request, @NonNull String config, @Nullable MapGeoPoint startPoint)
      Starts a synchronous offline Valhalla request.
      Parameters:
      action - Valhalla action (e.g. "route", "optimized_route", …).
      request - JSON string with the request payload.
      config - Contents of the Valhalla configuration file (see valhalla.json in the demo app).
      startPoint - Optional starting point in degrees used to speed up offline data lookup (pass null to skip).
      Returns:
      A JSON string with the response on success or a GLMapError instance on failure.

    • cancel

      public static void cancel(long requestID)
      Cancels a request started via startOnline(ResultsCallback) or startOffline(String, ResultsCallback).

      Cancellation is best-effort; already running work may still complete and invoke callbacks.

      Parameters:
      requestID - ID of request to cancel

    • addPoint

      public void addPoint(@NonNull GLRoutePoint point)
      Adds point
      Parameters:
      point - point to add

    • addExcludeLocation

      public void addExcludeLocation(@NonNull GLRoutePoint point)
      A location to exclude or avoid
      Parameters:
      point - point to add

    • addExcludePolygon

      public void addExcludePolygon(@NonNull MapGeoPoint[] points)
      Roads intersecting this polygon will be avoided during path finding. If you only need to avoid a few specific roads, it's much more efficient to use exclude locations.
      Parameters:
      points - points of polygon exterior ring

    • setRequestID

      public void setRequestID(@NonNull String requestID)
      Name your route request. If an ID is specified, the name will be sent through to the response.
      Parameters:
      requestID - request id

    • setAutoWithOptions

      public void setAutoWithOptions(@NonNull CostingOptions.Auto options)
      Sets navigation mode to auto
      Parameters:
      options - options

    • setBicycleWithOptions

      public void setBicycleWithOptions(@NonNull CostingOptions.Bicycle options)
      Sets navigation mode to cycle
      Parameters:
      options - options

    • setPedestrianWithOptions

      public void setPedestrianWithOptions(@NonNull CostingOptions.Pedestrian options)
      Sets navigation mode to walk
      Parameters:
      options - options

    • setStraightWithOptions

      public void setStraightWithOptions(@NonNull CostingOptions.Straight options)
      Sets navigation mode to straight
      Parameters:
      options - options

    • setBusWithOptions

      public void setBusWithOptions(@NonNull CostingOptions.Auto options)
      Sets navigation mode to bus
      Parameters:
      options - options

    • setBikeshareWithOptions

      public void setBikeshareWithOptions(@NonNull CostingOptions.Bicycle options)
      Sets navigation mode to bikeshare
      Parameters:
      options - options

    • setTruckWithOptions

      public void setTruckWithOptions(@NonNull CostingOptions.Truck options)
      Sets navigation mode to truck
      Parameters:
      options - options

    • setTaxiWithOptions

      public void setTaxiWithOptions(@NonNull CostingOptions.Auto options)
      Sets navigation mode to taxi
      Parameters:
      options - options

    • setMotorScooterWithOptions

      public void setMotorScooterWithOptions(@NonNull CostingOptions.MotorScooter options)
      Sets navigation mode to scooter
      Parameters:
      options - options

    • setMotorcycleWithOptions

      public void setMotorcycleWithOptions(@NonNull CostingOptions.Motorcycle options)
      Sets navigation mode to motorcycle
      Parameters:
      options - options

    • setOptimize

      public void setOptimize(boolean optimize)
      Sets whether the order of middle points can be optimized to create a faster route.

      By default, this option is false.

      Parameters:
      optimize - true to allow reordering middle points for a better route, false otherwise.

    • getOptimize

      public boolean getOptimize()
      Retrieves the current value of the optimize setting.
      Returns:
      true if middle points can be reordered, false otherwise.

    • getMode

      public int getMode()
      Retrieves the mode of the route.

      By default, the mode is GLRoute.Mode.AUTO.

      Returns:
      The mode of the route, defined by GLRoute.Mode.

    • setUnitSystem

      public void setUnitSystem(int unitSystem)
      Sets the unit system for route instructions.

      By default, the unit system is GLMapLocaleSettings.UnitSystem.International.

      Parameters:
      unitSystem - The unit system to use for instructions, defined by GLMapLocaleSettings.UnitSystem.

    • getUnitSystem

      public int getUnitSystem()
      Retrieves the unit system used for route instructions.
      Returns:
      The current unit system, defined by GLMapLocaleSettings.UnitSystem.

    • setLocale

      public void setLocale(String locale)
      Sets the locale for route instructions.

      By default, the locale is set to Locale.getDefault().getLanguage().

      Parameters:
      locale - The locale to use for instructions, represented as a language code (e.g., "en", "fr").

    • getLocale

      public String getLocale()
      Retrieves the locale used for route instructions.
      Returns:
      The locale for instructions, represented as a language code.

    • getJson

      public String getJson()
      Retrieves the JSON request that will be sent to Valhalla.
      Returns:
      A JSON string representing the route request.

    • setAlternates

      public void setAlternates(int alternates)
      A number denoting how many alternate routes should be provided. There may be no alternates or less alternates than the user specifies. Alternates are not yet supported on multipoint routes (that is, routes with more than 2 locations). They are also not supported on time dependent routes. By default = 2
      Parameters:
      alternates - alternates to set

    • getAlternates

      public int getAlternates()
      Get number of alternates
      Returns:
      number of alternates

    • bikeTypeToString

      public static String bikeTypeToString(int type)
      Converts BikeType to its string representation
      Parameters:
      type - type to convert
      Returns:
      string representation of type

    • bikeTypeFromString

      public static int bikeTypeFromString(String type)
      Converts the string representation of BikeType to its value
      Parameters:
      type - type to convert
      Returns:
      value