From eff5b60ef303de111218e1f0d51469eebd089fef Mon Sep 17 00:00:00 2001 From: Landon Reed Date: Mon, 13 Jul 2020 16:23:59 -0400 Subject: [PATCH] refactor: address PR #288 comments --- .../conveyal/datatools/manager/jobs/MergeFeedsJob.java | 4 ++++ .../conveyal/datatools/manager/jobs/MergeFeedsType.java | 8 ++++++++ 2 files changed, 12 insertions(+) diff --git a/src/main/java/com/conveyal/datatools/manager/jobs/MergeFeedsJob.java b/src/main/java/com/conveyal/datatools/manager/jobs/MergeFeedsJob.java index 58d0740b6..6b25e2aa4 100644 --- a/src/main/java/com/conveyal/datatools/manager/jobs/MergeFeedsJob.java +++ b/src/main/java/com/conveyal/datatools/manager/jobs/MergeFeedsJob.java @@ -134,6 +134,10 @@ public class MergeFeedsJob extends MonitorableJob { public final String projectId; public final MergeFeedsType mergeType; private File mergedTempFile = null; + /** + * If {@link MergeFeedsJob} storeNewVersion variable is true, a new version will be created from the merged GTFS + * dataset. Otherwise, this will be null throughout the life of the job. + */ final FeedVersion mergedVersion; public boolean failOnDuplicateTripId = true; diff --git a/src/main/java/com/conveyal/datatools/manager/jobs/MergeFeedsType.java b/src/main/java/com/conveyal/datatools/manager/jobs/MergeFeedsType.java index c70faaf61..6c9e61b1c 100644 --- a/src/main/java/com/conveyal/datatools/manager/jobs/MergeFeedsType.java +++ b/src/main/java/com/conveyal/datatools/manager/jobs/MergeFeedsType.java @@ -1,6 +1,14 @@ package com.conveyal.datatools.manager.jobs; +/** + * This enum contains the types of merge feeds that {@link MergeFeedsJob} can currently perform. + */ public enum MergeFeedsType { + /** Merge feed versions that represent different transit agencies (usually operating in the same geographic region */ REGIONAL, + /** + * Merge two feed versions from the same transit agency that contain service for different time periods (usually to + * combine two overlapping time periods, for example, the current schedules and the future schedules). + */ SERVICE_PERIOD }