RoutingRequest (Ariadne JSON Route Format 1.1 API)

java.lang.Object
- at.ac.ait.ariadne.routeformat.RoutingRequest

All Implemented Interfaces:

Validatable
```
public class RoutingRequest
extends Object
implements Validatable
```
A RoutingRequest encapsulates typically required request parameters for an intermodal routing service.
In its minimal form it consists of from and to locations, at least one mode of transport, getOptimizedFor(), and either a departure or arrival time. The default constructor already sets DEFAULT_DEPARTURE_TIME and DEFAULT_OPTIMIZED_FOR.
Additional parameters, that will be different for each concrete routing service, can be added via getAdditionalInfo(): global parameters in this class, parameters valid only for a certain mode of transport via RequestModeOfTransport.getAdditionalInfo(). These additional parameters could e.g. include:
```
 only_use_mots_provided_by = ÖBB
 exclude_public_transport_line = WL_28A;WL_29A
 exclude_provider = CAT
 regional_bus = no
 accepted_delay_minutes = 10
 
```
For optional fields where no information is provided the routing service may fall back to its specific defaults.
Author:

AIT Austrian Institute of Technology GmbH

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_DEPARTURE_TIME

static String DEFAULT_OPTIMIZED_FOR

static String NOW

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_DEPARTURE_TIME`
`static String`	`DEFAULT_OPTIMIZED_FOR`
`static String`	`NOW`

Constructor Summary

Constructors
Constructor and Description

RoutingRequest()

Constructors
Constructor and Description
`RoutingRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RoutingRequest`	`createMinimal(Location<?> from, Location<?> to, List<RequestModeOfTransport<?>> modesOfTransport)` Creates a `RoutingRequest` with default departure time and default optimized for.
`boolean`	`equals(Object obj)`
`Set<Constants.AccessibilityRestriction>`	`getAccessibilityRestrictions()`
`Map<String,Object>`	`getAdditionalInfo()`
`Optional<String>`	`getArrivalTime()` Requested arrival time for the route.
`Optional<ZonedDateTime>`	`getArrivalTimeAsZonedDateTime()`
`Optional<String>`	`getDepartureTime()` Requested departure time for the route.
`Optional<ZonedDateTime>`	`getDepartureTimeAsZonedDateTime()`
`Optional<RequestModeOfTransport<?>>`	`getEndModeOfTransport()` One of the modes of transport in `getModesOfTransport()`, which the route must end with.
`Location<?>`	`getFrom()`
`List<String>`	`getLanguages()`
`List<Locale>`	`getLanguagesAsLocales()`
`Optional<Integer>`	`getMaximumTransfers()`
`List<RequestModeOfTransport<?>>`	`getModesOfTransport()` One or more modes of transport and their options that will be / were used for routing.
`String`	`getOptimizedFor()` Criteria the route will be / was optimized for, e.g.
`List<Constants.OutputFormat>`	`getOutputFormats()`
`Optional<String>`	`getSiteId()`
`Optional<RequestModeOfTransport<?>>`	`getStartModeOfTransport()` One of the modes of transport in `getModesOfTransport()`, which the route must start with.
`Location<?>`	`getTo()`
`List<Location<?>>`	`getVia()`
`int`	`hashCode()`
`RoutingRequest`	`setAccessibilityRestrictions(Set<Constants.AccessibilityRestriction> accessibilityRestrictions)`
`RoutingRequest`	`setAdditionalInfo(Map<String,Object> additionalInfo)`
`RoutingRequest`	`setArrivalTime(String arrivalTime)` Sets arrival time and erases departure time (if arrival time is not `null`)
`RoutingRequest`	`setArrivalTime(ZonedDateTime arrivalTime)` Sets arrival time and erases departure time (if arrival time is not `null`)
`RoutingRequest`	`setDepartureTime(String departureTime)` Sets departure time and erases arrival time (if departure time is not `null`)
`RoutingRequest`	`setDepartureTime(ZonedDateTime departureTime)` Sets departure time and erases arrival time (if departure time is not `null`)
`RoutingRequest`	`setEndModeOfTransport(RequestModeOfTransport<?> endModeOfTransport)`
`RoutingRequest`	`setFrom(Location<?> from)`
`RoutingRequest`	`setLanguages(List<String> languages)`
`RoutingRequest`	`setMaximumTransfers(Integer maximumTransfers)`
`RoutingRequest`	`setModesOfTransport(List<RequestModeOfTransport<?>> modesOfTransport)` Sets modes of transport.
`RoutingRequest`	`setOptimizedFor(String optimizedFor)`
`RoutingRequest`	`setOutputFormats(List<Constants.OutputFormat> outputFormats)`
`RoutingRequest`	`setSiteId(String siteId)`
`RoutingRequest`	`setStartModeOfTransport(RequestModeOfTransport<?> startModeOfTransport)`
`RoutingRequest`	`setTo(Location<?> to)`
`RoutingRequest`	`setVia(List<Location<?>> via)`
`String`	`toString()`
`void`	`validate()` Checks if the instance is in a valid / useful state.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NOW
```
public static final String NOW
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEPARTURE_TIME
```
public static final String DEFAULT_DEPARTURE_TIME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_OPTIMIZED_FOR
```
public static final String DEFAULT_OPTIMIZED_FOR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RoutingRequest
```
public RoutingRequest()
```
- Method Detail
  - getFrom
```
public Location<?> getFrom()
```
  - getVia
```
public List<Location<?>> getVia()
```
  - getTo
```
public Location<?> getTo()
```
  - getModesOfTransport
```
public List<RequestModeOfTransport<?>> getModesOfTransport()
```
    One or more modes of transport and their options that will be / were used for routing. In case of a single mode of transport unimodal routing is requested, in case of several modes of transport intermodal routing is requested.
    In case of intermodal routing it is guaranteed that the returned set contains a mode of transport with Constants.GeneralizedModeOfTransportType.FOOT.
  - getStartModeOfTransport
```
public Optional<RequestModeOfTransport<?>> getStartModeOfTransport()
```
    One of the modes of transport in getModesOfTransport(), which the route must start with. Only useful for intermodal routing, where routes start and end with with foot by default.
  - getEndModeOfTransport
```
public Optional<RequestModeOfTransport<?>> getEndModeOfTransport()
```
    One of the modes of transport in getModesOfTransport(), which the route must end with. Only useful for intermodal routing, where routes start and end with with foot by default.
  - getOptimizedFor
```
public String getOptimizedFor()
```
    Criteria the route will be / was optimized for, e.g. shortest travel time, which is also the default
  - getSiteId
```
public Optional<String> getSiteId()
```
    Returns:
    
    the Site the routing request should be restricted to. If it is not set the routing service has to determine itself which site to use, e.g. through checking the bounding boxes of the available sites
  - getMaximumTransfers
```
public Optional<Integer> getMaximumTransfers()
```
    Returns:
    
    maximum number of transfers not including the first and last 'transfer' to walking, i.e. walking to the a bike-sharing station, riding the bike, walking to the final destination counts as zero transfers (default = 3)
  - getDepartureTime
```
public Optional<String> getDepartureTime()
```
    Requested departure time for the route. Mutual exclusive with getArrivalTime(), it is guaranteed that exactly one of the two times is set.
    If neither departure time nor arrival time were set in the builder a departure time of 'now' is automatically added.
  - getDepartureTimeAsZonedDateTime
```
public Optional<ZonedDateTime> getDepartureTimeAsZonedDateTime()
```
    See Also:
    
    getDepartureTime()
  - getArrivalTime
```
public Optional<String> getArrivalTime()
```
    Requested arrival time for the route. Mutual exclusive with getDepartureTime(), it is guaranteed that exactly one of the two times is set.
  - getArrivalTimeAsZonedDateTime
```
public Optional<ZonedDateTime> getArrivalTimeAsZonedDateTime()
```
    See Also:
    
    getArrivalTime()
  - getAccessibilityRestrictions
```
public Set<Constants.AccessibilityRestriction> getAccessibilityRestrictions()
```
  - getLanguages
```
public List<String> getLanguages()
```
    Returns:
    
    the requested languages of the user in the form of IETF BCP 47 language tag strings (see Locale.forLanguageTag(String)). E.g. for navigation instructions or street or POI names. The first language is regarded the primary language.
  - getLanguagesAsLocales
```
public List<Locale> getLanguagesAsLocales()
```
  - getOutputFormats
```
public List<Constants.OutputFormat> getOutputFormats()
```
    Returns:
    
    the requested output formats
  - getAdditionalInfo
```
public Map<String,Object> getAdditionalInfo()
```
    Returns:
    
    a map of parameters to be considered during the routing process
  - setFrom
```
public RoutingRequest setFrom(Location<?> from)
```
  - setVia
```
public RoutingRequest setVia(List<Location<?>> via)
```
  - setTo
```
public RoutingRequest setTo(Location<?> to)
```
  - setModesOfTransport
```
public RoutingRequest setModesOfTransport(List<RequestModeOfTransport<?>> modesOfTransport)
```
    Sets modes of transport. Automatically adds ModeOfTransport.STANDARD_FOOT if it is missing for the intermodal case.
  - setStartModeOfTransport
```
public RoutingRequest setStartModeOfTransport(RequestModeOfTransport<?> startModeOfTransport)
```
  - setEndModeOfTransport
```
public RoutingRequest setEndModeOfTransport(RequestModeOfTransport<?> endModeOfTransport)
```
  - setOptimizedFor
```
public RoutingRequest setOptimizedFor(String optimizedFor)
```
  - setSiteId
```
public RoutingRequest setSiteId(String siteId)
```
  - setMaximumTransfers
```
public RoutingRequest setMaximumTransfers(Integer maximumTransfers)
```
  - setDepartureTime
```
public RoutingRequest setDepartureTime(ZonedDateTime departureTime)
```
    Sets departure time and erases arrival time (if departure time is not null)
  - setDepartureTime
```
public RoutingRequest setDepartureTime(String departureTime)
```
    Sets departure time and erases arrival time (if departure time is not null)
    
    Parameters:
    
    departureTime - either "NOW" or a valid date time string
  - setArrivalTime
```
public RoutingRequest setArrivalTime(ZonedDateTime arrivalTime)
```
    Sets arrival time and erases departure time (if arrival time is not null)
  - setArrivalTime
```
public RoutingRequest setArrivalTime(String arrivalTime)
```
    Sets arrival time and erases departure time (if arrival time is not null)
    
    Parameters:
    
    arrivalTime - either "NOW" or a valid date time string
  - setAccessibilityRestrictions
```
public RoutingRequest setAccessibilityRestrictions(Set<Constants.AccessibilityRestriction> accessibilityRestrictions)
```
  - setLanguages
```
public RoutingRequest setLanguages(List<String> languages)
```
  - setOutputFormats
```
public RoutingRequest setOutputFormats(List<Constants.OutputFormat> outputFormats)
```
  - setAdditionalInfo
```
public RoutingRequest setAdditionalInfo(Map<String,Object> additionalInfo)
```
  - createMinimal
```
public static RoutingRequest createMinimal(Location<?> from,
                                           Location<?> to,
                                           List<RequestModeOfTransport<?>> modesOfTransport)
```
    Creates a RoutingRequest with default departure time and default optimized for.
  - validate
```
public void validate()
```
    Description copied from interface: Validatable
    
    Checks if the instance is in a valid / useful state. If this is not the case an IllegalArgumentException including a description of the invalid state is thrown.
    
    Specified by:
    
    validate in interface Validatable
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RoutingRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOW

DEFAULT_DEPARTURE_TIME

DEFAULT_OPTIMIZED_FOR

Constructor Detail

RoutingRequest

Method Detail

getFrom

getVia

getTo

getModesOfTransport

getStartModeOfTransport

getEndModeOfTransport

getOptimizedFor

getSiteId

getMaximumTransfers

getDepartureTime

getDepartureTimeAsZonedDateTime

getArrivalTime

getArrivalTimeAsZonedDateTime

getAccessibilityRestrictions

getLanguages

getLanguagesAsLocales

getOutputFormats

getAdditionalInfo

setFrom

setVia

setTo

setModesOfTransport

setStartModeOfTransport

setEndModeOfTransport

setOptimizedFor

setSiteId

setMaximumTransfers

setDepartureTime

setDepartureTime

setArrivalTime

setArrivalTime

setAccessibilityRestrictions

setLanguages

setOutputFormats

setAdditionalInfo

createMinimal

validate

hashCode

equals

toString