Merge pull request #173 from GIScience/checkstyle-for-pr162

fix code style issues introduced in PRs #162 and #121

src/main/lombok/org/heigit/ohsome/ohsomeapi/config/TomcatConfig.java

@@ -13,13 +13,13 @@ public class TomcatConfig {
 
   @Bean
   public ConfigurableServletWebServerFactory webServerFactory() {
-      TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
-      factory.addConnectorCustomizers(new TomcatConnectorCustomizer() {
+    TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
+    factory.addConnectorCustomizers(new TomcatConnectorCustomizer() {
           @Override
           public void customize(Connector connector) {
-              connector.setProperty("relaxedQueryChars", "|");
+            connector.setProperty("relaxedQueryChars", "|");
           }
       });
-      return factory;
+    return factory;
   }
 }

src/main/lombok/org/heigit/ohsome/ohsomeapi/controller/ParameterDescriptions.java

@@ -31,9 +31,9 @@ public class ParameterDescriptions {
   public static final String FORMAT =
       "Output format geojson (for /groupBy/boundary resources only), csv, or json; default: json";
   public static final String PROPERTIES =
-      "List of possible property-groups added to each OSM-element: 'tags' and/or 'metadata' " +
-      "and/or 'contributionTypes' (only for the /contributions/{geometryType} endpoints); "
-      + "default: no property";
+      "List of possible property-groups added to each OSM-element: 'tags' and/or 'metadata' "
+          + "and/or 'contributionTypes' (only for the /contributions/{geometryType} endpoints); "
+          + "default: no property";
   public static final String SHOW_METADATA = "Boolean operator 'true' or 'false'; default: 'false'";
   public static final String TIMEOUT = "Custom timeout in seconds; no default value";
   public static final String FILTER = "Combines several attributive filters, e.g. OSM type, "

src/main/lombok/org/heigit/ohsome/ohsomeapi/executor/AggregateRequestExecutor.java

@@ -1,6 +1,7 @@
 package org.heigit.ohsome.ohsomeapi.executor;
 
 import static org.heigit.ohsome.ohsomeapi.utils.GroupByBoundaryGeoJsonGenerator.createGeoJsonFeatures;
+
 import com.opencsv.CSVWriter;
 import java.io.IOException;
 import java.text.DecimalFormat;
@@ -201,9 +202,12 @@ private void writeCsvResponse(CSVWriter writer, Object[] resultSet) {
     } else if (resultSet instanceof ContributionsResult[]) {
       ContributionsResult[] rs = (ContributionsResult[]) resultSet;
       writer.writeNext(new String[] {"fromTimestamp", "toTimestamp", "value"}, false);
-      for (ContributionsResult ContributionsResult : rs) {
-        writer.writeNext(new String[] {ContributionsResult.getFromTimestamp(), ContributionsResult.getToTimestamp(),
-            String.valueOf(ContributionsResult.getValue())});
+      for (ContributionsResult contributionsResult : rs) {
+        writer.writeNext(new String[] {
+            contributionsResult.getFromTimestamp(),
+            contributionsResult.getToTimestamp(),
+            String.valueOf(contributionsResult.getValue())
+        });
       }
     } else if (resultSet instanceof RatioResult[]) {
       RatioResult[] rs = (RatioResult[]) resultSet;

src/main/lombok/org/heigit/ohsome/ohsomeapi/executor/DataExtractionTransformer.java

@@ -41,8 +41,9 @@ public class DataExtractionTransformer implements Serializable {
   public DataExtractionTransformer(boolean isContributionsLatestEndpoint,
       boolean isContributionsEndpoint, ExecutionUtils exeUtils, boolean clipGeometries,
       String startTimestamp, InputProcessingUtils utils, Set<SimpleFeatureType> simpleFeatureTypes,
-      FilterExpression filter, Set<Integer> keysInt, boolean includeTags, boolean includeOSMMetadata,
-      boolean includeContributionTypes, ElementsGeometry elementsGeometry, String endTimestamp,
+      FilterExpression filter, Set<Integer> keysInt, boolean includeTags,
+      boolean includeOSMMetadata, boolean includeContributionTypes,
+      ElementsGeometry elementsGeometry, String endTimestamp,
       boolean isContainingSimpleFeatureTypes) {
     this.isContributionsLatestEndpoint = isContributionsLatestEndpoint;
     this.isContributionsEndpoint = isContributionsEndpoint;

src/main/lombok/org/heigit/ohsome/ohsomeapi/executor/DataRequestExecutor.java

@@ -84,7 +84,7 @@ public void extract() throws Exception {
     TagTranslator tt = DbConnData.tagTranslator;
     String[] keys = requestParameters.getKeys();
     final Set<Integer> keysInt = ExecutionUtils.keysToKeysInt(keys, tt);
-    ExecutionUtils exeUtils = new ExecutionUtils(processingData);
+    final ExecutionUtils exeUtils = new ExecutionUtils(processingData);
     inputProcessor.processPropertiesParam();
     inputProcessor.processIsUnclippedParam();
     InputProcessingUtils utils = inputProcessor.getUtils();

src/main/lombok/org/heigit/ohsome/ohsomeapi/executor/ElementsRequestExecutor.java

@@ -512,8 +512,8 @@ public static Response aggregateBasicFiltersRatio(RequestResource requestResourc
     InputProcessor inputProcessor = new InputProcessor(servletRequest, isSnapshot, isDensity);
     inputProcessor.getProcessingData().setRatio(true);
     final MapReducer<OSMEntitySnapshot> intermediateMapRed = inputProcessor.processParameters();
-    ProcessingData processingData = inputProcessor.getProcessingData();
-    RequestParameters requestParameters = processingData.getRequestParameters();
+    final ProcessingData processingData = inputProcessor.getProcessingData();
+    final RequestParameters requestParameters = processingData.getRequestParameters();
     TagTranslator tt = DbConnData.tagTranslator;
     String[] keys2 = inputProcessor.splitParamOnComma(
         inputProcessor.createEmptyArrayIfNull(servletRequest.getParameterValues("keys2")));
@@ -761,8 +761,8 @@ public static <P extends Geometry & Polygonal> Response aggregateBasicFiltersRat
     inputProcessor.getProcessingData().setGroupByBoundary(true);
     inputProcessor.getProcessingData().setRatio(true);
     final MapReducer<OSMEntitySnapshot> intermediateMapRed = inputProcessor.processParameters();
-    ProcessingData processingData = inputProcessor.getProcessingData();
-    RequestParameters requestParameters = processingData.getRequestParameters();
+    final ProcessingData processingData = inputProcessor.getProcessingData();
+    final RequestParameters requestParameters = processingData.getRequestParameters();
     if (processingData.getBoundaryType() == BoundaryType.NOBOUNDARY) {
       throw new BadRequestException(ExceptionMessages.NO_BOUNDARY);
     }
@@ -963,13 +963,14 @@ public static <P extends Geometry & Polygonal> Response aggregateRatioGroupByBou
       throw new BadRequestException(ExceptionMessages.NO_BOUNDARY);
     }
     ExecutionUtils exeUtils = new ExecutionUtils(processingData);
-    String filter1 = inputProcessor.getProcessingData().getRequestParameters().getFilter();
-    String filter2 = inputProcessor.createEmptyStringIfNull(servletRequest.getParameter("filter2"));
+    final String filter1 = inputProcessor.getProcessingData().getRequestParameters().getFilter();
+    final String filter2 =
+        inputProcessor.createEmptyStringIfNull(servletRequest.getParameter("filter2"));
     inputProcessor.checkFilter(filter2);
-    String combinedFilter = exeUtils.combineFiltersWithOr(filter1, filter2);
-    FilterParser fp = new FilterParser(DbConnData.tagTranslator);
-    FilterExpression filterExpr1 = inputProcessor.getUtils().parseFilter(fp, filter1);
-    FilterExpression filterExpr2 = inputProcessor.getUtils().parseFilter(fp, filter2);
+    final String combinedFilter = exeUtils.combineFiltersWithOr(filter1, filter2);
+    final FilterParser fp = new FilterParser(DbConnData.tagTranslator);
+    final FilterExpression filterExpr1 = inputProcessor.getUtils().parseFilter(fp, filter1);
+    final FilterExpression filterExpr2 = inputProcessor.getUtils().parseFilter(fp, filter2);
     RequestParameters requestParamsCombined = new RequestParameters(servletRequest.getMethod(),
         isSnapshot, isDensity, servletRequest.getParameter("bboxes"),
         servletRequest.getParameter("bcircles"), servletRequest.getParameter("bpolys"),

src/main/lombok/org/heigit/ohsome/ohsomeapi/executor/ExecutionUtils.java

@@ -323,9 +323,12 @@ public void writeCsvResponse(Result[] resultSet, HttpServletResponse servletResp
       } else if (resultSet instanceof ContributionsResult[]) {
         writer.writeNext(new String[] {"fromTimestamp", "toTimestamp", "value"}, false);
         for (Result result : resultSet) {
-          ContributionsResult ContributionsResult = (ContributionsResult) result;
-          writer.writeNext(new String[] {ContributionsResult.getFromTimestamp(),
-              ContributionsResult.getToTimestamp(), String.valueOf(ContributionsResult.getValue())});
+          ContributionsResult contributionsResult = (ContributionsResult) result;
+          writer.writeNext(new String[] {
+              contributionsResult.getFromTimestamp(),
+              contributionsResult.getToTimestamp(),
+              String.valueOf(contributionsResult.getValue())
+          });
         }
       } else if (resultSet instanceof RatioResult[]) {
         writer.writeNext(new String[] {"timestamp", "value", "value2", "ratio"}, false);
@@ -399,8 +402,8 @@ public org.wololo.geojson.Feature createOSMFeature(OSMEntity entity, Geometry ge
       properties.put("@osmType", entity.getType());
       properties.put("@changesetId", entity.getChangesetId());
       if (isContributionsEndpoint) {
-      properties = addContributionTypes(properties, contributionTypes);
-    }
+        properties = addContributionTypes(properties, contributionTypes);
+      }
     }
     if (includeContributionTypes && !includeOSMMetadata) {
       properties = addContributionTypes(properties, contributionTypes);
@@ -542,8 +545,9 @@ public ElementsResult[] fillElementsResult(SortedMap<OSHDBTimestamp, ? extends N
   }
 
   /** Fills the ContributionsResult array with respective ContributionsResult objects. */
-  public ContributionsResult[] fillContributionsResult(SortedMap<OSHDBTimestamp, ? extends Number> entryVal,
-      boolean isDensity, InputProcessor inputProcessor, DecimalFormat df, Geometry geom) {
+  public ContributionsResult[] fillContributionsResult(
+      SortedMap<OSHDBTimestamp, ? extends Number> entryVal, boolean isDensity,
+      InputProcessor inputProcessor, DecimalFormat df, Geometry geom) {
     ContributionsResult[] results = new ContributionsResult[entryVal.entrySet().size()];
     int count = 0;
     String[] toTimestamps = inputProcessor.getUtils().getToTimestamps();
@@ -817,16 +821,17 @@ private ImmutablePair<List<String>, List<String[]>> createCsvResponseForUsersGro
       GroupByResult groupByResult = (GroupByResult) resultSet[i];
       columnNames.add(groupByResult.getGroupByObject().toString());
       for (int j = 0; j < groupByResult.getResult().length; j++) {
-        ContributionsResult ContributionsResult = (ContributionsResult) groupByResult.getResult()[j];
+        ContributionsResult contributionsResult =
+            (ContributionsResult) groupByResult.getResult()[j];
         if (i == 0) {
           String[] row = new String[resultSet.length + 2];
-          row[0] = ContributionsResult.getFromTimestamp();
-          row[1] = ContributionsResult.getToTimestamp();
-          row[2] = String.valueOf(ContributionsResult.getValue());
+          row[0] = contributionsResult.getFromTimestamp();
+          row[1] = contributionsResult.getToTimestamp();
+          row[2] = String.valueOf(contributionsResult.getValue());
           rows.add(row);
         } else {
           int count = i + 2;
-          rows.get(j)[count] = String.valueOf(ContributionsResult.getValue());
+          rows.get(j)[count] = String.valueOf(contributionsResult.getValue());
         }
       }
     }
@@ -948,18 +953,18 @@ private CSVWriter writeComments(HttpServletResponse servletResponse, List<String
   /** Adds contribution types properties like creation to the feature. */
   private Map<String, Object> addContributionTypes(Map<String, Object> properties,
       EnumSet<ContributionType> contributionTypes) {
-      if (contributionTypes.contains(ContributionType.CREATION)) {
-        properties.put("@creation", true);
-      }
-      if (contributionTypes.contains(ContributionType.DELETION)) {
-        properties.put("@deletion", true);
-      }
-      if (contributionTypes.contains(ContributionType.TAG_CHANGE)) {
-        properties.put("@tagChange", true);
-      }
-      if (contributionTypes.contains(ContributionType.GEOMETRY_CHANGE)) {
-        properties.put("@geometryChange", true);
-      }
+    if (contributionTypes.contains(ContributionType.CREATION)) {
+      properties.put("@creation", true);
+    }
+    if (contributionTypes.contains(ContributionType.DELETION)) {
+      properties.put("@deletion", true);
+    }
+    if (contributionTypes.contains(ContributionType.TAG_CHANGE)) {
+      properties.put("@tagChange", true);
+    }
+    if (contributionTypes.contains(ContributionType.GEOMETRY_CHANGE)) {
+      properties.put("@geometryChange", true);
+    }
     return properties;
   }
 

src/main/lombok/org/heigit/ohsome/ohsomeapi/inputprocessing/ResourceParameters.java

@@ -19,7 +19,7 @@ private ResourceParameters() {
    * for this is the metadata request in {@link MetadataRequestExecutor
    * #executeGetMetadata(HttpServletRequest) executeGetMetadata}.
    * 
-   * @param servletRequest
+   * @param servletRequest represents the HttpServlet request.
    * @return a list of of available parameters for the given resource.
    */
   public static List<String> getResourceSpecificParams(HttpServletRequest servletRequest) {
@@ -56,8 +56,8 @@ public static List<String> getResourceSpecificParams(HttpServletRequest servletR
   /**
    * Checks, if the request contains unexpected parameters for this resource.
    * 
-   * @param servletRequest
-   * @param resourceParams
+   * @param servletRequest represents the HttpServlet request.
+   * @param resourceParams represents a list of all possible parameters for the requested resource.
    * @return a list of unexpected parameters
    */
   public static List<String> checkUnexpectedParams(HttpServletRequest servletRequest,

src/main/lombok/org/heigit/ohsome/ohsomeapi/output/groupby/GroupByObject.java

@@ -5,7 +5,8 @@
 import lombok.Getter;
 
 /**
- * Abstract class used by the groupByResult classes:
+ * Abstract class used by the following groupByResult classes.
+ *
  * <ul>
  * <li>{@link org.heigit.ohsome.ohsomeapi.output.groupby.GroupByResult GroupByResult}</li>
  * <li>{@link org.heigit.ohsome.ohsomeapi.output.ratio.RatioGroupByResult RatioGroupByResult}</li>

src/test/java/org/heigit/ohsome/ohsomeapi/controller/DataExtractionTest.java

@@ -130,7 +130,7 @@ public void elementsBboxTest() {
     assertEquals("Polygon", featureGeom.get("type").asText());
     assertEquals(5, featureGeom.get("coordinates").get(0).size());
   }
-  
+
   @Test
   public void checkResponseMessageForWrongPropertiesParam() {
     TestRestTemplate restTemplate = new TestRestTemplate();
@@ -139,9 +139,9 @@ public void checkResponseMessageForWrongPropertiesParam() {
         + "filter=type:way and natural=*&properties=contributionTypes&time=2016-04-20,2016-04-21",
         JsonNode.class);      
     assertEquals("\"The properties parameter of this resource can only contain the values 'tags' "
-        + "and/or 'metadata' and/or 'unclipped'.\"", response.getBody().get("message").toString());   
+        + "and/or 'metadata' and/or 'unclipped'.\"", response.getBody().get("message").toString());
   }
-  
+
   @Test
   public void elementsCentroidTest() {
     TestRestTemplate restTemplate = new TestRestTemplate();
@@ -460,17 +460,18 @@ public void contributionsGeometryCoordinateTest() {
     assertEquals(49.418466, feature.get("geometry").get("coordinates").get(1).asDouble(), 0);
 
   }
-    @Test
-    public void contributionTypesPropertiesParameterTest() {
-      TestRestTemplate restTemplate = new TestRestTemplate();
-      ResponseEntity<JsonNode> response = restTemplate.getForEntity(server + port
-          + "/contributions/bbox?bboxes=8.67,49.39,8.71,49.42&clipGeometry=true&"
-          + "filter=type:way and natural=*&properties=contributionTypes&time=2016-04-20,2016-04-21",
-          JsonNode.class);      
-      JsonNode featuresArray = response.getBody().get("features");
-      assertTrue(featuresArray.get(0).get("properties").has("@geometryChange"));
-      assertFalse(featuresArray.get(0).get("properties").has("@changesetId"));
-    }
+
+  @Test
+  public void contributionTypesPropertiesParameterTest() {
+    TestRestTemplate restTemplate = new TestRestTemplate();
+    ResponseEntity<JsonNode> response = restTemplate.getForEntity(server + port
+        + "/contributions/bbox?bboxes=8.67,49.39,8.71,49.42&clipGeometry=true&"
+        + "filter=type:way and natural=*&properties=contributionTypes&time=2016-04-20,2016-04-21",
+        JsonNode.class);
+    JsonNode featuresArray = response.getBody().get("features");
+    assertTrue(featuresArray.get(0).get("properties").has("@geometryChange"));
+    assertFalse(featuresArray.get(0).get("properties").has("@changesetId"));
+  }
 
   /*
    * ./contributions/latest tests