org.opentripplanner.model.calendar.impl.CalendarServiceDataFactoryImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation
Show all versions of otp Show documentation
The OpenTripPlanner multimodal journey planning system
/* This file is based on code copied from project OneBusAway, see the LICENSE file for further information. */
package org.opentripplanner.model.calendar.impl;
import org.opentripplanner.model.Agency;
import org.opentripplanner.model.FeedScopedId;
import org.opentripplanner.model.calendar.CalendarServiceData;
import org.opentripplanner.model.calendar.ServiceCalendar;
import org.opentripplanner.model.calendar.ServiceCalendarDate;
import org.opentripplanner.model.calendar.ServiceDate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TimeZone;
import static java.util.stream.Collectors.groupingBy;
/**
* We perform initial date calculations in the timezone of the host jvm, which
* may be different than the timezone of an agency with the specified service
* id. To my knowledge, the calculation should work the same, which is to say I
* can't immediately think of any cases where the service dates would be
* computed incorrectly.
*
* @author bdferris
*/
public class CalendarServiceDataFactoryImpl {
private static final Logger LOG = LoggerFactory.getLogger(CalendarServiceDataFactoryImpl.class);
private final List agencies;
private final Map> calendarDatesByServiceId;
private final Map> calendarsByServiceId;
private final Set serviceIds;
public static CalendarServiceData createCalendarServiceData(
Collection agencies,
Collection calendarDates,
Collection serviceCalendars
) {
return new CalendarServiceDataFactoryImpl(agencies, calendarDates, serviceCalendars)
.createData();
}
private CalendarServiceDataFactoryImpl(
Collection agencies,
Collection calendarDates,
Collection serviceCalendars
) {
this.agencies = new ArrayList<>(agencies);
this.calendarDatesByServiceId = calendarDates
.stream()
.collect(groupingBy(ServiceCalendarDate::getServiceId));
this.calendarsByServiceId = serviceCalendars
.stream()
.collect(groupingBy(ServiceCalendar::getServiceId));
this.serviceIds = merge(calendarDatesByServiceId.keySet(), calendarsByServiceId.keySet());
}
private CalendarServiceData createData() {
CalendarServiceData data = new CalendarServiceData();
setTimeZonesForAgencies(data);
int index = 0;
for (FeedScopedId serviceId : serviceIds) {
index++;
LOG.debug("serviceId=" + serviceId + " (" + index + "/" + serviceIds.size() + ")");
TimeZone serviceIdTimeZone = data.getTimeZoneForAgencyId(data
.getAgencyIds()
.stream()
.filter(agency -> agency.getFeedId().equals(serviceId.getFeedId()))
.findAny()
.orElse(null));
if (serviceIdTimeZone == null) {
serviceIdTimeZone = TimeZone.getDefault();
}
Set activeDates = getServiceDatesForServiceId(serviceId,
serviceIdTimeZone);
List serviceDates = new ArrayList<>(activeDates);
Collections.sort(serviceDates);
data.putServiceDatesForServiceId(serviceId, serviceDates);
}
return data;
}
private Set getServiceDatesForServiceId(FeedScopedId serviceId,
TimeZone serviceIdTimeZone) {
Set activeDates = new HashSet<>();
ServiceCalendar c = findCalendarForServiceId(serviceId);
if (c != null) {
addDatesFromCalendar(c, serviceIdTimeZone, activeDates);
}
List dates = calendarDatesByServiceId.get(serviceId);
if(dates != null) {
for (ServiceCalendarDate cd : dates) {
addAndRemoveDatesFromCalendarDate(cd, activeDates);
}
}
return activeDates;
}
private ServiceCalendar findCalendarForServiceId(FeedScopedId serviceId) {
List calendars = calendarsByServiceId.get(serviceId);
if(calendars == null || calendars.isEmpty()) {
return null;
}
if(calendars.size() == 1) {
return calendars.get(0);
}
throw new MultipleCalendarsForServiceIdException(serviceId);
}
private void setTimeZonesForAgencies(CalendarServiceData data) {
for (Agency agency : agencies) {
TimeZone timeZone = TimeZone.getTimeZone(agency.getTimezone());
if (timeZone.getID().equals("GMT") && !agency.getTimezone().toUpperCase()
.equals("GMT")) {
throw new UnknownAgencyTimezoneException(agency.getName(), agency.getTimezone());
}
data.putTimeZoneForAgencyId(agency.getId(), timeZone);
}
}
private void addDatesFromCalendar(ServiceCalendar calendar, TimeZone timeZone,
Set activeDates) {
// We calculate service dates relative to noon so as to avoid any weirdness
// relative to DST.
Date startDate = getServiceDateAsNoon(calendar.getPeriod().getStart(), timeZone);
Date endDate = getServiceDateAsNoon(calendar.getPeriod().getEnd(), timeZone);
java.util.Calendar c = java.util.Calendar.getInstance(timeZone);
c.setTime(startDate);
while (true) {
Date date = c.getTime();
if (date.after(endDate))
break;
int day = c.get(java.util.Calendar.DAY_OF_WEEK);
boolean active = false;
switch (day) {
case java.util.Calendar.MONDAY:
active = calendar.getMonday() == 1;
break;
case java.util.Calendar.TUESDAY:
active = calendar.getTuesday() == 1;
break;
case java.util.Calendar.WEDNESDAY:
active = calendar.getWednesday() == 1;
break;
case java.util.Calendar.THURSDAY:
active = calendar.getThursday() == 1;
break;
case java.util.Calendar.FRIDAY:
active = calendar.getFriday() == 1;
break;
case java.util.Calendar.SATURDAY:
active = calendar.getSaturday() == 1;
break;
case java.util.Calendar.SUNDAY:
active = calendar.getSunday() == 1;
break;
}
if (active) {
addServiceDate(activeDates, new ServiceDate(c));
}
c.add(java.util.Calendar.DAY_OF_YEAR, 1);
}
}
private void addAndRemoveDatesFromCalendarDate(ServiceCalendarDate calendarDate,
Set activeDates) {
ServiceDate serviceDate = calendarDate.getDate();
Date targetDate = calendarDate.getDate().getAsDate();
Calendar c = Calendar.getInstance();
c.setTime(targetDate);
switch (calendarDate.getExceptionType()) {
case ServiceCalendarDate.EXCEPTION_TYPE_ADD:
addServiceDate(activeDates, serviceDate);
break;
case ServiceCalendarDate.EXCEPTION_TYPE_REMOVE:
activeDates.remove(serviceDate);
break;
default:
LOG.warn("unknown CalendarDate exception type: " + calendarDate.getExceptionType());
break;
}
}
private void addServiceDate(Set activeDates, ServiceDate serviceDate) {
activeDates.add(serviceDate);
}
private static Date getServiceDateAsNoon(ServiceDate serviceDate, TimeZone timeZone) {
Calendar c = serviceDate.getAsCalendar(timeZone);
c.add(Calendar.HOUR_OF_DAY, 12);
return c.getTime();
}
/** package local to be unit testable */
static Set merge(Collection set1, Collection set2) {
Set newSet = new HashSet<>();
newSet.addAll(set1);
newSet.addAll(set2);
return newSet;
}
}