dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #37262
[Branch ~dhis2-devs-core/dhis2/trunk] Rev 19073: Tracked entity instance query. Included a param &totalPages=false|true for including the total in...
------------------------------------------------------------
revno: 19073
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2
timestamp: Fri 2015-05-01 16:30:18 +0200
message:
Tracked entity instance query. Included a param &totalPages=false|true for including the total in the paging response. Reason is the counting is a more expensive operation than the actual query and should not be executed unless needed.
modified:
dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityInstanceQueryParams.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityInstanceService.java
dhis-2/dhis-services/dhis-service-tracker/src/main/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityInstanceService.java
dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/event/TrackedEntityInstanceController.java
--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk
Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityInstanceQueryParams.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityInstanceQueryParams.java 2015-01-17 07:41:26 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityInstanceQueryParams.java 2015-05-01 14:30:18 +0000
@@ -151,6 +151,11 @@
private Integer pageSize;
/**
+ * Indicates whether to include the total number of pages in the paging response.
+ */
+ private boolean totalPages;
+
+ /**
* Indicates whether paging should be skipped.
*/
private boolean skipPaging;
@@ -690,6 +695,16 @@
this.pageSize = pageSize;
}
+ public boolean isTotalPages()
+ {
+ return totalPages;
+ }
+
+ public void setTotalPages( boolean totalPages )
+ {
+ this.totalPages = totalPages;
+ }
+
public boolean isSkipPaging()
{
return skipPaging;
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityInstanceService.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityInstanceService.java 2015-01-17 07:41:26 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityInstanceService.java 2015-05-01 14:30:18 +0000
@@ -132,13 +132,14 @@
* @param skipMeta indicates whether to include meta data in the response.
* @param page the page number.
* @param pageSize the page size.
+ * @param totalPages indicates whether to include the total number of pages.
* @param skipPaging whether to skip paging.
* @return a TrackedEntityInstanceQueryParams.
*/
TrackedEntityInstanceQueryParams getFromUrl( String query, Set<String> attribute, Set<String> filter,
Set<String> ou, OrganisationUnitSelectionMode ouMode, String program, ProgramStatus programStatus,
Boolean followUp, Date programStartDate, Date programEndDate, String trackedEntity, EventStatus eventStatus,
- Date eventStartDate, Date eventEndDate, boolean skipMeta, Integer page, Integer pageSize, boolean skipPaging );
+ Date eventStartDate, Date eventEndDate, boolean skipMeta, Integer page, Integer pageSize, boolean totalPages, boolean skipPaging );
/**
* Decides whether current user is authorized to perform the given query.
=== modified file 'dhis-2/dhis-services/dhis-service-tracker/src/main/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityInstanceService.java'
--- dhis-2/dhis-services/dhis-service-tracker/src/main/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityInstanceService.java 2015-04-21 16:11:31 +0000
+++ dhis-2/dhis-services/dhis-service-tracker/src/main/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityInstanceService.java 2015-05-01 14:30:18 +0000
@@ -264,8 +264,13 @@
if ( params.isPaging() )
{
- int count = trackedEntityInstanceStore.getTrackedEntityInstanceCount( params );
-
+ int count = 0;
+
+ if ( params.isTotalPages() )
+ {
+ count = trackedEntityInstanceStore.getTrackedEntityInstanceCount( params );
+ }
+
Pager pager = new Pager( params.getPageWithDefault(), count, params.getPageSizeWithDefault() );
metaData.put( PAGER_META_KEY, pager );
}
@@ -378,7 +383,7 @@
public TrackedEntityInstanceQueryParams getFromUrl( String query, Set<String> attribute, Set<String> filter,
Set<String> ou, OrganisationUnitSelectionMode ouMode, String program, ProgramStatus programStatus,
Boolean followUp, Date programStartDate, Date programEndDate, String trackedEntity, EventStatus eventStatus,
- Date eventStartDate, Date eventEndDate, boolean skipMeta, Integer page, Integer pageSize, boolean skipPaging )
+ Date eventStartDate, Date eventEndDate, boolean skipMeta, Integer page, Integer pageSize, boolean totalPages, boolean skipPaging )
{
TrackedEntityInstanceQueryParams params = new TrackedEntityInstanceQueryParams();
@@ -447,6 +452,7 @@
params.setSkipMeta( skipMeta );
params.setPage( page );
params.setPageSize( pageSize );
+ params.setTotalPages( totalPages );
params.setSkipPaging( skipPaging );
return params;
=== modified file 'dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/event/TrackedEntityInstanceController.java'
--- dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/event/TrackedEntityInstanceController.java 2015-04-28 08:57:55 +0000
+++ dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/event/TrackedEntityInstanceController.java 2015-05-01 14:30:18 +0000
@@ -28,7 +28,16 @@
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
-import com.google.common.collect.Lists;
+import static org.hisp.dhis.system.util.DateUtils.DATE_PATTERN;
+
+import java.io.IOException;
+import java.util.Date;
+import java.util.List;
+import java.util.Set;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
import org.hisp.dhis.common.DxfNamespaces;
import org.hisp.dhis.common.Grid;
import org.hisp.dhis.common.IllegalQueryException;
@@ -40,7 +49,6 @@
import org.hisp.dhis.dxf2.importsummary.ImportStatus;
import org.hisp.dhis.dxf2.importsummary.ImportSummaries;
import org.hisp.dhis.dxf2.importsummary.ImportSummary;
-import org.hisp.dhis.dxf2.objectfilter.ObjectFilterService;
import org.hisp.dhis.event.EventStatus;
import org.hisp.dhis.importexport.ImportStrategy;
import org.hisp.dhis.node.types.CollectionNode;
@@ -68,14 +76,7 @@
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-import java.io.IOException;
-import java.util.Date;
-import java.util.List;
-import java.util.Set;
-
-import static org.hisp.dhis.system.util.DateUtils.DATE_PATTERN;
+import com.google.common.collect.Lists;
/**
* @author Morten Olav Hansen <mortenoh@xxxxxxxxx>
@@ -123,6 +124,7 @@
@RequestParam( required = false ) boolean skipMeta,
@RequestParam( required = false ) Integer page,
@RequestParam( required = false ) Integer pageSize,
+ @RequestParam( required = false ) boolean totalPages,
@RequestParam( required = false ) boolean skipPaging,
Model model,
HttpServletResponse response ) throws Exception
@@ -130,7 +132,7 @@
Set<String> orgUnits = ContextUtils.getQueryParamValues( ou );
TrackedEntityInstanceQueryParams params = instanceService.getFromUrl( query, attribute, filter, orgUnits, ouMode,
program, programStatus, followUp, programStartDate, programEndDate, trackedEntity,
- eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, skipPaging );
+ eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, totalPages, skipPaging );
contextUtils.configureResponse( response, ContextUtils.CONTENT_TYPE_JSON, CacheStrategy.NO_CACHE );
Grid grid = instanceService.getTrackedEntityInstances( params );
@@ -159,6 +161,7 @@
@RequestParam( required = false ) boolean skipMeta,
@RequestParam( required = false ) Integer page,
@RequestParam( required = false ) Integer pageSize,
+ @RequestParam( required = false ) boolean totalPages,
@RequestParam( required = false ) boolean skipPaging,
Model model,
HttpServletResponse response ) throws Exception
@@ -166,7 +169,7 @@
Set<String> orgUnits = ContextUtils.getQueryParamValues( ou );
TrackedEntityInstanceQueryParams params = instanceService.getFromUrl( query, attribute, filter, orgUnits, ouMode,
program, programStatus, followUp, programStartDate, programEndDate, trackedEntity,
- eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, skipPaging );
+ eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, totalPages, skipPaging );
contextUtils.configureResponse( response, ContextUtils.CONTENT_TYPE_XML, CacheStrategy.NO_CACHE );
Grid grid = instanceService.getTrackedEntityInstances( params );
@@ -192,6 +195,7 @@
@RequestParam( required = false ) boolean skipMeta,
@RequestParam( required = false ) Integer page,
@RequestParam( required = false ) Integer pageSize,
+ @RequestParam( required = false ) boolean totalPages,
@RequestParam( required = false ) boolean skipPaging,
Model model,
HttpServletResponse response ) throws Exception
@@ -199,7 +203,7 @@
Set<String> orgUnits = ContextUtils.getQueryParamValues( ou );
TrackedEntityInstanceQueryParams params = instanceService.getFromUrl( query, attribute, filter, orgUnits, ouMode,
program, programStatus, followUp, programStartDate, programEndDate, trackedEntity,
- eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, skipPaging );
+ eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, totalPages, skipPaging );
contextUtils.configureResponse( response, ContextUtils.CONTENT_TYPE_EXCEL, CacheStrategy.NO_CACHE );
Grid grid = instanceService.getTrackedEntityInstances( params );
@@ -225,6 +229,7 @@
@RequestParam( required = false ) boolean skipMeta,
@RequestParam( required = false ) Integer page,
@RequestParam( required = false ) Integer pageSize,
+ @RequestParam( required = false ) boolean totalPages,
@RequestParam( required = false ) boolean skipPaging,
Model model,
HttpServletResponse response ) throws Exception
@@ -232,7 +237,7 @@
Set<String> orgUnits = ContextUtils.getQueryParamValues( ou );
TrackedEntityInstanceQueryParams params = instanceService.getFromUrl( query, attribute, filter, orgUnits, ouMode,
program, programStatus, followUp, programStartDate, programEndDate, trackedEntity,
- eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, skipPaging );
+ eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, totalPages, skipPaging );
contextUtils.configureResponse( response, ContextUtils.CONTENT_TYPE_CSV, CacheStrategy.NO_CACHE );
Grid grid = instanceService.getTrackedEntityInstances( params );
