-
Notifications
You must be signed in to change notification settings - Fork 0
/
RoutingResponse.java
265 lines (230 loc) · 9.04 KB
/
RoutingResponse.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
package at.ac.ait.ariadne.routeformat;
import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.TreeMap;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Preconditions;
import at.ac.ait.ariadne.routeformat.Constants.Status;
import at.ac.ait.ariadne.routeformat.util.Utils;
/**
* A {@link RoutingResponse} encapsulates the response of routing services. It
* contains, amongst others, an optional {@link RoutingRequest}, a status, and
* of course one or more {@link Route}(s).
* <p>
* Since most attributes are mandatory no <code>createMinimal</code> method is
* offered.
* <p>
* 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
* {@link RoutingResponse#getCoordinateReferenceSystem()}.
*
* @author AIT Austrian Institute of Technology GmbH
*/
@JsonInclude(Include.NON_ABSENT)
public class RoutingResponse implements Validatable {
private String routeFormatVersion;
private String requestId;
private ZonedDateTime processedTime;
private Status status;
private Optional<String> debugMessage = Optional.empty();
private String coordinateReferenceSystem;
private Optional<RoutingRequest> request = Optional.empty();
private List<Route> routes = new ArrayList<>();
private Map<String, Object> additionalInfo = new TreeMap<>();
// -- getters
@JsonProperty(required = true)
public String getRouteFormatVersion() {
return routeFormatVersion;
}
@JsonProperty(required = true)
public String getRequestId() {
return requestId;
}
/**
* Time when request / calculations were finished or deemed not possible in
* case of an error.
*/
@JsonProperty(required = true)
public String getProcessedTime() {
return Utils.getDateTimeString(processedTime);
}
@JsonIgnore
public ZonedDateTime getProcessedTimeAsZonedDateTime() {
return processedTime;
}
@JsonProperty(required = true)
public Status getStatus() {
return status;
}
/** debug message explaining errors */
public Optional<String> getDebugMessage() {
return debugMessage;
}
/** in the form of EPSG:*, e.g. EPSG:4326 */
@JsonProperty(required = true)
public String getCoordinateReferenceSystem() {
return coordinateReferenceSystem;
}
/**
* @return 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.
*/
public Optional<RoutingRequest> getRequest() {
return request;
}
public Map<String, Object> getAdditionalInfo() {
return additionalInfo;
}
@JsonProperty(required = true)
public List<Route> getRoutes() {
return routes;
}
// -- setters
public RoutingResponse setRouteFormatVersion(String routeFormatVersion) {
this.routeFormatVersion = routeFormatVersion;
return this;
}
public RoutingResponse setRequestId(String requestId) {
this.requestId = requestId;
return this;
}
public RoutingResponse setProcessedTimeNow() {
this.processedTime = ZonedDateTime.now();
return this;
}
@JsonIgnore
public RoutingResponse setProcessedTime(ZonedDateTime processedTime) {
this.processedTime = processedTime;
return this;
}
@JsonProperty
public RoutingResponse setProcessedTime(String processedTime) {
this.processedTime = Utils.parseDateTime(processedTime, "processedTime");
return this;
}
public RoutingResponse setStatus(Status status) {
this.status = status;
return this;
}
public RoutingResponse setDebugMessage(String debugMessage) {
this.debugMessage = Optional.ofNullable(debugMessage);
return this;
}
public RoutingResponse setCoordinateReferenceSystem(String coordinateReferenceSystem) {
this.coordinateReferenceSystem = coordinateReferenceSystem;
return this;
}
public RoutingResponse setDefaultCoordinateReferenceSystem() {
this.coordinateReferenceSystem = "EPSG:4326";
return this;
}
public RoutingResponse setRequest(RoutingRequest request) {
this.request = Optional.ofNullable(request);
return this;
}
public RoutingResponse setRoutes(List<Route> routes) {
this.routes = new ArrayList<>(routes);
return this;
}
public RoutingResponse setAdditionalInfo(Map<String, Object> additionalInfo) {
this.additionalInfo = new TreeMap<>(additionalInfo);
return this;
}
// --
// no createMinimal! see javadoc for explanation.
@Override
public void validate() {
Preconditions.checkArgument(routeFormatVersion != null, "routeFormatVersion is mandatory but missing");
Preconditions.checkArgument(requestId != null, "requestId is mandatory but missing");
Preconditions.checkArgument(processedTime != null, "processedTime is mandatory but missing");
Preconditions.checkArgument(status != null, "status is mandatory but missing");
Preconditions.checkArgument(coordinateReferenceSystem != null,
"coordinateReferenceSystem is mandatory but missing");
Preconditions.checkArgument(coordinateReferenceSystem.startsWith("EPSG:"),
"coordinateReferenceSystem must start with EPSG:");
request.ifPresent(r -> r.validate());
routes.forEach(r -> r.validate());
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((additionalInfo == null) ? 0 : additionalInfo.hashCode());
result = prime * result + ((coordinateReferenceSystem == null) ? 0 : coordinateReferenceSystem.hashCode());
result = prime * result + ((debugMessage == null) ? 0 : debugMessage.hashCode());
result = prime * result + ((processedTime == null) ? 0 : processedTime.hashCode());
result = prime * result + ((request == null) ? 0 : request.hashCode());
result = prime * result + ((requestId == null) ? 0 : requestId.hashCode());
result = prime * result + ((routeFormatVersion == null) ? 0 : routeFormatVersion.hashCode());
result = prime * result + ((routes == null) ? 0 : routes.hashCode());
result = prime * result + ((status == null) ? 0 : status.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
RoutingResponse other = (RoutingResponse) obj;
if (additionalInfo == null) {
if (other.additionalInfo != null)
return false;
} else if (!additionalInfo.equals(other.additionalInfo))
return false;
if (coordinateReferenceSystem == null) {
if (other.coordinateReferenceSystem != null)
return false;
} else if (!coordinateReferenceSystem.equals(other.coordinateReferenceSystem))
return false;
if (debugMessage == null) {
if (other.debugMessage != null)
return false;
} else if (!debugMessage.equals(other.debugMessage))
return false;
if (processedTime == null) {
if (other.processedTime != null)
return false;
} else if (!processedTime.equals(other.processedTime))
return false;
if (request == null) {
if (other.request != null)
return false;
} else if (!request.equals(other.request))
return false;
if (requestId == null) {
if (other.requestId != null)
return false;
} else if (!requestId.equals(other.requestId))
return false;
if (routeFormatVersion == null) {
if (other.routeFormatVersion != null)
return false;
} else if (!routeFormatVersion.equals(other.routeFormatVersion))
return false;
if (routes == null) {
if (other.routes != null)
return false;
} else if (!routes.equals(other.routes))
return false;
if (status != other.status)
return false;
return true;
}
@Override
public String toString() {
return "RoutingResponse [requestId=" + requestId + ", processedTime=" + processedTime + ", status=" + status
+ ", routes=" + routes.size() + "]";
}
}