changed fetch type, edited API docs

MaheshSundaramurthy · Dec 14, 2015 · 4444a8a · 4444a8a
1 parent c50a45b
commit 4444a8a
Show file tree

Hide file tree

Showing 10 changed files with 124 additions and 96 deletions.
diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm
@@ -37724,24 +37724,24 @@ <h3>Create a Survey</h3>
   "countryCode":"KE",
   "validFrom":null,
   "validTo":null,
-  "components":
+  "componentDatas":
   [
     {
       "key":"Household",
-      "text":"Information about the household."
+      "text":"Information about the household.",
       "description":null,
       "sequenceNo":1
     }
-  ]
-  "questions":
+  ],
+  "questionDatas":
   [
     {
       "componentKey":"Household",
       "key":"Familiy members",
-      "text":"How many persons live in the household?"
+      "text":"How many persons live in the household?",
       "description":null,
       "sequenceNo":1,
-      "responses":
+      "responseDatas":
       [
         {
           "text":"1 to 3",
@@ -37761,7 +37761,8 @@ <h3>Create a Survey</h3>
       ]
     }
   ]
-}							</code>
+}
+							</code>
 							<code class="method-response">
 200 OK
 							</code>
@@ -37784,50 +37785,52 @@ <h3>List all Surveys</h3>
 							<code class="method-response">
 [
   {
-    "id":1
-    "key":"ppi-kenya-2010",
-    "name":"PPI Survey for Kenya, version 2010",
-    "description":null,
-    "countryCode":"KE",
-    "validFrom":"2015-11-25T00:00:00.000Z",
-    "validTo":"2115-12-31T23:59:59.999Z",
-    "components":
-    [
+    "id": 1,
+    "componentDatas": [
       {
-        "key":"Household",
-        "text":"Information about the household."
-        "description":null,
-        "sequenceNo":1
+        "id": 1,
+        "key": "Household",
+        "text": "Information about the household.",
+        "description": null,
+        "sequenceNo": 1
       }
-    ]
-    "questions":
-    [
+    ],
+    "questionDatas": [
       {
-        "componentKey":"Household",
-        "key":"Familiy members",
-        "text":"How many persons live in the household?"
-        "description":null,
-        "sequenceNo":1,
-        "responses":
-        [
+        "id": 1,
+        "responseDatas": [
           {
-            "text":"1 to 3",
-            "value":1,
-            "sequenceNo":1
+            "id": 1,
+            "text": "1 to 3",
+            "value": 1,
+            "sequenceNo": 1
           },
           {
-            "text":"3 to 7",
-            "value":5,
-            "sequenceNo":2
+            "id": 2,
+            "text": "3 to 7",
+            "value": 5,
+            "sequenceNo": 2
           },
           {
-            "text":"more than 7",
-            "value":13,
-            "sequenceNo":3
+            "id": 3,
+            "text": "more than 7",
+            "value": 13,
+            "sequenceNo": 3
           }
-        ]
+        ],
+        "componentKey": "Household",
+        "key": "Familiy members",
+        "text": "How many persons live in the household?",
+        "description": null,
+        "sequenceNo": 1
       }
-    ]
+    ],
+    "key": "ppi-kenya-2010",
+    "name": "PPI Survey for Kenya, version 2010",
+    "description": null,
+    "countryCode": "KE",
+    "validFrom": 1450047600000,
+    "validTo": 4607276399000
   }
 ]
 							</code>
@@ -37849,52 +37852,53 @@ <h3>Retrieve a Survey</h3>
 							</code>
 							<code class="method-response">
 {
-  "id":1
-  "key":"ppi-kenya-2010",
-  "name":"PPI Survey for Kenya, version 2010",
-  "description":null,
-  "countryCode":"KE",
-  "validFrom":"2015-11-25T00:00:00.000Z",
-  "validTo":"2115-12-31T23:59:59.999Z",
-  "components":
-  [
+  "id": 1,
+  "componentDatas": [
     {
-      "key":"Household",
-      "text":"Information about the household."
-      "description":null,
-      "sequenceNo":1
+      "id": 1,
+      "key": "Household",
+      "text": "Information about the household.",
+      "description": null,
+      "sequenceNo": 1
     }
-  ]
-  "questions":
-  [
+  ],
+  "questionDatas": [
     {
-      "componentKey":"Household",
-      "key":"Familiy members",
-      "text":"How many persons live in the household?"
-      "description":null,
-      "sequenceNo":1,
-      "responses":
-      [
+      "id": 1,
+      "responseDatas": [
         {
-          "text":"1 to 3",
-          "value":1,
-          "sequenceNo":1
+          "id": 1,
+          "text": "1 to 3",
+          "value": 1,
+          "sequenceNo": 1
         },
         {
-          "text":"3 to 7",
-          "value":5,
-          "sequenceNo":2
+          "id": 2,
+          "text": "3 to 7",
+          "value": 5,
+          "sequenceNo": 2
         },
         {
-          "text":"more than 7",
-          "value":13,
-          "sequenceNo":3
+          "id": 3,
+          "text": "more than 7",
+          "value": 13,
+          "sequenceNo": 3
         }
-      ]
+      ],
+      "componentKey": "Household",
+      "key": "Familiy members",
+      "text": "How many persons live in the household?",
+      "description": null,
+      "sequenceNo": 1
     }
-  ]
+  ],
+  "key": "ppi-kenya-2010",
+  "name": "PPI Survey for Kenya, version 2010",
+  "description": null,
+  "countryCode": "KE",
+  "validFrom": 1450047600000,
+  "validTo": 4607276399000
 }
-
 							</code>
 						</div>
 					</div>

diff --git a/mifosng-provider/src/main/java/org/mifosplatform/spm/api/SpmApiResource.java b/mifosng-provider/src/main/java/org/mifosplatform/spm/api/SpmApiResource.java
@@ -14,6 +14,7 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Scope;
 import org.springframework.stereotype.Component;
+import org.springframework.transaction.annotation.Transactional;
 
 import javax.ws.rs.*;
 import javax.ws.rs.core.MediaType;
@@ -38,6 +39,7 @@ public SpmApiResource(final PlatformSecurityContext securityContext,
     @GET
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
+    @Transactional
     public List<SurveyData> fetchActiveSurveys() {
         this.securityContext.authenticatedUser();
 
@@ -58,6 +60,7 @@ public List<SurveyData> fetchActiveSurveys() {
     @Path("/{id}")
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
+    @Transactional
     public SurveyData findSurvey(@PathParam("id") final Long id) {
         this.securityContext.authenticatedUser();
 
@@ -73,6 +76,7 @@ public SurveyData findSurvey(@PathParam("id") final Long id) {
     @POST
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
+    @Transactional
     public void createSurvey(final SurveyData surveyData) {
         this.securityContext.authenticatedUser();
 
@@ -85,6 +89,7 @@ public void createSurvey(final SurveyData surveyData) {
     @Path("/{id}")
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
+    @Transactional
     public void deactivateSurvey(@PathParam("id") final Long id) {
         this.securityContext.authenticatedUser();
 

diff --git a/mifosng-provider/src/main/java/org/mifosplatform/spm/data/ComponentData.java b/mifosng-provider/src/main/java/org/mifosplatform/spm/data/ComponentData.java
@@ -7,6 +7,7 @@
 
 public class ComponentData {
 
+    private Long id;
     private String key;
     private String text;
     private String description;
@@ -16,15 +17,20 @@ public ComponentData() {
         super();
     }
 
-    public ComponentData(final String key, final String text,
+    public ComponentData(final Long id, final String key, final String text,
                          final String description, final Integer sequenceNo) {
         super();
+        this.id = id;
         this.key = key;
         this.text = text;
         this.description = description;
         this.sequenceNo = sequenceNo;
     }
 
+    public Long getId() {
+        return id;
+    }
+
     public String getKey() {
         return key;
     }

diff --git a/mifosng-provider/src/main/java/org/mifosplatform/spm/data/QuestionData.java b/mifosng-provider/src/main/java/org/mifosplatform/spm/data/QuestionData.java
@@ -9,6 +9,7 @@
 
 public class QuestionData {
 
+    private Long id;
     private List<ResponseData> responseDatas;
     private String componentKey;
     private String key;
@@ -20,9 +21,10 @@ public QuestionData() {
         super();
     }
 
-    public QuestionData(final List<ResponseData> responseDatas, final String componentKey, final String key,
+    public QuestionData(final Long id, final List<ResponseData> responseDatas, final String componentKey, final String key,
                         final String text, final String description, final Integer sequenceNo) {
         super();
+        this.id = id;
         this.responseDatas = responseDatas;
         this.componentKey = componentKey;
         this.key = key;
@@ -31,6 +33,10 @@ public QuestionData(final List<ResponseData> responseDatas, final String compone
         this.sequenceNo = sequenceNo;
     }
 
+    public Long getId() {
+        return id;
+    }
+
     public List<ResponseData> getResponseDatas() {
         return responseDatas;
     }

diff --git a/mifosng-provider/src/main/java/org/mifosplatform/spm/data/ResponseData.java b/mifosng-provider/src/main/java/org/mifosplatform/spm/data/ResponseData.java
@@ -7,6 +7,7 @@
 
 public class ResponseData {
 
+    private Long id;
     private String text;
     private Integer value;
     private Integer sequenceNo;
@@ -15,14 +16,19 @@ public ResponseData() {
         super();
     }
 
-    public ResponseData(final String text, final Integer value,
+    public ResponseData(final Long id, final String text, final Integer value,
                         final Integer sequenceNo) {
         super();
+        this.id = id;
         this.text = text;
         this.value = value;
         this.sequenceNo = sequenceNo;
     }
 
+    public Long getId() {
+        return id;
+    }
+
     public String getText() {
         return text;
     }

diff --git a/mifosng-provider/src/main/java/org/mifosplatform/spm/domain/Question.java b/mifosng-provider/src/main/java/org/mifosplatform/spm/domain/Question.java
@@ -18,7 +18,7 @@ public class Question extends AbstractPersistable<Long> {
     @JoinColumn(name = "survey_id")
     private Survey survey;
 
-    @OneToMany(mappedBy = "question", fetch = FetchType.EAGER)
+    @OneToMany(mappedBy = "question", fetch = FetchType.LAZY, cascade = CascadeType.ALL)
     @OrderBy("sequenceNo")
     private List<Response> responses;
 

diff --git a/mifosng-provider/src/main/java/org/mifosplatform/spm/domain/Survey.java b/mifosng-provider/src/main/java/org/mifosplatform/spm/domain/Survey.java
@@ -15,11 +15,11 @@
 @Table(name = "m_surveys")
 public class Survey extends AbstractPersistable<Long> {
 
-    @OneToMany(mappedBy = "survey", fetch = FetchType.EAGER)
+    @OneToMany(mappedBy = "survey", fetch = FetchType.LAZY, cascade = CascadeType.ALL)
     @OrderBy("sequenceNo")
     private List<Component> components;
 
-    @OneToMany(mappedBy = "survey", fetch = FetchType.EAGER)
+    @OneToMany(mappedBy = "survey", fetch = FetchType.LAZY, cascade = CascadeType.ALL)
     @OrderBy("sequenceNo")
     private List<Question> questions;
 

diff --git a/mifosng-provider/src/main/java/org/mifosplatform/spm/repository/SurveyRepository.java b/mifosng-provider/src/main/java/org/mifosplatform/spm/repository/SurveyRepository.java
@@ -18,5 +18,6 @@ public interface SurveyRepository extends JpaRepository<Survey, Long> {
     @Query("select s from Survey s where :pointInTime between s.validFrom and s.validTo")
     List<Survey> fetchActiveSurveys(@Param("pointInTime") final Date pointInTime);
 
-    Survey findByKey(final String key);
+    @Query("select s from Survey s where s.key = :key and :pointInTime between s.validFrom and s.validTo")
+    Survey findByKey(@Param("key") final String key, @Param("pointInTime") final Date pointInTime);
 }