dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #31270
[Branch ~dhis2-devs-core/dhis2/trunk] Rev 15919: TEI query, paging is on by default. Added new param skipPaging=true|false
------------------------------------------------------------
revno: 15919
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2
timestamp: Mon 2014-06-30 20:07:45 +0200
message:
TEI query, paging is on by default. Added new param skipPaging=true|false
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 2014-06-27 10:12:09 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityInstanceQueryParams.java 2014-06-30 18:07:45 +0000
@@ -60,6 +60,9 @@
public static final String META_DATA_NAMES_KEY = "names";
public static final String PAGER_META_KEY = "pager";
+ public static final int DEFAULT_PAGE = 1;
+ public static final int DEFAULT_PAGE_SIZE = 50;
+
/**
* Query value, will apply to all relevant attributes.
*/
@@ -147,6 +150,11 @@
*/
private Integer pageSize;
+ /**
+ * Indicates whether paging should be skipped.
+ */
+ private boolean skipPaging;
+
// -------------------------------------------------------------------------
// Constructors
// -------------------------------------------------------------------------
@@ -464,7 +472,7 @@
*/
public int getPageWithDefault()
{
- return page != null && page > 0 ? page : 1;
+ return page != null && page > 0 ? page : DEFAULT_PAGE;
}
/**
@@ -472,7 +480,7 @@
*/
public int getPageSizeWithDefault()
{
- return pageSize != null && pageSize >= 0 ? pageSize : 50;
+ return pageSize != null && pageSize >= 0 ? pageSize : DEFAULT_PAGE_SIZE;
}
/**
@@ -482,6 +490,16 @@
{
return ( getPageWithDefault() - 1 ) * getPageSizeWithDefault();
}
+
+ /**
+ * Sets paging properties to default values.
+ */
+ public void setDefaultPaging()
+ {
+ this.page = DEFAULT_PAGE;
+ this.pageSize = DEFAULT_PAGE_SIZE;
+ this.skipPaging = false;
+ }
// -------------------------------------------------------------------------
// toString
@@ -671,4 +689,14 @@
{
this.pageSize = pageSize;
}
+
+ public boolean isSkipPaging()
+ {
+ return skipPaging;
+ }
+
+ public void setSkipPaging( boolean skipPaging )
+ {
+ this.skipPaging = 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 2014-06-12 18:37:50 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/trackedentity/TrackedEntityInstanceService.java 2014-06-30 18:07:45 +0000
@@ -132,12 +132,13 @@
* @param skipMeta indicates whether to include meta data in the response.
* @param page the page number.
* @param pageSize the page size.
+ * @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 );
+ Date eventStartDate, Date eventEndDate, boolean skipMeta, Integer page, Integer pageSize, 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 2014-06-27 10:12:09 +0000
+++ dhis-2/dhis-services/dhis-service-tracker/src/main/java/org/hisp/dhis/trackedentity/DefaultTrackedEntityInstanceService.java 2014-06-30 18:07:45 +0000
@@ -174,6 +174,11 @@
.setLevel( organisationUnitService.getLevelOfOrganisationUnit( organisationUnit.getId() ) );
}
}
+
+ if ( !params.isPaging() && !params.isSkipPaging() )
+ {
+ params.setDefaultPaging();
+ }
// ---------------------------------------------------------------------
// If params of type query and no attributes or filters defined, use
@@ -358,7 +363,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 )
+ Date eventStartDate, Date eventEndDate, boolean skipMeta, Integer page, Integer pageSize, boolean skipPaging )
{
TrackedEntityInstanceQueryParams params = new TrackedEntityInstanceQueryParams();
@@ -427,6 +432,7 @@
params.setSkipMeta( skipMeta );
params.setPage( page );
params.setPageSize( pageSize );
+ 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 2014-06-30 17:11:33 +0000
+++ dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/event/TrackedEntityInstanceController.java 2014-06-30 18:07:45 +0000
@@ -112,13 +112,14 @@
@RequestParam( required = false ) boolean skipMeta,
@RequestParam( required = false ) Integer page,
@RequestParam( required = false ) Integer pageSize,
+ @RequestParam( required = false ) boolean skipPaging,
Model model,
HttpServletResponse response ) throws Exception
{
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 );
+ eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, skipPaging );
contextUtils.configureResponse( response, ContextUtils.CONTENT_TYPE_JSON, CacheStrategy.NO_CACHE );
Grid grid = instanceService.getTrackedEntityInstances( params );
@@ -147,13 +148,14 @@
@RequestParam( required = false ) boolean skipMeta,
@RequestParam( required = false ) Integer page,
@RequestParam( required = false ) Integer pageSize,
+ @RequestParam( required = false ) boolean skipPaging,
Model model,
HttpServletResponse response ) throws Exception
{
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 );
+ eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, skipPaging );
contextUtils.configureResponse( response, ContextUtils.CONTENT_TYPE_XML, CacheStrategy.NO_CACHE );
Grid grid = instanceService.getTrackedEntityInstances( params );
@@ -179,13 +181,14 @@
@RequestParam( required = false ) boolean skipMeta,
@RequestParam( required = false ) Integer page,
@RequestParam( required = false ) Integer pageSize,
+ @RequestParam( required = false ) boolean skipPaging,
Model model,
HttpServletResponse response ) throws Exception
{
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 );
+ eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, skipPaging );
contextUtils.configureResponse( response, ContextUtils.CONTENT_TYPE_EXCEL, CacheStrategy.NO_CACHE );
Grid grid = instanceService.getTrackedEntityInstances( params );
@@ -211,13 +214,14 @@
@RequestParam( required = false ) boolean skipMeta,
@RequestParam( required = false ) Integer page,
@RequestParam( required = false ) Integer pageSize,
+ @RequestParam( required = false ) boolean skipPaging,
Model model,
HttpServletResponse response ) throws Exception
{
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 );
+ eventStatus, eventStartDate, eventEndDate, skipMeta, page, pageSize, skipPaging );
contextUtils.configureResponse( response, ContextUtils.CONTENT_TYPE_CSV, CacheStrategy.NO_CACHE );
Grid grid = instanceService.getTrackedEntityInstances( params );
