| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| PagedEnumeration |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * $Source$ | |
| 3 | * $Revision$ | |
| 4 | * | |
| 5 | * Copyright (C) 2000 William Chesters | |
| 6 | * | |
| 7 | * Part of Melati (http://melati.org), a framework for the rapid | |
| 8 | * development of clean, maintainable web applications. | |
| 9 | * | |
| 10 | * Melati is free software; Permission is granted to copy, distribute | |
| 11 | * and/or modify this software under the terms either: | |
| 12 | * | |
| 13 | * a) the GNU General Public License as published by the Free Software | |
| 14 | * Foundation; either version 2 of the License, or (at your option) | |
| 15 | * any later version, | |
| 16 | * | |
| 17 | * or | |
| 18 | * | |
| 19 | * b) any version of the Melati Software License, as published | |
| 20 | * at http://melati.org | |
| 21 | * | |
| 22 | * You should have received a copy of the GNU General Public License and | |
| 23 | * the Melati Software License along with this program; | |
| 24 | * if not, write to the Free Software Foundation, Inc., | |
| 25 | * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the | |
| 26 | * GNU General Public License and visit http://melati.org to obtain the | |
| 27 | * Melati Software License. | |
| 28 | * | |
| 29 | * Feel free to contact the Developers of Melati (http://melati.org), | |
| 30 | * if you would like to work out a different arrangement than the options | |
| 31 | * outlined here. It is our intention to allow Melati to be used by as | |
| 32 | * wide an audience as possible. | |
| 33 | * | |
| 34 | * This program is distributed in the hope that it will be useful, | |
| 35 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 36 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 37 | * GNU General Public License for more details. | |
| 38 | * | |
| 39 | * Contact details for copyright holder: | |
| 40 | * | |
| 41 | * William Chesters <williamc@paneris.org> | |
| 42 | * http://paneris.org/~williamc | |
| 43 | * Obrechtstraat 114, 2517VX Den Haag, The Netherlands | |
| 44 | */ | |
| 45 | ||
| 46 | package org.melati.util; | |
| 47 | ||
| 48 | import java.util.Enumeration; | |
| 49 | import java.util.Vector; | |
| 50 | ||
| 51 | ||
| 52 | /** | |
| 53 | * A paged enumeration. | |
| 54 | */ | |
| 55 | public interface PagedEnumeration<T> extends Enumeration<T> { | |
| 56 | ||
| 57 | /** | |
| 58 | * @return the start record of the page, indexed from 1. | |
| 59 | */ | |
| 60 | int getPageStart(); | |
| 61 | ||
| 62 | /** | |
| 63 | * @return the end record of the page, indexed from 1. | |
| 64 | */ | |
| 65 | int getPageEnd(); | |
| 66 | /** | |
| 67 | * | |
| 68 | * @return the total number of items | |
| 69 | */ | |
| 70 | int getTotalCount(); | |
| 71 | ||
| 72 | /** | |
| 73 | * @return the start record of the previous page, indexed from 1. | |
| 74 | */ | |
| 75 | Integer getPrevPageStart(); | |
| 76 | ||
| 77 | /** | |
| 78 | * @return the start record of the next page, indexed from 1. | |
| 79 | */ | |
| 80 | Integer getNextPageStart(); | |
| 81 | /** | |
| 82 | * @return where we are in the sequence | |
| 83 | */ | |
| 84 | int getCurrentPosition(); | |
| 85 | /** | |
| 86 | * @return the position of the next element in the sequence | |
| 87 | */ | |
| 88 | int getNextPosition(); | |
| 89 | /** | |
| 90 | * @return whether there are more elements on this page | |
| 91 | */ | |
| 92 | boolean nextElementOnThisPage(); | |
| 93 | /** | |
| 94 | * @return the number of elements on a page | |
| 95 | */ | |
| 96 | int getPageSize(); | |
| 97 | /** | |
| 98 | * @return a Vector of Pages | |
| 99 | */ | |
| 100 | Vector<Page> getPages(); | |
| 101 | ||
| 102 | } |