RouteSegment (Ariadne JSON Route Format 1.1 API)

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

All Implemented Interfaces:

Validatable
```
public class RouteSegment
extends Object
implements Validatable
```
A RouteSegment is a part of a route that is traveled with a single ModeOfTransport.
In its minimal form getNr(), getFrom(), getTo(), getDistanceMeters(), getDurationSeconds(), getModeOfTransport(), getStartTime(), getEndTime(), and at least one of the geometry types are present. Since this is a lot no createMinimal method is offered as its invocations would be hardly readable.
A note on public transport: transfers between two lines (e.g. from bus 28A to subway U6) can be represented in two variants.
1. PT_DETAILED: in this (preferred) variant a segment with Constants.DetailedModeOfTransportType.TRANSFER is inserted before, between, and after public transport segments. Such a transfer segment represents the transfer within a (logical) public transport station including waiting times for the next line. It contains the walking distance in the station ( getDistanceMeters()), the walking time ( getDurationSeconds() minus alighting time), and the waiting time for the next public transport line (getAlightingSeconds()). The public transport segments themselves only contain the ride time (without any boarding or alighting time). When using this variant it is much easier to differentiate between transfer and ride, e.g. regarding accessibility.
2. PT_CONDENSED: this variant is more compact but less detailed. Due to the missing transfer segments transfer and waiting time must be added to the public transport segment itself. It then contains the waiting time and optionally the the transfer time to the segment ( getBoardingSeconds()), the transfer time to the next segment ( getAlightingSeconds()), and of course the ride time ( getDurationSeconds() minus boarding and alighting time).
Author:

AIT Austrian Institute of Technology GmbH

Constructor Summary

Constructors
Constructor and Description

RouteSegment()

Constructors
Constructor and Description
`RouteSegment()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RouteSegment`	`createShallowCopy(RouteSegment s)`
`boolean`	`equals(Object obj)`
`List<Constants.Accessibility>`	`getAccessibility()`
`Map<String,Object>`	`getAdditionalInfo()`
`Optional<Integer>`	`getAlightingSeconds()` the number of seconds it takes to alight the mode of transport, e.g.
`ZonedDateTime`	`getArrivalTimeAsZonedDateTime()` the arrival time of this `RouteSegment`, i.e.
`Optional<Integer>`	`getBoardingSeconds()` the number of seconds it takes to board (or wait for) the mode of transport, e.g.
`Optional<GeoJSONFeature<GeoJSONPolygon>>`	`getBoundingBox()`
`ZonedDateTime`	`getDepartureTimeAsZonedDateTime()` the departure time of this `RouteSegment`, i.e.
`int`	`getDistanceMeters()`
`int`	`getDurationSeconds()` the total duration for this `RouteSegment` including `getBoardingSeconds()` and `getAlightingSeconds()`
`String`	`getEndTime()`
`ZonedDateTime`	`getEndTimeAsZonedDateTime()`
`Location<?>`	`getFrom()`
`Optional<String>`	`getGeometryEncodedPolyLine()` segment geometry in "Encoded Polyline Algorithm Format"
`Optional<GeoJSONFeature<GeoJSONLineString>>`	`getGeometryGeoJson()` segment geometry as a single LineString-Feature
`Optional<GeoJSONFeatureCollection<GeoJSONLineString>>`	`getGeometryGeoJsonEdges()` segment geometry as a collection of LineStrings (one for each edge in the routing graph) with debugging information for each edge
`List<IntermediateStop>`	`getIntermediateStops()` intermediate stops on the way (mostly useful for public transport routes)
`ModeOfTransport`	`getModeOfTransport()`
`List<Instruction<?>>`	`getNavigationInstructions()`
`int`	`getNr()` number of the segment in the route (starts with 1)
`String`	`getStartTime()` the start time of this `RouteSegment`, i.e.
`ZonedDateTime`	`getStartTimeAsZonedDateTime()`
`Location<?>`	`getTo()`
`int`	`getTravelTimeSeconds()` the pure travel time for this `RouteSegment` excluding `getBoardingSeconds()` and `getAlightingSeconds()`
`int`	`hashCode()`
`RouteSegment`	`setAccessibility(List<Constants.Accessibility> accessibility)`
`RouteSegment`	`setAdditionalInfo(Map<String,Object> additionalInfo)`
`RouteSegment`	`setAlightingSeconds(Integer alightingSeconds)`
`RouteSegment`	`setBoardingSeconds(Integer boardingSeconds)`
`RouteSegment`	`setBoundingBox(GeoJSONFeature<GeoJSONPolygon> boundingBox)`
`RouteSegment`	`setDistanceMeters(int distanceMeters)`
`RouteSegment`	`setDurationSeconds(int durationSeconds)`
`RouteSegment`	`setEndTime(String endTime)`
`RouteSegment`	`setEndTime(ZonedDateTime endTime)`
`RouteSegment`	`setFrom(Location<?> from)`
`RouteSegment`	`setGeometryEncodedPolyLine(String geometryEncodedPolyLine)`
`RouteSegment`	`setGeometryGeoJson(GeoJSONFeature<GeoJSONLineString> geometryGeoJson)`
`RouteSegment`	`setGeometryGeoJsonEdges(GeoJSONFeatureCollection<GeoJSONLineString> geometryGeoJsonEdges)`
`RouteSegment`	`setIntermediateStops(List<IntermediateStop> intermediateStops)`
`RouteSegment`	`setModeOfTransport(ModeOfTransport modeOfTransport)`
`RouteSegment`	`setNavigationInstructions(List<Instruction<?>> navigationInstructions)`
`RouteSegment`	`setNr(int nr)`
`RouteSegment`	`setStartTime(String startTime)`
`RouteSegment`	`setStartTime(ZonedDateTime startTime)`
`RouteSegment`	`setTo(Location<?> to)`
`RouteSegment`	`shiftBySeconds(int amountToAdd)` Shifts the segment in time by adjusting start and end time (if they are set)
`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
  - RouteSegment
```
public RouteSegment()
```
- Method Detail
  - getNr
```
public int getNr()
```
    number of the segment in the route (starts with 1)
  - getFrom
```
public Location<?> getFrom()
```
  - getTo
```
public Location<?> getTo()
```
  - getDistanceMeters
```
public int getDistanceMeters()
```
  - getDurationSeconds
```
public int getDurationSeconds()
```
    the total duration for this RouteSegment including getBoardingSeconds() and getAlightingSeconds()
  - getTravelTimeSeconds
```
public int getTravelTimeSeconds()
```
    the pure travel time for this RouteSegment excluding getBoardingSeconds() and getAlightingSeconds()
    Note: not exported to JSON since it can be inferred
  - getModeOfTransport
```
public ModeOfTransport getModeOfTransport()
```
  - getBoardingSeconds
```
public Optional<Integer> getBoardingSeconds()
```
    the number of seconds it takes to board (or wait for) the mode of transport, e.g. estimated time it takes to walk to your bicycle or car and unlock it, average time to hail a taxi, waiting time in case this is a public transport segment (PT_CONDENSED),..
  - getAlightingSeconds
```
public Optional<Integer> getAlightingSeconds()
```
    the number of seconds it takes to alight the mode of transport, e.g. estimated time it takes to look for a parking spot for your bicycle or car and lock/park it, average time to pay and leave a taxi, waiting time for the next public transport line in case this is a Constants.DetailedModeOfTransportType.TRANSFER segment (PT_DETAILED), transfer (walking) time in case this is a public transport segment (PT_CONDENSED),..
  - getStartTime
```
public String getStartTime()
```
    the start time of this RouteSegment, i.e. when boarding starts
  - getStartTimeAsZonedDateTime
```
public ZonedDateTime getStartTimeAsZonedDateTime()
```
  - getDepartureTimeAsZonedDateTime
```
public ZonedDateTime getDepartureTimeAsZonedDateTime()
```
    the departure time of this RouteSegment, i.e. after boarding is finished
    Note: not exported to JSON since it can be inferred
  - getArrivalTimeAsZonedDateTime
```
public ZonedDateTime getArrivalTimeAsZonedDateTime()
```
    the arrival time of this RouteSegment, i.e. when alighting starts
    Note: not exported to JSON since it can be inferred
  - getEndTime
```
public String getEndTime()
```
    Returns:
    
    the end time of this RouteSegment, i.e. when alighting is finished
  - getEndTimeAsZonedDateTime
```
public ZonedDateTime getEndTimeAsZonedDateTime()
```
  - getIntermediateStops
```
public List<IntermediateStop> getIntermediateStops()
```
    intermediate stops on the way (mostly useful for public transport routes)
  - getBoundingBox
```
public Optional<GeoJSONFeature<GeoJSONPolygon>> getBoundingBox()
```
  - getGeometryEncodedPolyLine
```
public Optional<String> getGeometryEncodedPolyLine()
```
    segment geometry in "Encoded Polyline Algorithm Format"
    
    See Also:
    
    "https://developers.google.com/maps/documentation/utilities/polylinealgorithm"
  - getGeometryGeoJson
```
public Optional<GeoJSONFeature<GeoJSONLineString>> getGeometryGeoJson()
```
    segment geometry as a single LineString-Feature
  - getGeometryGeoJsonEdges
```
public Optional<GeoJSONFeatureCollection<GeoJSONLineString>> getGeometryGeoJsonEdges()
```
    segment geometry as a collection of LineStrings (one for each edge in the routing graph) with debugging information for each edge
  - getNavigationInstructions
```
public List<Instruction<?>> getNavigationInstructions()
```
  - getAccessibility
```
public List<Constants.Accessibility> getAccessibility()
```
    Returns:
    
    the ordered list of potential obstacles for mobility impaired persons (e.g. first up the elevator, then up the stairs,..)
  - getAdditionalInfo
```
public Map<String,Object> getAdditionalInfo()
```
    Returns:
    
    additional information, e.g. other weights for the segment (energy,..)
  - setNr
```
public RouteSegment setNr(int nr)
```
  - setFrom
```
public RouteSegment setFrom(Location<?> from)
```
  - setTo
```
public RouteSegment setTo(Location<?> to)
```
  - setDistanceMeters
```
public RouteSegment setDistanceMeters(int distanceMeters)
```
  - setDurationSeconds
```
public RouteSegment setDurationSeconds(int durationSeconds)
```
  - setModeOfTransport
```
public RouteSegment setModeOfTransport(ModeOfTransport modeOfTransport)
```
  - setBoardingSeconds
```
public RouteSegment setBoardingSeconds(Integer boardingSeconds)
```
  - setAlightingSeconds
```
public RouteSegment setAlightingSeconds(Integer alightingSeconds)
```
  - setStartTime
```
public RouteSegment setStartTime(ZonedDateTime startTime)
```
  - setStartTime
```
public RouteSegment setStartTime(String startTime)
```
  - setEndTime
```
public RouteSegment setEndTime(ZonedDateTime endTime)
```
  - setEndTime
```
public RouteSegment setEndTime(String endTime)
```
  - setIntermediateStops
```
public RouteSegment setIntermediateStops(List<IntermediateStop> intermediateStops)
```
  - setBoundingBox
```
public RouteSegment setBoundingBox(GeoJSONFeature<GeoJSONPolygon> boundingBox)
```
  - setGeometryEncodedPolyLine
```
public RouteSegment setGeometryEncodedPolyLine(String geometryEncodedPolyLine)
```
  - setGeometryGeoJson
```
public RouteSegment setGeometryGeoJson(GeoJSONFeature<GeoJSONLineString> geometryGeoJson)
```
  - setGeometryGeoJsonEdges
```
public RouteSegment setGeometryGeoJsonEdges(GeoJSONFeatureCollection<GeoJSONLineString> geometryGeoJsonEdges)
```
  - setNavigationInstructions
```
public RouteSegment setNavigationInstructions(List<Instruction<?>> navigationInstructions)
```
  - setAccessibility
```
public RouteSegment setAccessibility(List<Constants.Accessibility> accessibility)
```
  - setAdditionalInfo
```
public RouteSegment setAdditionalInfo(Map<String,Object> additionalInfo)
```
  - shiftBySeconds
```
public RouteSegment shiftBySeconds(int amountToAdd)
```
    Shifts the segment in time by adjusting start and end time (if they are set)
  - createShallowCopy
```
public static RouteSegment createShallowCopy(RouteSegment s)
```
  - 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 RouteSegment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RouteSegment

Method Detail

getNr

getFrom

getTo

getDistanceMeters

getDurationSeconds

getTravelTimeSeconds

getModeOfTransport

getBoardingSeconds

getAlightingSeconds

getStartTime

getStartTimeAsZonedDateTime

getDepartureTimeAsZonedDateTime

getArrivalTimeAsZonedDateTime

getEndTime

getEndTimeAsZonedDateTime

getIntermediateStops

getBoundingBox

getGeometryEncodedPolyLine

getGeometryGeoJson

getGeometryGeoJsonEdges

getNavigationInstructions

getAccessibility

getAdditionalInfo

setNr

setFrom

setTo

setDistanceMeters

setDurationSeconds

setModeOfTransport

setBoardingSeconds

setAlightingSeconds

setStartTime

setStartTime

setEndTime

setEndTime

setIntermediateStops

setBoundingBox

setGeometryEncodedPolyLine

setGeometryGeoJson

setGeometryGeoJsonEdges

setNavigationInstructions

setAccessibility

setAdditionalInfo

shiftBySeconds

createShallowCopy

validate

validate

hashCode

equals

toString