Merge pull request #249 from Esri/statistical-query-group-sort

statistical query group and sort sample

Author: tschie

src/main/java/com/esri/samples/featurelayers/statistical_query_group_and_sort/GroupField.java

@@ -0,0 +1,48 @@
+package com.esri.samples.featurelayers.statistical_query_group_and_sort;
+
+import javafx.beans.property.SimpleBooleanProperty;
+import javafx.beans.property.SimpleStringProperty;
+
+/**
+ * Convenience bean class for representing a group-by field. The grouping property can be bound to a CheckBoxListCell
+ * to choose whether the field should be grouped by with a CheckBox.
+ */
+public class GroupField {
+
+  private final SimpleStringProperty fieldName;
+  private final SimpleBooleanProperty grouping;
+
+  GroupField(String fieldName, Boolean grouping) {
+    this.fieldName = new SimpleStringProperty(fieldName);
+    this.grouping = new SimpleBooleanProperty(grouping);
+  }
+
+  public String getFieldName() {
+    return fieldName.get();
+  }
+
+  public SimpleStringProperty fieldNameProperty() {
+    return fieldName;
+  }
+
+  public void setFieldName(String fieldName) {
+    this.fieldName.set(fieldName);
+  }
+
+  public boolean isGrouping() {
+    return grouping.get();
+  }
+
+  public SimpleBooleanProperty groupingProperty() {
+    return grouping;
+  }
+
+  public void setGrouping(boolean grouping) {
+    this.grouping.set(grouping);
+  }
+
+  @Override
+  public String toString() {
+    return getFieldName();
+  }
+}

src/main/java/com/esri/samples/featurelayers/statistical_query_group_and_sort/OrderByField.java

@@ -0,0 +1,62 @@
+package com.esri.samples.featurelayers.statistical_query_group_and_sort;
+
+import javafx.beans.binding.Bindings;
+import javafx.beans.property.SimpleObjectProperty;
+import javafx.beans.property.SimpleStringProperty;
+
+import com.esri.arcgisruntime.data.QueryParameters;
+
+/**
+ * Convenience bean class for representing OrderBy in a TableView row. The sortOrder property can be bound to a
+ * ComboBoxTableCell for changing the sortOrder with a ComboBox.
+ */
+public class OrderByField {
+
+  private final SimpleStringProperty fieldName;
+  private final SimpleObjectProperty<QueryParameters.SortOrder> sortOrder;
+  private final SimpleObjectProperty<QueryParameters.OrderBy> orderBy;
+
+  OrderByField(QueryParameters.OrderBy orderBy) {
+    this.fieldName = new SimpleStringProperty(orderBy.getFieldName());
+    this.sortOrder = new SimpleObjectProperty<>(orderBy.getSortOrder());
+    this.orderBy = new SimpleObjectProperty<>();
+    this.orderBy.bind(Bindings.createObjectBinding(() -> new QueryParameters.OrderBy(this.fieldName.get(), this
+        .sortOrder.get()), this.fieldName, this.sortOrder));
+  }
+
+  public String getFieldName() {
+    return fieldName.get();
+  }
+
+  public SimpleStringProperty fieldNameProperty() {
+    return fieldName;
+  }
+
+  public void setFieldName(String fieldName) {
+    this.fieldName.set(fieldName);
+  }
+
+  public QueryParameters.SortOrder getSortOrder() {
+    return sortOrder.get();
+  }
+
+  public SimpleObjectProperty<QueryParameters.SortOrder> sortOrderProperty() {
+    return sortOrder;
+  }
+
+  public void setSortOrder(QueryParameters.SortOrder sortOrder) {
+    this.sortOrder.set(sortOrder);
+  }
+
+  public QueryParameters.OrderBy getOrderBy() {
+    return orderBy.get();
+  }
+
+  public SimpleObjectProperty<QueryParameters.OrderBy> orderByProperty() {
+    return orderBy;
+  }
+
+  public void setOrderBy(QueryParameters.OrderBy orderBy) {
+    this.orderBy.set(orderBy);
+  }
+}

src/main/java/com/esri/samples/featurelayers/statistical_query_group_and_sort/README.md

@@ -0,0 +1,52 @@
+<h1>Statistical Query Group And Sort</h1>
+
+<p>Demonstrates how to query a feature table for statistics grouping and sorting by different fields.</p>
+
+<p><img src="StatisticalQueryGroupAndSort.png"></p>
+
+<h2>How to use the sample</h2>
+
+<p>The sample will start with some default options selected. You can immediately click the "Get Statistics" button to
+ see the results for these options.</p>
+
+<p>To change the statistic definitions, you can add statistic definitions to the top-left table using the combo boxes 
+and "Add button". Select a table row and click "Remove" to remove the statistic definition.</p>
+
+<p>To change the group-by fields, check the box by the field you want to group by in the bottom-left list view.</p>
+
+<p>To change the order-by fields, select a group by field (it must be checked) and click the ">>" button to add it to
+ the Order By table. To remove a field from the Order by table, select it and click the "<<" button. To change the 
+ sort order of the order-by field, click on a cell in the Sort Order column to edit it using a ComboBox.</p>
+ 
+ <h2>How it works</h2>
+ 
+ <p>To query statistics from a feature table:</p>
+ 
+ <ol>
+    <li>Create and load a <code>ServiceFeatureTable</code>.</li>
+    <li>Get the feature tables field names list with <code>featureTable.getFields()</code>.</li>
+    <li>Create <code>StatisticDefinition</code>s specifying the field to compute statistics on and the 
+    <code>StatisticType</code> to compute.</li>
+    <li>Create <code>StatisticsQueryParameters</code> passing in the list of statistic definitions.</li>
+    <li>To have the results grouped by fields, add the field names to the query parameters' 
+    <code>groupByFieldNames</code> collection.</li>
+    <li>To have the results ordered by fields, create <code>OrderBy</code>s, specifying the field name and 
+    <code>SortOrder</code>. Pass these <code>OrderBy</code>s to the parameters' <code>orderByFields</code> 
+    collection.</li>
+    <li>To execute the query, call <code>featureTable.queryStatisticsAsync(queryParameters)</code></li>
+    <li>Get the <code>StatisticQueryResult</code>. From this, you can get an iterator of 
+    <code>StatisticRecord</code>s to loop through and display.</li>
+ </ol>
+ 
+ <h2>Features</h2>
+ 
+ <ul>
+    <li>Field</li>
+    <li>QueryParameters</li>
+    <li>ServiceFeatureTable</li>
+    <li>StatisticDefinition</li>
+    <li>StatisticRecord</li>
+    <li>StatisticType</li>
+    <li>StatisticsQueryParameters</li>
+    <li>StatisticsQueryResult</li>
+ </ul>