/
StopForecastUtil.java
227 lines (192 loc) · 9.54 KB
/
StopForecastUtil.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
/**
* @author Aaron Hastings
*
* Copyright 2015-2018 Aaron Hastings
*
* This file is part of Luas at a Glance.
*
* Luas at a Glance is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Luas at a Glance is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Luas at a Glance. If not, see <http://www.gnu.org/licenses/>.
*/
package org.thecosmicfrog.luasataglance.util;
import android.util.Log;
import android.view.View;
import org.thecosmicfrog.luasataglance.R;
import org.thecosmicfrog.luasataglance.api.ApiTimes;
import org.thecosmicfrog.luasataglance.object.StopForecast;
import org.thecosmicfrog.luasataglance.object.Tram;
import org.thecosmicfrog.luasataglance.view.TutorialCardView;
public final class StopForecastUtil {
private static final String LOG_TAG = StopForecastUtil.class.getSimpleName();
/**
* Determine if this is the first time the app has been launched and, if so, display a brief
* tutorial on how to use a particular feature of the app.
* @param rootView Root View.
* @param line Currently-selected line.
* @param tutorial Tutorial to display.
* @param shouldDisplay Whether or not tutorial should display.
*/
public static void displayTutorial(View rootView, String line, String tutorial,
boolean shouldDisplay) {
/* Only display tutorials on the Red Line tab. */
if (line.equals(Constant.RED_LINE)) {
switch (tutorial) {
case Constant.TUTORIAL_SELECT_STOP:
TutorialCardView tutorialCardViewSelectStop =
(TutorialCardView) rootView.findViewById(
R.id.tutorialcardview_select_stop
);
tutorialCardViewSelectStop.setTutorial(
rootView.getContext().getResources().getText(
R.string.select_stop_tutorial
)
);
if (shouldDisplay) {
if (!Preferences.hasRunOnce(rootView.getContext(), tutorial)) {
Log.i(
LOG_TAG,
"First time launching. Displaying select stop tutorial."
);
tutorialCardViewSelectStop.setVisibility(View.VISIBLE);
Preferences.saveHasRunOnce(rootView.getContext(), tutorial, true);
Analytics.tutorialBegin(
rootView.getContext(),
"tutorial_begin",
"select_stop_begin"
);
}
} else {
tutorialCardViewSelectStop.setVisibility(View.GONE);
}
break;
case Constant.TUTORIAL_NOTIFICATIONS:
TutorialCardView tutorialCardViewNotifications =
(TutorialCardView) rootView.findViewById(
R.id.tutorialcardview_notifications
);
tutorialCardViewNotifications.setTutorial(
rootView.getContext().getResources().getText(
R.string.notifications_tutorial
)
);
if (shouldDisplay) {
if (!Preferences.hasRunOnce(rootView.getContext(), tutorial)) {
Log.i(
LOG_TAG,
"First time launching. Displaying notifications tutorial."
);
tutorialCardViewNotifications.setVisibility(View.VISIBLE);
Analytics.tutorialBegin(
rootView.getContext(),
"tutorial_begin",
"notifications_begin"
);
}
} else {
tutorialCardViewNotifications.setVisibility(View.GONE);
}
break;
case Constant.TUTORIAL_FAVOURITES:
TutorialCardView tutorialCardViewFavourites =
(TutorialCardView) rootView.findViewById(
R.id.tutorialcardview_favourites
);
tutorialCardViewFavourites.setTutorial(
rootView.getContext().getResources().getText(
R.string.favourites_tutorial
)
);
if (shouldDisplay) {
if (!Preferences.hasRunOnce(rootView.getContext(), tutorial)) {
Log.i(LOG_TAG, "First time launching. Displaying favourites tutorial.");
tutorialCardViewFavourites.setVisibility(View.VISIBLE);
Analytics.tutorialBegin(
rootView.getContext(),
"tutorial_begin",
"favourites_begin"
);
}
} else {
tutorialCardViewFavourites.setVisibility(View.GONE);
}
break;
default:
/* If for some reason the specified tutorial doesn't make sense. */
Log.wtf(LOG_TAG, "Invalid tutorial specified.");
}
}
}
/**
* Create a usable stop forecast with the data returned from the server.
* @param apiTimes ApiTimes object created by Retrofit, containing raw stop forecast data.
* @return Usable stop forecast.
*/
public static StopForecast createStopForecast(ApiTimes apiTimes) {
StopForecast stopForecast = new StopForecast();
if (apiTimes.getMessage() != null) {
stopForecast.setMessage(apiTimes.getMessage());
}
if (apiTimes.getStopForecastStatus() != null) {
if (apiTimes.getStopForecastStatus().getStopForecastStatusDirectionInbound() != null) {
if (apiTimes.getStopForecastStatus().getStopForecastStatusDirectionInbound()
.getMessage() != null) {
stopForecast.getStopForecastStatusDirectionInbound().setMessage(
apiTimes.getStopForecastStatus()
.getStopForecastStatusDirectionInbound().getMessage()
);
stopForecast.getStopForecastStatusDirectionInbound().setForecastsEnabled(
apiTimes.getStopForecastStatus()
.getStopForecastStatusDirectionInbound().getForecastsEnabled()
);
stopForecast.getStopForecastStatusDirectionInbound().setOperatingNormally(
apiTimes.getStopForecastStatus()
.getStopForecastStatusDirectionInbound().getOperatingNormally()
);
}
}
if (apiTimes.getStopForecastStatus().getStopForecastStatusDirectionOutbound() != null) {
if (apiTimes.getStopForecastStatus().getStopForecastStatusDirectionOutbound()
.getMessage() != null) {
stopForecast.getStopForecastStatusDirectionOutbound().setMessage(
apiTimes.getStopForecastStatus()
.getStopForecastStatusDirectionOutbound().getMessage()
);
stopForecast.getStopForecastStatusDirectionOutbound().setForecastsEnabled(
apiTimes.getStopForecastStatus()
.getStopForecastStatusDirectionOutbound().getForecastsEnabled()
);
stopForecast.getStopForecastStatusDirectionOutbound().setOperatingNormally(
apiTimes.getStopForecastStatus()
.getStopForecastStatusDirectionOutbound().getOperatingNormally()
);
}
}
}
if (apiTimes.getTrams() != null) {
for (Tram tram : apiTimes.getTrams()) {
switch (tram.getDirection()) {
case "Inbound":
stopForecast.addInboundTram(tram);
break;
case "Outbound":
stopForecast.addOutboundTram(tram);
break;
default:
/* If for some reason the direction doesn't make sense. */
Log.wtf(LOG_TAG, "Invalid direction: " + tram.getDirection());
}
}
}
return stopForecast;
}
}