Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
ITableModel |
|
| 1.0;1 |
1 | // Copyright 2004, 2005 The Apache Software Foundation |
|
2 | // |
|
3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
|
4 | // you may not use this file except in compliance with the License. |
|
5 | // You may obtain a copy of the License at |
|
6 | // |
|
7 | // http://www.apache.org/licenses/LICENSE-2.0 |
|
8 | // |
|
9 | // Unless required by applicable law or agreed to in writing, software |
|
10 | // distributed under the License is distributed on an "AS IS" BASIS, |
|
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
12 | // See the License for the specific language governing permissions and |
|
13 | // limitations under the License. |
|
14 | ||
15 | package org.apache.tapestry.contrib.table.model; |
|
16 | ||
17 | import java.util.Iterator; |
|
18 | ||
19 | /** |
|
20 | * The main interface defining the abstraction containing the table data and |
|
21 | * state. |
|
22 | * |
|
23 | * @author mindbridge |
|
24 | */ |
|
25 | public interface ITableModel |
|
26 | { |
|
27 | ||
28 | /** |
|
29 | * Method getColumnModel. |
|
30 | * |
|
31 | * @return ITableColumnModel the column model of the table |
|
32 | */ |
|
33 | ITableColumnModel getColumnModel(); |
|
34 | ||
35 | /** |
|
36 | * Method getSortingState. |
|
37 | * |
|
38 | * @return ITableSortingState the sorting state of the table |
|
39 | */ |
|
40 | ITableSortingState getSortingState(); |
|
41 | ||
42 | /** |
|
43 | * Method getPagingState. |
|
44 | * |
|
45 | * @return ITablePagingState the paging state of the table |
|
46 | */ |
|
47 | ITablePagingState getPagingState(); |
|
48 | ||
49 | /** |
|
50 | * Method getPageCount. |
|
51 | * |
|
52 | * @return int the number of pages this table would have given the current |
|
53 | * data and paging state |
|
54 | */ |
|
55 | int getPageCount(); |
|
56 | ||
57 | /** |
|
58 | * Method getCurrentPageRows. |
|
59 | * |
|
60 | * @return Iterator the rows in the current table page given the current |
|
61 | * data, sorting, and paging state |
|
62 | */ |
|
63 | Iterator getCurrentPageRows(); |
|
64 | ||
65 | /** |
|
66 | * Returns the total number of rows / values this model is managing. |
|
67 | * |
|
68 | * @return The total number of rows - if known. |
|
69 | */ |
|
70 | int getRowCount(); |
|
71 | } |