RequestModeOfTransport (Ariadne JSON Route Format 1.1 API)

java.lang.Object
- at.ac.ait.ariadne.routeformat.RequestModeOfTransport<T>

All Implemented Interfaces:

Validatable

Direct Known Subclasses:

RequestPTModeOfTransport
```
public class RequestModeOfTransport<T extends RequestModeOfTransport<T>>
extends Object
implements Validatable
```
Encapsulates a ModeOfTransport and attributes exclusive to this mode of transport.
In its minimal form it only consists of a ModeOfTransport.
For simple cases use the static standard modes such as ModeOfTransport.STANDARD_BICYCLE to build a RequestModeOfTransport.
For complex cases, such as public transport or sharing providers the routing service would ideally provide an interface to retrieve the supported modes.

Author:

AIT Austrian Institute of Technology GmbH

Constructor Summary

Constructors
Constructor and Description

RequestModeOfTransport()

Constructors
Constructor and Description
`RequestModeOfTransport()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RequestModeOfTransport<?>`	`createMinimal(ModeOfTransport modeOfTransport)`
`boolean`	`equals(Object obj)`
`Map<String,Object>`	`getAdditionalInfo()` Other attributes exclusive to this `ModeOfTransport`.
`Optional<GeoJSONFeature<GeoJSONMultiPolygon>>`	`getForbiddenAreas()` A multipolygon defining areas the route must not cross
`List<Location<?>>`	`getLocations()` Locations where this mode of transport is available.
`Optional<Integer>`	`getMaximumDistanceMeters()` maximum distance to be covered with this mode of transport in one `RouteSegment`
`Optional<Integer>`	`getMaximumTravelTimeSeconds()` maximum travel time with this mode of transport in one `RouteSegment`
`ModeOfTransport`	`getModeOfTransport()`
`Optional<String>`	`getSpeed()` speed for this mode of transport - either one of `Constants.Speed` or a number in kph
`Optional<Integer>`	`getUserAffinity()` A user's affinity of the mode of transport, preferably in the range of 0 (does not like it at all) to 100 (loves it).
`int`	`hashCode()`
`T`	`setAdditionalInfo(Map<String,Object> additionalInfo)`
`T`	`setForbiddenAreas(GeoJSONFeature<GeoJSONMultiPolygon> forbiddenAreas)`
`T`	`setLocations(List<Location<?>> locations)`
`T`	`setMaximumDistanceMeters(Integer maximumDistanceMeters)`
`T`	`setMaximumTravelTimeSeconds(Integer maximumTravelTimeSeconds)`
`T`	`setModeOfTransport(ModeOfTransport modeOfTransport)`
`T`	`setSpeed(String speed)`
`T`	`setUserAffinity(Integer userAffinity)`
`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

- Constructor Detail
  - RequestModeOfTransport
```
public RequestModeOfTransport()
```
- Method Detail
  - getModeOfTransport
```
public ModeOfTransport getModeOfTransport()
```
  - getMaximumDistanceMeters
```
public Optional<Integer> getMaximumDistanceMeters()
```
    maximum distance to be covered with this mode of transport in one RouteSegment
  - getMaximumTravelTimeSeconds
```
public Optional<Integer> getMaximumTravelTimeSeconds()
```
    maximum travel time with this mode of transport in one RouteSegment
  - getUserAffinity
```
public Optional<Integer> getUserAffinity()
```
    A user's affinity of the mode of transport, preferably in the range of 0 (does not like it at all) to 100 (loves it). This parameter is useful for intermodal routing where users have preferences towards the available modes of transport. E.g. for a routing request with the modes bicycle (100% affinity) and public transport (25% affinity) the router should prefer the bicycle.
  - getSpeed
```
public Optional<String> getSpeed()
```
    speed for this mode of transport - either one of Constants.Speed or a number in kph
  - getLocations
```
public List<Location<?>> getLocations()
```
    Locations where this mode of transport is available. E.g. the location of private vehicles (typically a bicycle, car and/or motorcycle) that can be used when calculating the route. If not set vehicles can be assumed at their default location, e.g. private vehicles are available at the starting point of the route.
  - getForbiddenAreas
```
public Optional<GeoJSONFeature<GeoJSONMultiPolygon>> getForbiddenAreas()
```
    A multipolygon defining areas the route must not cross
  - getAdditionalInfo
```
public Map<String,Object> getAdditionalInfo()
```
    Other attributes exclusive to this ModeOfTransport.
  - setModeOfTransport
```
public T setModeOfTransport(ModeOfTransport modeOfTransport)
```
  - setMaximumDistanceMeters
```
public T setMaximumDistanceMeters(Integer maximumDistanceMeters)
```
  - setMaximumTravelTimeSeconds
```
public T setMaximumTravelTimeSeconds(Integer maximumTravelTimeSeconds)
```
  - setUserAffinity
```
public T setUserAffinity(Integer userAffinity)
```
  - setSpeed
```
public T setSpeed(String speed)
```
  - setLocations
```
public T setLocations(List<Location<?>> locations)
```
  - setForbiddenAreas
```
public T setForbiddenAreas(GeoJSONFeature<GeoJSONMultiPolygon> forbiddenAreas)
```
  - setAdditionalInfo
```
public T setAdditionalInfo(Map<String,Object> additionalInfo)
```
  - createMinimal
```
public static RequestModeOfTransport<?> createMinimal(ModeOfTransport modeOfTransport)
```
  - 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 RequestModeOfTransport<T extends RequestModeOfTransport<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestModeOfTransport

Method Detail

getModeOfTransport

getMaximumDistanceMeters

getMaximumTravelTimeSeconds

getUserAffinity

getSpeed

getLocations

getForbiddenAreas

getAdditionalInfo

setModeOfTransport

setMaximumDistanceMeters

setMaximumTravelTimeSeconds

setUserAffinity

setSpeed

setLocations

setForbiddenAreas

setAdditionalInfo

createMinimal

validate

hashCode

equals

toString