Issue #5: Improve the Utility of the Trip Problem Report Admin Interface

Rename the "getTripProblemReportSummaries(query, groupBy)" method to avoid a collision with the existing
camsys · Apr 15, 2012 · d3583a1 · d3583a1
1 parent 5109113
commit d3583a1
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 7 deletions.
diff --git a/...in/java/org/onebusaway/transit_data_federation/impl/federated/TransitDataServiceImpl.java b/...in/java/org/onebusaway/transit_data_federation/impl/federated/TransitDataServiceImpl.java
@@ -571,11 +571,11 @@ public ListBean<StopProblemReportSummaryBean> getStopProblemReportSummaries(
   @Override
   public ListBean<TripProblemReportSummaryBean> getTripProblemReportSummaries(
       TripProblemReportQueryBean query) {
-    return getTripProblemReportSummaries(query, ETripProblemGroupBy.TRIP);
+    return getTripProblemReportSummariesByGrouping(query, ETripProblemGroupBy.TRIP);
   }
 
   @Override
-  public ListBean<TripProblemReportSummaryBean> getTripProblemReportSummaries(
+  public ListBean<TripProblemReportSummaryBean> getTripProblemReportSummariesByGrouping(
       TripProblemReportQueryBean query, ETripProblemGroupBy groupBy) {
     return _userReportingService.getTripProblemReportSummaries(query, groupBy);
   }

diff --git a/.../src/main/java/org/onebusaway/transit_data/model/problems/TripProblemReportQueryBean.java b/.../src/main/java/org/onebusaway/transit_data/model/problems/TripProblemReportQueryBean.java
@@ -27,7 +27,7 @@
  * 
  * @author bdferris
  * @see TransitDataService#getTripProblemReports(TripProblemReportQueryBean)
- * @see TransitDataService#getTripProblemReportSummaries(TripProblemReportQueryBean,
+ * @see TransitDataService#getTripProblemReportSummariesByGrouping(TripProblemReportQueryBean,
  *      ETripProblemGroupBy)
  */
 @QueryBean

diff --git a/...y-transit-data/src/main/java/org/onebusaway/transit_data/services/TransitDataService.java b/...y-transit-data/src/main/java/org/onebusaway/transit_data/services/TransitDataService.java
@@ -99,6 +99,12 @@
  * flexibility in over-the-wire serialization for RPC and are separate from the
  * underlying representations in the datastore.
  * 
+ * Implementation Note: when adding methods to this interface, do not introduce
+ * multiple methods with the same name and different arguments, as this seems to
+ * confuse Hessian proxies of the interface. Additionally, each method must
+ * specify a @FederatedBy... annotation indicating how the method will be
+ * dispatched in a federated deployment.
+ * 
  * @author bdferris
  * 
  */
@@ -502,7 +508,7 @@ public StopProblemReportBean getStopProblemReportForStopIdAndId(
    * @return
    * 
    * @deprecated see
-   *             {@link #getTripProblemReportSummaries(TripProblemReportQueryBean, ETripProblemGroupBy)}
+   *             {@link #getTripProblemReportSummariesByGrouping(TripProblemReportQueryBean, ETripProblemGroupBy)}
    */
   @FederatedByAgencyIdMethod(propertyExpression = "agencyId")
   @Deprecated
@@ -516,7 +522,7 @@ public ListBean<TripProblemReportSummaryBean> getTripProblemReportSummaries(
    * @return
    */
   @FederatedByAnyEntityIdMethod(properties = {"tripId"}, agencyIdProperties = {"agencyId"})
-  public ListBean<TripProblemReportSummaryBean> getTripProblemReportSummaries(
+  public ListBean<TripProblemReportSummaryBean> getTripProblemReportSummariesByGrouping(
       TripProblemReportQueryBean query, ETripProblemGroupBy groupBy);
 
   @FederatedByAnyEntityIdMethod(properties = {"tripId"}, agencyIdProperties = {"agencyId"})

diff --git a/...n/java/org/onebusaway/webapp/actions/admin/problems/TripProblemReportSummariesAction.java b/...n/java/org/onebusaway/webapp/actions/admin/problems/TripProblemReportSummariesAction.java
@@ -111,11 +111,11 @@ public String agency() {
     if (_status != null)
       query.setStatus(EProblemReportStatus.valueOf(_status.toUpperCase()));
 
-    ListBean<TripProblemReportSummaryBean> resultByTrip = _transitDataService.getTripProblemReportSummaries(
+    ListBean<TripProblemReportSummaryBean> resultByTrip = _transitDataService.getTripProblemReportSummariesByGrouping(
         query, ETripProblemGroupBy.TRIP);
     _summariesByTrip = resultByTrip.getList();
 
-    ListBean<TripProblemReportSummaryBean> resultByLabel = _transitDataService.getTripProblemReportSummaries(
+    ListBean<TripProblemReportSummaryBean> resultByLabel = _transitDataService.getTripProblemReportSummariesByGrouping(
         query, ETripProblemGroupBy.LABEL);
     _summariesByLabel = resultByLabel.getList();