001 // Copyright 2004, 2005 The Apache Software Foundation 002 // 003 // Licensed under the Apache License, Version 2.0 (the "License"); 004 // you may not use this file except in compliance with the License. 005 // You may obtain a copy of the License at 006 // 007 // http://www.apache.org/licenses/LICENSE-2.0 008 // 009 // Unless required by applicable law or agreed to in writing, software 010 // distributed under the License is distributed on an "AS IS" BASIS, 011 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 012 // See the License for the specific language governing permissions and 013 // limitations under the License. 014 015 package org.apache.tapestry.contrib.table.model; 016 017 import java.util.Iterator; 018 019 /** 020 * The main interface defining the abstraction containing the table data and state 021 * 022 * @author mindbridge 023 */ 024 public interface ITableModel 025 { 026 /** 027 * Method getColumnModel. 028 * @return ITableColumnModel the column model of the table 029 */ 030 ITableColumnModel getColumnModel(); 031 032 /** 033 * Method getSortingState. 034 * @return ITableSortingState the sorting state of the table 035 */ 036 ITableSortingState getSortingState(); 037 /** 038 * Method getPagingState. 039 * @return ITablePagingState the paging state of the table 040 */ 041 ITablePagingState getPagingState(); 042 043 /** 044 * Method getPageCount. 045 * @return int the number of pages this table would have given the current data and paging state 046 */ 047 int getPageCount(); 048 /** 049 * Method getCurrentPageRows. 050 * @return Iterator the rows in the current table page given the current data, sorting, and paging state 051 */ 052 Iterator getCurrentPageRows(); 053 }