Add option roadClasses

README.md

@@ -8,7 +8,15 @@ Support for non-OSM data sources has been moved to the [sharedstreets-conflator]
 
 **Example use**
 
-`java -jar ./sharedstreets-builder-0.1-preview.jar --input data/[osm_input_file].pbf --output ./[tile_output_directory]
+`java -jar build/libs/sharedstreets-builder-0.3.1.jar --input data/[osm_input_file].pbf --output ./[tile_output_directory]
+`
+
+**Filtered Road Classes**
+
+Since v0.3 this tool generates tiles with hierarchically filtered road classes. Tiles with e.g. suffix `.2.pbf only contain road classes Motorway (0), Trunk (1) and Primary (2).
+Per default, tiles up to road class Unclassified (6) are generated. To create tiles up to road class Other (8), you may specify an optional `roadClasses` argument, providing the comma separated road classes tiles should be generated for:
+
+`java -jar build/libs/sharedstreets-builder-0.3.1.jar --input data/[osm_input_file].pbf --output ./[tile_output_directory] --roadClasses 0,1,2,4,6,8
 `
 
 **Notes**
@@ -20,4 +28,4 @@ The builder application is built on Apache Flink. If memory requirements exceed
 
 - [*v0.1:*](https://github.com/sharedstreets/sharedstreets-builder/releases/tag/0.1-preview) OSM support
 - *v0.2:* Add OSM metadata support for support ways per [#9](https://github.com/sharedstreets/sharedstreets-builder/issues/9)
-- [*v0.3:*](https://github.com/sharedstreets/sharedstreets-builder/releases/tag/0.3) add heirarchical filterfing for roadClass per [sharedstreets-ref-system/#20](https://github.com/sharedstreets/sharedstreets-ref-system/issues/20#issuecomment-381010861)
+- [*v0.3:*](https://github.com/sharedstreets/sharedstreets-builder/releases/tag/0.3) add hierarchical filtering for roadClass per [sharedstreets-ref-system/#20](https://github.com/sharedstreets/sharedstreets-ref-system/issues/20#issuecomment-381010861)

src/main/java/io/sharedstreets/tools/builder/ProcessPBF.java

@@ -1,8 +1,6 @@
 package io.sharedstreets.tools.builder;
 
-import io.sharedstreets.data.SharedStreetsGeometry;
 import io.sharedstreets.tools.builder.osm.model.Way;
-import io.sharedstreets.tools.builder.tiles.JSONTileOutputFormat;
 import io.sharedstreets.tools.builder.tiles.ProtoTileOutputFormat;
 import io.sharedstreets.tools.builder.tiles.TilableData;
 import io.sharedstreets.tools.builder.transforms.Intersections;
@@ -11,20 +9,15 @@
 import io.sharedstreets.tools.builder.transforms.SharedStreetData;
 import io.sharedstreets.tools.builder.util.geo.TileId;
 import org.apache.commons.cli.*;
-import org.apache.flink.api.common.functions.FilterFunction;
-import org.apache.flink.api.common.functions.MapFunction;
-import org.apache.flink.api.common.functions.ReduceFunction;
-import org.apache.flink.api.java.DataSet;
 import org.apache.flink.api.java.ExecutionEnvironment;
 
-import org.apache.flink.api.java.tuple.Tuple1;
 import org.apache.flink.api.java.tuple.Tuple2;
 import org.slf4j.LoggerFactory;
 import org.slf4j.Logger;
 
 import java.io.File;
 import java.util.ArrayList;
-
+import java.util.Comparator;
 
 public class ProcessPBF {
 
@@ -40,31 +33,40 @@ public static void main(String[] args) throws Exception {
         // create the Options
         Options options = new Options();
 
-        options.addOption( OptionBuilder.withLongOpt( "input" )
-                .withDescription( "path to input OSM PBF file" )
+        options.addOption( Option.builder().longOpt( "input" )
+                .desc( "path to input OSM PBF file" )
                 .hasArg()
-                .withArgName("INPUT-FILE")
-                .create() );
+                .required()
+                .argName("INPUT-FILE")
+                .build() );
 
-        options.addOption( OptionBuilder.withLongOpt( "output" )
-                .withDescription( "path to output directory (will be created)" )
+        options.addOption( Option.builder().longOpt( "output" )
+                .desc( "path to output directory (will be created)" )
                 .hasArg()
-                .withArgName("OUTPUT-DIR")
-                .create() );
+                .argName("OUTPUT-DIR")
+                .build() );
 
-        options.addOption( OptionBuilder.withLongOpt( "zlevel" )
-                .withDescription( "tile z-level (default 12)" )
+        options.addOption( Option.builder().longOpt( "zlevel" )
+                .desc( "tile z-level (default 12)" )
                 .hasArg()
-                .withArgName("Z-LEVEL")
-                .create() );
+                .argName("Z-LEVEL")
+                .build() );
 
+        options.addOption( Option.builder().longOpt( "roadClasses" )
+                .desc( "road classes (default '6,4,2,1,0')" )
+                .hasArg()
+                .argName("ROAD-CLASSES")
+                .build() );
 
         String inputFile = "";
 
         String outputPath = "";
 
         Integer zLevel = 12 ;
 
+        String roadClasses = "6,4,2,1,0";
+        ArrayList<Way.ROAD_CLASS> filteredClasses = new ArrayList<>();
+
         try {
             // parse the command line arguments
             CommandLine line = parser.parse( options, args );
@@ -82,6 +84,22 @@ public static void main(String[] args) throws Exception {
             if(line.hasOption("zlevel")){
                 zLevel = Integer.parseInt(line.getOptionValue("zlevel"));
             }
+
+            if(line.hasOption("roadClasses")){
+                roadClasses = line.getOptionValue("roadClasses");
+            }
+
+            // list of way classes for export tiles (will be sorted to be in sequential order from least to most filtered)
+            for (String roadClass : roadClasses.split(",")) {
+                int roadClassOrdinal = Integer.parseInt(roadClass);
+                filteredClasses.add(Way.ROAD_CLASS.values()[roadClassOrdinal]);
+            }
+            filteredClasses.sort(new Comparator<Way.ROAD_CLASS>() {
+                @Override
+                public int compare(Way.ROAD_CLASS o1, Way.ROAD_CLASS o2) {
+                    return o2.compareTo(o1);
+                }
+            });
         }
         catch( Exception exp ) {
             System.out.println( "Unexpected exception:" + exp.getMessage() );
@@ -102,7 +120,7 @@ public static void main(String[] args) throws Exception {
         File directory = new File(outputPath);
 
         if(directory.exists()) {
-            System.out.println( "Output directory already exists: "  + outputPath);
+            System.out.println("Output directory already exists: " + outputPath);
             return;
         }
 
@@ -111,12 +129,6 @@ public static void main(String[] args) throws Exception {
         // load osm data from PBF input
         OSMDataStream dataStream = new OSMDataStream(inputFile, env);
 
-        // list of way classes for export tiles (must be in sequential order from least to most filtered)
-        ArrayList<Way.ROAD_CLASS> filteredClasses = new ArrayList<>();
-        filteredClasses.add(Way.ROAD_CLASS.ClassUnclassified);
-        filteredClasses.add(Way.ROAD_CLASS.ClassTertiary);
-        filteredClasses.add(Way.ROAD_CLASS.ClassPrimary);
-        filteredClasses.add(Way.ROAD_CLASS.ClassMotorway);
 
         for(Way.ROAD_CLASS filteredClass : filteredClasses) {
 
@@ -141,5 +153,3 @@ public static void main(String[] args) throws Exception {
     }
 
 }
-
-