Refactor research/er age with academic age (#363)

TAMULib · Aug 10, 2023 · c5dae22 · c5dae22
1 parent f01f8ac
commit c5dae22
Show file tree

Hide file tree

Showing 5 changed files with 186 additions and 186 deletions.
diff --git a/...ument/DiscoveryResearchAgeDescriptor.java → ...ument/DiscoveryAcademicAgeDescriptor.java b/...ument/DiscoveryResearchAgeDescriptor.java → ...ument/DiscoveryAcademicAgeDescriptor.java
@@ -4,8 +4,8 @@
 import java.util.ArrayList;
 import java.util.List;
 
-// TODO: refactor to DiscoveryResearchAgeDescriptorArg and add argument resolver
-public class DiscoveryResearchAgeDescriptor {
+// TODO: refactor to DiscoveryAcademicAgeDescriptorArg and add argument resolver
+public class DiscoveryAcademicAgeDescriptor {
 
     private final String label;
 
@@ -19,7 +19,7 @@ public class DiscoveryResearchAgeDescriptor {
 
     private final Integer groupingIntervalInYears;
 
-    private DiscoveryResearchAgeDescriptor(
+    private DiscoveryAcademicAgeDescriptor(
             String label,
             String dateField,
             Boolean accumulateMultivaluedDate,
@@ -132,14 +132,14 @@ public List<LabeledRange> getLabeledRanges() {
         return labeledRanges;
     }
 
-    public static DiscoveryResearchAgeDescriptor of(
+    public static DiscoveryAcademicAgeDescriptor of(
             String label,
             String dateField,
             Boolean accumulateMultivaluedDate,
             Boolean averageOverInterval,
             Integer upperLimitInYears,
             Integer groupingIntervalInYears) {
-        return new DiscoveryResearchAgeDescriptor(
+        return new DiscoveryAcademicAgeDescriptor(
                 label,
                 dateField,
                 accumulateMultivaluedDate,

diff --git a/...java/edu/tamu/scholars/middleware/discovery/controller/IndividualAnalyticsController.java b/...java/edu/tamu/scholars/middleware/discovery/controller/IndividualAnalyticsController.java
@@ -11,12 +11,12 @@
 import org.springframework.web.bind.annotation.RestController;
 
 import edu.tamu.scholars.middleware.discovery.argument.DiscoveryQuantityDistributionDescriptor;
-import edu.tamu.scholars.middleware.discovery.argument.DiscoveryResearchAgeDescriptor;
+import edu.tamu.scholars.middleware.discovery.argument.DiscoveryAcademicAgeDescriptor;
 import edu.tamu.scholars.middleware.discovery.argument.FilterArg;
 import edu.tamu.scholars.middleware.discovery.argument.QueryArg;
 import edu.tamu.scholars.middleware.discovery.model.repo.IndividualRepo;
 import edu.tamu.scholars.middleware.discovery.response.DiscoveryQuantityDistribution;
-import edu.tamu.scholars.middleware.discovery.response.DiscoveryResearchAge;
+import edu.tamu.scholars.middleware.discovery.response.DiscoveryAcademicAge;
 
 @RestController
 @RequestMapping("/individual/analytics")
@@ -26,8 +26,8 @@ public class IndividualAnalyticsController {
     private IndividualRepo repo;
 
     @PreAuthorize("hasRole('ROLE_ADMIN')")
-    @GetMapping("/researchAge")
-    public ResponseEntity<DiscoveryResearchAge> researcherAge(
+    @GetMapping("/aca")
+    public ResponseEntity<DiscoveryAcademicAge> academicAge(
         QueryArg query,
         List<FilterArg> filters,
         @RequestParam(name = "label", defaultValue = "Research") String label,
@@ -38,7 +38,7 @@ public ResponseEntity<DiscoveryResearchAge> researcherAge(
         @RequestParam(name = "upperLimitInYears", defaultValue = "40") Integer upperLimitInYears,
         @RequestParam(name = "groupingIntervalInYears", defaultValue = "5") Integer groupingIntervalInYears) {
 
-        return ResponseEntity.ok(repo.researcherAge(DiscoveryResearchAgeDescriptor.of(label, dateField, accumulateMultivaluedDate, averageOverInterval, upperLimitInYears, groupingIntervalInYears), query, filters));
+        return ResponseEntity.ok(repo.academicAge(DiscoveryAcademicAgeDescriptor.of(label, dateField, accumulateMultivaluedDate, averageOverInterval, upperLimitInYears, groupingIntervalInYears), query, filters));
     }
 
     @GetMapping("/quantityDistribution")

diff --git a/src/main/java/edu/tamu/scholars/middleware/discovery/model/repo/IndexDocumentRepo.java b/src/main/java/edu/tamu/scholars/middleware/discovery/model/repo/IndexDocumentRepo.java
@@ -10,7 +10,7 @@
 import edu.tamu.scholars.middleware.discovery.argument.BoostArg;
 import edu.tamu.scholars.middleware.discovery.argument.DiscoveryNetworkDescriptor;
 import edu.tamu.scholars.middleware.discovery.argument.DiscoveryQuantityDistributionDescriptor;
-import edu.tamu.scholars.middleware.discovery.argument.DiscoveryResearchAgeDescriptor;
+import edu.tamu.scholars.middleware.discovery.argument.DiscoveryAcademicAgeDescriptor;
 import edu.tamu.scholars.middleware.discovery.argument.FacetArg;
 import edu.tamu.scholars.middleware.discovery.argument.FilterArg;
 import edu.tamu.scholars.middleware.discovery.argument.HighlightArg;
@@ -19,7 +19,7 @@
 import edu.tamu.scholars.middleware.discovery.response.DiscoveryFacetAndHighlightPage;
 import edu.tamu.scholars.middleware.discovery.response.DiscoveryNetwork;
 import edu.tamu.scholars.middleware.discovery.response.DiscoveryQuantityDistribution;
-import edu.tamu.scholars.middleware.discovery.response.DiscoveryResearchAge;
+import edu.tamu.scholars.middleware.discovery.response.DiscoveryAcademicAge;
 import reactor.core.publisher.Flux;
 
 public interface IndexDocumentRepo<D extends AbstractIndexDocument> {
@@ -46,7 +46,7 @@ public interface IndexDocumentRepo<D extends AbstractIndexDocument> {
 
     public DiscoveryNetwork network(DiscoveryNetworkDescriptor dataNetworkDescriptor);
 
-    public DiscoveryResearchAge researcherAge(DiscoveryResearchAgeDescriptor researcherAgeDescriptor, QueryArg query, List<FilterArg> filters);
+    public DiscoveryAcademicAge academicAge(DiscoveryAcademicAgeDescriptor academicAgeDescriptor, QueryArg query, List<FilterArg> filters);
 
     public DiscoveryQuantityDistribution quantityDistribution(DiscoveryQuantityDistributionDescriptor quantityDistributionDescriptor, QueryArg query, List<FilterArg> filters);
 

diff --git a/src/main/java/edu/tamu/scholars/middleware/discovery/model/repo/IndividualRepo.java b/src/main/java/edu/tamu/scholars/middleware/discovery/model/repo/IndividualRepo.java
@@ -48,7 +48,7 @@
 import edu.tamu.scholars.middleware.discovery.argument.BoostArg;
 import edu.tamu.scholars.middleware.discovery.argument.DiscoveryNetworkDescriptor;
 import edu.tamu.scholars.middleware.discovery.argument.DiscoveryQuantityDistributionDescriptor;
-import edu.tamu.scholars.middleware.discovery.argument.DiscoveryResearchAgeDescriptor;
+import edu.tamu.scholars.middleware.discovery.argument.DiscoveryAcademicAgeDescriptor;
 import edu.tamu.scholars.middleware.discovery.argument.FacetArg;
 import edu.tamu.scholars.middleware.discovery.argument.FilterArg;
 import edu.tamu.scholars.middleware.discovery.argument.HighlightArg;
@@ -58,7 +58,7 @@
 import edu.tamu.scholars.middleware.discovery.response.DiscoveryFacetAndHighlightPage;
 import edu.tamu.scholars.middleware.discovery.response.DiscoveryNetwork;
 import edu.tamu.scholars.middleware.discovery.response.DiscoveryQuantityDistribution;
-import edu.tamu.scholars.middleware.discovery.response.DiscoveryResearchAge;
+import edu.tamu.scholars.middleware.discovery.response.DiscoveryAcademicAge;
 import edu.tamu.scholars.middleware.utility.DateFormatUtility;
 import reactor.core.publisher.Flux;
 
@@ -277,18 +277,18 @@ public DiscoveryNetwork network(DiscoveryNetworkDescriptor dataNetworkDescriptor
     }
 
     @Override
-    public DiscoveryResearchAge researcherAge(DiscoveryResearchAgeDescriptor researcherAgeDescriptor, QueryArg query, List<FilterArg> filters) {
-        DiscoveryResearchAge researchAge = new DiscoveryResearchAge(researcherAgeDescriptor.getLabel(), researcherAgeDescriptor.getDateField());
+    public DiscoveryAcademicAge academicAge(DiscoveryAcademicAgeDescriptor academicAgeDescriptor, QueryArg query, List<FilterArg> filters) {
+        DiscoveryAcademicAge academicAge = new DiscoveryAcademicAge(academicAgeDescriptor.getLabel(), academicAgeDescriptor.getDateField());
 
-        String dateField = researcherAgeDescriptor.getDateField();
-        String ageField = researcherAgeDescriptor.getAgeField();
+        String dateField = academicAgeDescriptor.getDateField();
+        String ageField = academicAgeDescriptor.getAgeField();
 
         try {
 
             // get count
             long count = this.count(query, filters);
 
-            String fields = researcherAgeDescriptor.getAccumulateMultivaluedDate()
+            String fields = academicAgeDescriptor.getAccumulateMultivaluedDate()
                 ? String.format("%s,%s", dateField, ageField)
                 : ageField;
 
@@ -303,12 +303,12 @@ public DiscoveryResearchAge researcherAge(DiscoveryResearchAgeDescriptor researc
 
             SolrDocumentList results = response.getResults();
 
-            researchAge.from(researcherAgeDescriptor, results);
+            academicAge.from(academicAgeDescriptor, results);
 
         } catch (Exception e) {
-            logger.error("Failed to gather researcher age analytics!", e);
+            logger.error("Failed to gather academic age analytics!", e);
         }
-        return researchAge;
+        return academicAge;
     }
 
     @Override