1 /*
2 *
3 * The DbUnit Database Testing Framework
4 * Copyright (C)2002-2004, DbUnit.org
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 */
21
22 package org.dbunit.dataset;
23
24
25 /**
26 * Represents table metadata.
27 *
28 * @author Manuel Laflamme
29 * @version $Revision$
30 * @since Feb 17, 2002
31 */
32 public interface ITableMetaData
33 {
34 /**
35 * Returns this table name.
36 * @return this table name
37 */
38 public String getTableName();
39
40 /**
41 * Returns this table columns as recognized by dbunit. In cases where columns are resolved
42 * using database metadata it can happen that an empty array is returned when a table does
43 * not have a single column that is recognized by the configured
44 * {@link org.dbunit.dataset.datatype.IDataTypeFactory}.
45 * Note that it is <b>not</b> an exceptional case within dbunit when a {@link ITableMetaData}
46 * does not have a column.
47 * @return The columns for this table
48 * @throws DataSetException
49 */
50 public Column[] getColumns() throws DataSetException;
51
52 /**
53 * Returns this table primary key columns.
54 * @return this table primary key columns.
55 * @throws DataSetException
56 */
57 public Column[] getPrimaryKeys() throws DataSetException;
58
59 /**
60 * Returns the column's array index of the column with the given name within this table metadata.
61 * @param columnName The name of the column that is searched
62 * @return The index of the given column within this metadata, starting with 0 for the first column
63 * @throws NoSuchColumnException if the given column has not been found
64 * @throws DataSetException if something goes wrong when trying to retrieve the columns
65 * @since 2.3.0
66 */
67 public int getColumnIndex(String columnName) throws DataSetException;
68 }