Route (Ariadne JSON Route Format 1.1 API)

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

All Implemented Interfaces:

Validatable
```
public class Route
extends Object
implements Validatable
```
A Route represents a way from A to B using one (unimodal route) or several (intermodal route) modes of transport. Its attributes such as the length refer to the whole route, which is further split up into RouteSegments for each mode of transport. A route can also consist only of a single Location, i.e. be a route from A to A, see createFromLocation(Location, ZonedDateTime).
In its minimal form nearly all attributes are set. The exceptions are getId(), getOptimizedFor(), getAdditionalInfo() and only one of the geometries is guaranteed to be set. Since this is a lot no createMinimal method is offered as its invocations would be hardly readable. Instead for easy construction createFromSegments(List) is recommended.

Author:

AIT Austrian Institute of Technology GmbH

Constructor Summary

Constructors
Constructor and Description

Route()

Constructors
Constructor and Description
`Route()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Route`	`createFromLocation(Location<?> location, ZonedDateTime time)` Create a route only consisting of a single location, i.e.
`static Route`	`createFromSegments(List<RouteSegment> segments)` Sets segments and infers from/to location, start/end time, duration, length, and bounding box (from geometryGeoJson)
`boolean`	`equals(Object obj)`
`Map<String,Object>`	`getAdditionalInfo()`
`Optional<GeoJSONFeature<GeoJSONPolygon>>`	`getBoundingBox()`
`int`	`getDistanceMeters()`
`int`	`getDurationSeconds()`
`String`	`getEndTime()`
`ZonedDateTime`	`getEndTimeAsZonedDateTime()`
`Location<?>`	`getFrom()`
`Optional<String>`	`getId()`
`Optional<String>`	`getOptimizedFor()`
`List<RouteSegment>`	`getSegments()`
`Optional<String>`	`getSimplifiedGeometryEncodedPolyLine()` geometry in "Encoded Polyline Algorithm Format"
`Optional<GeoJSONFeature<GeoJSONLineString>>`	`getSimplifiedGeometryGeoJson()`
`String`	`getStartTime()`
`ZonedDateTime`	`getStartTimeAsZonedDateTime()`
`Location<?>`	`getTo()`
`int`	`hashCode()`
`Route`	`setAdditionalInfo(Map<String,Object> additionalInfo)`
`Route`	`setBoundingBox(GeoJSONFeature<GeoJSONPolygon> boundingBox)`
`Route`	`setDistanceMeters(int distanceMeters)`
`Route`	`setDurationSeconds(int durationSeconds)`
`Route`	`setEndTime(String endTime)`
`Route`	`setEndTime(ZonedDateTime endTime)`
`Route`	`setFrom(Location<?> from)`
`Route`	`setId(String id)`
`Route`	`setOptimizedFor(String optimizedFor)`
`Route`	`setSegments(List<RouteSegment> segments)`
`Route`	`setSimplifiedGeometryEncodedPolyLine(String simplifiedGeometryEncodedPolyLine)`
`Route`	`setSimplifiedGeometryGeoJson(GeoJSONFeature<GeoJSONLineString> simplifiedGeometryGeoJson)`
`Route`	`setStartTime(String startTime)`
`Route`	`setStartTime(ZonedDateTime startTime)`
`Route`	`setTo(Location<?> to)`
`String`	`toString()`
`void`	`validate()` Checks if the instance is in a valid / useful state.
`void`	`validate(boolean strongValidation)`

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

Constructor Detail
- Route
```
public Route()
```

Method Detail

getFrom
```
public Location<?> getFrom()
```

getTo
```
public Location<?> getTo()
```

getDistanceMeters
```
public int getDistanceMeters()
```

getDurationSeconds
```
public int getDurationSeconds()
```

getSegments

public List<RouteSegment> getSegments()

getId
```
public Optional<String> getId()
```

getStartTime
```
public String getStartTime()
```

getStartTimeAsZonedDateTime

public ZonedDateTime getStartTimeAsZonedDateTime()

getEndTime
```
public String getEndTime()
```

getEndTimeAsZonedDateTime

public ZonedDateTime getEndTimeAsZonedDateTime()

getOptimizedFor
```
public Optional<String> getOptimizedFor()
```
Returns:

a description of the optimization criteria for calculating the route. This field is more specific than the one in RoutingRequest (and typically set when a RoutingResponse contains several (alternative) routes for one request.

getBoundingBox
```
public Optional<GeoJSONFeature<GeoJSONPolygon>> getBoundingBox()
```
Returns:

the bounding box with the points of the polygon beginning in south-west and then continuing clockwise

getSimplifiedGeometryEncodedPolyLine
```
public Optional<String> getSimplifiedGeometryEncodedPolyLine()
```
geometry in "Encoded Polyline Algorithm Format"

See Also:

"https://developers.google.com/maps/documentation/utilities/polylinealgorithm"

getSimplifiedGeometryGeoJson

public Optional<GeoJSONFeature<GeoJSONLineString>> getSimplifiedGeometryGeoJson()

getAdditionalInfo

public Map<String,Object> getAdditionalInfo()

setFrom

public Route setFrom(Location<?> from)

setTo
```
public Route setTo(Location<?> to)
```

setDistanceMeters

public Route setDistanceMeters(int distanceMeters)

setDurationSeconds

public Route setDurationSeconds(int durationSeconds)

setSegments

public Route setSegments(List<RouteSegment> segments)

setId
```
public Route setId(String id)
```

setStartTime

public Route setStartTime(ZonedDateTime startTime)

setStartTime

public Route setStartTime(String startTime)

setEndTime

public Route setEndTime(ZonedDateTime endTime)

setEndTime

public Route setEndTime(String endTime)

setOptimizedFor

public Route setOptimizedFor(String optimizedFor)

setBoundingBox

public Route setBoundingBox(GeoJSONFeature<GeoJSONPolygon> boundingBox)

setSimplifiedGeometryEncodedPolyLine

public Route setSimplifiedGeometryEncodedPolyLine(String simplifiedGeometryEncodedPolyLine)

setSimplifiedGeometryGeoJson

public Route setSimplifiedGeometryGeoJson(GeoJSONFeature<GeoJSONLineString> simplifiedGeometryGeoJson)

setAdditionalInfo

public Route setAdditionalInfo(Map<String,Object> additionalInfo)

createFromLocation

public static Route createFromLocation(Location<?> location,
                                       ZonedDateTime time)

Create a route only consisting of a single location, i.e. start and end point of the route are the same

createFromSegments
```
public static Route createFromSegments(List<RouteSegment> segments)
```
Sets segments and infers from/to location, start/end time, duration, length, and bounding box (from geometryGeoJson)

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

validate
```
public void validate(boolean strongValidation)
```
Parameters:

strongValidation - with strong validation even for minor errors an IllegalArgumentException is thrown (instead of a logged warning)

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 Route

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Route

Method Detail

getFrom

getTo

getDistanceMeters

getDurationSeconds

getSegments

getId

getStartTime

getStartTimeAsZonedDateTime

getEndTime

getEndTimeAsZonedDateTime

getOptimizedFor

getBoundingBox

getSimplifiedGeometryEncodedPolyLine

getSimplifiedGeometryGeoJson

getAdditionalInfo

setFrom

setTo

setDistanceMeters

setDurationSeconds

setSegments

setId

setStartTime

setStartTime

setEndTime

setEndTime

setOptimizedFor

setBoundingBox

setSimplifiedGeometryEncodedPolyLine

setSimplifiedGeometryGeoJson

setAdditionalInfo

createFromLocation

createFromSegments

validate

validate

hashCode

equals

toString