dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #34992
[Branch ~dhis2-devs-core/dhis2/trunk] Rev 17954: Added class PageRange. Useful for calculating page ranges, e.g. in iterations.
------------------------------------------------------------
revno: 17954
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2
timestamp: Tue 2015-01-13 14:26:18 +0100
message:
Added class PageRange. Useful for calculating page ranges, e.g. in iterations.
added:
dhis-2/dhis-support/dhis-support-system/src/main/java/org/hisp/dhis/system/util/PageRange.java
dhis-2/dhis-support/dhis-support-system/src/test/java/org/hisp/dhis/system/util/PageRangeTest.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
=== added file 'dhis-2/dhis-support/dhis-support-system/src/main/java/org/hisp/dhis/system/util/PageRange.java'
--- dhis-2/dhis-support/dhis-support-system/src/main/java/org/hisp/dhis/system/util/PageRange.java 1970-01-01 00:00:00 +0000
+++ dhis-2/dhis-support/dhis-support-system/src/main/java/org/hisp/dhis/system/util/PageRange.java 2015-01-13 13:26:18 +0000
@@ -0,0 +1,138 @@
+package org.hisp.dhis.system.util;
+
+/*
+ * Copyright (c) 2004-2014, University of Oslo
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * Neither the name of the HISP project nor the names of its contributors may
+ * be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @author Lars Helge Overland
+ */
+public class PageRange
+{
+ /**
+ * The current from index.
+ */
+ private int fromIndex = 0;
+
+ /**
+ * The current to index.
+ */
+ private int toIndex = 0;
+
+ /**
+ * Total number of values.
+ */
+ private int values;
+
+ /**
+ * Size of pages.
+ */
+ private int pageSize;
+
+ protected PageRange()
+ {
+ }
+
+ public PageRange( int values )
+ {
+ this.values = values;
+ }
+
+ public PageRange setPageSize( int pageSize )
+ {
+ this.pageSize = pageSize;
+ return this;
+ }
+
+ public PageRange setPages( int pages )
+ {
+ this.pageSize = (int) Math.ceil( (double) values / pages );
+ return this;
+ }
+
+ /**
+ * Moves the range to the next page. Returns true if the range has another page,
+ * false if not.
+ */
+ public boolean nextPage()
+ {
+ if ( toIndex >= values )
+ {
+ return false;
+ }
+
+ if ( toIndex > 0 ) // Not first invocation
+ {
+ fromIndex += pageSize;
+ }
+
+ toIndex = Math.min( ( fromIndex + pageSize ), values );
+
+ return true;
+ }
+
+ /**
+ * Returns the number of pages in the list.
+ */
+ public int pageCount()
+ {
+ int r = values / pageSize;
+ int m = values % pageSize;
+
+ return m == 0 ? r : ( r + 1 );
+ }
+
+ /**
+ * Sets the current page position to the first page.
+ */
+ public void reset()
+ {
+ fromIndex = 0;
+ toIndex = 0;
+ }
+
+ /**
+ * Returns the current from index, which is closed / inclusive.
+ */
+ public int getFromIndex()
+ {
+ return fromIndex;
+ }
+
+ /**
+ * Returns the current to index, which is open / exclusive.
+ */
+ public int getToIndex()
+ {
+ if ( toIndex == 0 )
+ {
+ throw new IllegalStateException( "nextPage() must be called before getToIndex()" );
+ }
+
+ return toIndex;
+ }
+}
=== added file 'dhis-2/dhis-support/dhis-support-system/src/test/java/org/hisp/dhis/system/util/PageRangeTest.java'
--- dhis-2/dhis-support/dhis-support-system/src/test/java/org/hisp/dhis/system/util/PageRangeTest.java 1970-01-01 00:00:00 +0000
+++ dhis-2/dhis-support/dhis-support-system/src/test/java/org/hisp/dhis/system/util/PageRangeTest.java 2015-01-13 13:26:18 +0000
@@ -0,0 +1,78 @@
+package org.hisp.dhis.system.util;
+
+/*
+ * Copyright (c) 2004-2014, University of Oslo
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * Neither the name of the HISP project nor the names of its contributors may
+ * be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+import org.junit.Test;
+import static org.junit.Assert.*;
+
+/**
+ * @author Lars Helge Overland
+ */
+public class PageRangeTest
+{
+ @Test
+ public void testPageSize()
+ {
+ PageRange range = new PageRange( 12 ).setPageSize( 5 );
+
+ assertTrue( range.nextPage() );
+ assertEquals( 0, range.getFromIndex() );
+ assertEquals( 5, range.getToIndex() );
+
+ assertTrue( range.nextPage() );
+ assertEquals( 5, range.getFromIndex() );
+ assertEquals( 10, range.getToIndex() );
+
+ assertTrue( range.nextPage() );
+ assertEquals( 10, range.getFromIndex() );
+ assertEquals( 12, range.getToIndex() );
+
+ assertFalse( range.nextPage() );
+ }
+
+ @Test
+ public void testPages()
+ {
+ PageRange range = new PageRange( 11 ).setPages( 3 );
+
+ assertTrue( range.nextPage() );
+ assertEquals( 0, range.getFromIndex() );
+ assertEquals( 4, range.getToIndex() );
+
+ assertTrue( range.nextPage() );
+ assertEquals( 4, range.getFromIndex() );
+ assertEquals( 8, range.getToIndex() );
+
+ assertTrue( range.nextPage() );
+ assertEquals( 8, range.getFromIndex() );
+ assertEquals( 11, range.getToIndex() );
+
+ assertFalse( range.nextPage() );
+ }
+}
