KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > app > table > TableModel


1 /*
2  * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3  * Copyright (C) 2002-2005 NextApp, Inc.
4  *
5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6  *
7  * The contents of this file are subject to the Mozilla Public License Version
8  * 1.1 (the "License"); you may not use this file except in compliance with
9  * the License. You may obtain a copy of the License at
10  * http://www.mozilla.org/MPL/
11  *
12  * Software distributed under the License is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14  * for the specific language governing rights and limitations under the
15  * License.
16  *
17  * Alternatively, the contents of this file may be used under the terms of
18  * either the GNU General Public License Version 2 or later (the "GPL"), or
19  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20  * in which case the provisions of the GPL or the LGPL are applicable instead
21  * of those above. If you wish to allow use of your version of this file only
22  * under the terms of either the GPL or the LGPL, and not to allow others to
23  * use your version of this file under the terms of the MPL, indicate your
24  * decision by deleting the provisions above and replace them with the notice
25  * and other provisions required by the GPL or the LGPL. If you do not delete
26  * the provisions above, a recipient may use your version of this file under
27  * the terms of any one of the MPL, the GPL or the LGPL.
28  */
29
30 package nextapp.echo2.app.table;
31
32 import java.io.Serializable JavaDoc;
33
34 import nextapp.echo2.app.event.TableModelListener;
35
36 /**
37  * A model which represents data in a table format.
38  */
39 public interface TableModel
40 extends Serializable JavaDoc {
41     
42     /**
43      * Adds a listener that will be notified of changes/
44      *
45      * @param l the listener to add
46      */
47     public void addTableModelListener(TableModelListener l);
48     
49     /**
50      * Returns the most-specific class of objects found in a given table
51      * column. Every object in the specified column must be an instance
52      * of the returned class.
53      *
54      * @param column the column index (0-based)
55      * @return the most-specific class of object found in the specified
56      * column
57      */
58     public Class JavaDoc getColumnClass(int column);
59
60     /**
61      * Returns the number of columns in the table.
62      *
63      * @return the column count
64      */
65     public int getColumnCount();
66     
67     /**
68      * Returns the name of the specified column number.
69      *
70      * @param column the column index (0-based)
71      * @return the column name
72      */
73     public String JavaDoc getColumnName(int column);
74     
75     /**
76      * Returns the number of rows in the table.
77      *
78      * @return the row count
79      */
80     public int getRowCount();
81     
82     /**
83      * Returns the value found at the given coordinate within the table.
84      * Column and row values are 0-based.
85      * <strong>WARNING: Take note that the column is the first parameter
86      * passed to this method, and the row is the second parameter.</strong>
87      *
88      * @param column the column index (0-based)
89      * @param row the row index (0-based)
90      */
91     public Object JavaDoc getValueAt(int column, int row);
92     
93     /**
94      * Removes a listener from being notified of changes.
95      *
96      * @param l the listener to remove
97      */
98     public void removeTableModelListener(TableModelListener l);
99 }
100
Popular Tags