Add documentation

opentripplanner · Sep 5, 2024 · eae78db · eae78db
1 parent b4993d1
commit eae78db
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 8 deletions.
diff --git a/...tortiles/layers/stops/StopPredicates.java → ...ectortiles/layers/stops/LayerFilters.java b/...tortiles/layers/stops/StopPredicates.java → ...ectortiles/layers/stops/LayerFilters.java
@@ -9,10 +9,21 @@
 import org.opentripplanner.transit.model.site.RegularStop;
 import org.opentripplanner.transit.service.TransitService;
 
-public class StopPredicates {
+/**
+ * Predicates for filtering elements of vector tile layers. Currently only contains predicates
+ * for {@link RegularStop}. Once more types need to be filtered, this may need some refactoring.
+ */
+public class LayerFilters {
 
+  /**
+   * No filter is applied: all stops are included in the result.
+   */
   public static final Predicate<RegularStop> NO_FILTER = x -> true;
 
+  /**
+   * Returns a predicate which only includes stop which are visited by a pattern that is in the current
+   * TriMet service week, namely from Sunday to Sunday.
+   */
   public static Predicate<RegularStop> currentServiceWeek(TransitService transitService) {
     var serviceDate = LocalDate.now(transitService.getTimeZone());
     var lastSunday = serviceDate.with(TemporalAdjusters.previousOrSame(DayOfWeek.SUNDAY));

diff --git a/src/ext/java/org/opentripplanner/ext/vectortiles/layers/stops/StopsLayerBuilder.java b/src/ext/java/org/opentripplanner/ext/vectortiles/layers/stops/StopsLayerBuilder.java
@@ -38,7 +38,7 @@ public StopsLayerBuilder(
       layerParameters.expansionFactor()
     );
     this.transitService = transitService;
-    this.filter = StopPredicates.forType(layerParameters.filterType(), transitService);
+    this.filter = LayerFilters.forType(layerParameters.filterType(), transitService);
   }
 
   protected List<Geometry> getGeometries(Envelope query) {

diff --git a/src/main/java/org/opentripplanner/inspector/vector/LayerParameters.java b/src/main/java/org/opentripplanner/inspector/vector/LayerParameters.java
@@ -1,7 +1,7 @@
 package org.opentripplanner.inspector.vector;
 
 import org.opentripplanner.apis.support.mapping.PropertyMapper;
-import org.opentripplanner.ext.vectortiles.layers.stops.StopPredicates;
+import org.opentripplanner.ext.vectortiles.layers.stops.LayerFilters;
 
 /**
  * Configuration options for a single vector tile layer.
@@ -55,7 +55,7 @@ default double expansionFactor() {
     return EXPANSION_FACTOR;
   }
 
-  default StopPredicates.FilterType filterType() {
-    return StopPredicates.FilterType.NONE;
+  default LayerFilters.FilterType filterType() {
+    return LayerFilters.FilterType.NONE;
   }
 }
diff --git a/src/main/java/org/opentripplanner/standalone/config/routerconfig/VectorTileConfig.java b/src/main/java/org/opentripplanner/standalone/config/routerconfig/VectorTileConfig.java
@@ -14,7 +14,7 @@
 import javax.annotation.Nullable;
 import org.opentripplanner.ext.vectortiles.VectorTilesResource;
 import org.opentripplanner.ext.vectortiles.VectorTilesResource.LayerType;
-import org.opentripplanner.ext.vectortiles.layers.stops.StopPredicates;
+import org.opentripplanner.ext.vectortiles.layers.stops.LayerFilters;
 import org.opentripplanner.inspector.vector.LayerParameters;
 import org.opentripplanner.standalone.config.framework.json.NodeAdapter;
 
@@ -157,7 +157,7 @@ public static Layer mapLayer(NodeAdapter node) {
           elements should not be included in the result.
           """
         )
-        .asEnum(StopPredicates.FilterType.NONE)
+        .asEnum(LayerFilters.FilterType.NONE)
     );
   }
 
@@ -169,7 +169,7 @@ record Layer(
     int minZoom,
     int cacheMaxSeconds,
     double expansionFactor,
-    StopPredicates.FilterType filterType
+    LayerFilters.FilterType filterType
   )
     implements LayerParameters<VectorTilesResource.LayerType> {}
 }