at.ac.ait.ariadne.routeformat

Class RoutingResponse

java.lang.Object

at.ac.ait.ariadne.routeformat.RoutingResponse

All Implemented Interfaces:

Validatable

public class RoutingResponse
extends Object
implements Validatable

A RoutingResponse encapsulates the response of routing services. It contains, amongst others, an optional RoutingRequest, a status, and of course one or more Route(s).

Since most attributes are mandatory no createMinimal method is offered.

The coordinate reference system is not directly set in the GeoJSON elements (as the specification would allow) because this would lead to unnecessarily big file sizes. Instead the CRS can optionally be set with the attribute getCoordinateReferenceSystem().

Author:

AIT Austrian Institute of Technology GmbH

Constructor Summary

Constructors

Constructor and Description
RoutingResponse()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Map<String,Object>	getAdditionalInfo()
String	getCoordinateReferenceSystem() in the form of EPSG:*, e.g.
Optional<String>	getDebugMessage() debug message explaining errors
String	getProcessedTime() Time when request / calculations were finished or deemed not possible in case of an error.
ZonedDateTime	getProcessedTimeAsZonedDateTime()
Optional<RoutingRequest>	getRequest()
String	getRequestId()
String	getRouteFormatVersion()
List<Route>	getRoutes()
Constants.Status	getStatus()
int	hashCode()
RoutingResponse	setAdditionalInfo(Map<String,Object> additionalInfo)
RoutingResponse	setCoordinateReferenceSystem(String coordinateReferenceSystem)
RoutingResponse	setDebugMessage(String debugMessage)
RoutingResponse	setDefaultCoordinateReferenceSystem()
RoutingResponse	setProcessedTime(String processedTime)
RoutingResponse	setProcessedTime(ZonedDateTime processedTime)
RoutingResponse	setProcessedTimeNow()
RoutingResponse	setRequest(RoutingRequest request)
RoutingResponse	setRequestId(String requestId)
RoutingResponse	setRouteFormatVersion(String routeFormatVersion)
RoutingResponse	setRoutes(List<Route> routes)
RoutingResponse	setStatus(Constants.Status status)
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

RoutingResponse

public RoutingResponse()

Method Detail

getRouteFormatVersion

public String getRouteFormatVersion()

getRequestId

public String getRequestId()

getProcessedTime

public String getProcessedTime()

Time when request / calculations were finished or deemed not possible in case of an error.

getProcessedTimeAsZonedDateTime

public ZonedDateTime getProcessedTimeAsZonedDateTime()

getStatus

public Constants.Status getStatus()

getDebugMessage

public Optional<String> getDebugMessage()

debug message explaining errors

getCoordinateReferenceSystem

public String getCoordinateReferenceSystem()

in the form of EPSG:*, e.g. EPSG:4326

getRequest

public Optional<RoutingRequest> getRequest()

Returns:

The original request used to calculate the route(s). It is guaranteed that if at least one route is returned there is also a request here. The request will only be omitted if the request itself could not be created due to invalid request parameters.

getAdditionalInfo

public Map<String,Object> getAdditionalInfo()

getRoutes

public List<Route> getRoutes()

setRouteFormatVersion

public RoutingResponse setRouteFormatVersion(String routeFormatVersion)

setRequestId

public RoutingResponse setRequestId(String requestId)

setProcessedTimeNow

public RoutingResponse setProcessedTimeNow()

setProcessedTime

public RoutingResponse setProcessedTime(ZonedDateTime processedTime)

setProcessedTime

public RoutingResponse setProcessedTime(String processedTime)

setStatus

public RoutingResponse setStatus(Constants.Status status)

setDebugMessage

public RoutingResponse setDebugMessage(String debugMessage)

setCoordinateReferenceSystem

public RoutingResponse setCoordinateReferenceSystem(String coordinateReferenceSystem)

setDefaultCoordinateReferenceSystem

public RoutingResponse setDefaultCoordinateReferenceSystem()

setRequest

public RoutingResponse setRequest(RoutingRequest request)

setRoutes

public RoutingResponse setRoutes(List<Route> routes)

setAdditionalInfo

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

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