1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
/* ResultSetMetaData.java -- Returns information about the ResultSet
Copyright (C) 1999 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.
As a special exception, if you link this library with other files to
produce an executable, this library does not by itself cause the
resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why the
executable file might be covered by the GNU General Public License. */
package java.sql;
/**
* This interface provides a mechanism for obtaining information about
* the columns that are present in a <code>ResultSet</code>.
* <p>
* Note that in this class column indexes start at 1, not 0.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
public interface ResultSetMetaData
{
/**
* The column does not allow NULL's.
*/
public static final int columnNoNulls = 0;
/**
* The column allows NULL's.
*/
public static final int columnNullable = 1;
/**
* It is unknown whether or not the column allows NULL's.
*/
public static final int columnNullableUnknown = 2;
/*************************************************************************/
/**
* This method returns the number of columns in the result set.
*
* @return The number of columns in the result set.
*
* @exception SQLException If an error occurs.
*/
public abstract int
getColumnCount() throws SQLException;
/*************************************************************************/
/**
* This method test whether or not the column is an auto-increment column.
* Auto-increment columns are read-only.
*
* @param index The index of the column to test.
*
* @return <code>true</code> if the column is auto-increment, <code>false</code>
* otherwise.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
isAutoIncrement(int index) throws SQLException;
/*************************************************************************/
/**
* This method tests whether or not a column is case sensitive in its values.
*
* @param index The index of the column to test.
*
* @return <code>true</code> if the column value is case sensitive,
* <code>false</code> otherwise.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
isCaseSensitive(int index) throws SQLException;
/*************************************************************************/
/**
* This method tests whether not the specified column can be used in
* a WHERE clause.
*
* @param index The index of the column to test.
*
* @return <code>true</code> if the column may be used in a WHERE clause,
* <code>false</code> otherwise.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
isSearchable(int index) throws SQLException;
/*************************************************************************/
/**
* This method tests whether or not the column stores a monetary value.
*
* @param index The index of the column to test.
*
* @return <code>true</code> if the column contains a monetary value,
* <code>false</code> otherwise.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
isCurrency(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns a value indicating whether or not the specified
* column may contain a NULL value.
*
* @param index The index of the column to test.
*
* @return A constant indicating whether or not the column can contain NULL,
* which will be one of <code>columnNoNulls</code>,
* <code>columnNullable</code>, or <code>columnNullableUnknown</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract int
isNullable(int index) throws SQLException;
/*************************************************************************/
/**
* This method tests whether or not the value of the specified column
* is signed or unsigned.
*
* @param index The index of the column to test.
*
* @return <code>true</code> if the column value is signed, <code>false</code>
* otherwise.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
isSigned(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the maximum number of characters that can be used
* to display a value in this column.
*
* @param index The index of the column to check.
*
* @return The maximum number of characters that can be used to display a
* value for this column.
*
* @exception SQLException If an error occurs.
*/
public abstract int
getColumnDisplaySize(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns a string that should be used as a caption for this
* column for user display purposes.
*
* @param index The index of the column to check.
*
* @return A display string for the column.
*
* @exception SQLException If an error occurs.
*/
public abstract String
getColumnLabel(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the name of the specified column.
*
* @param index The index of the column to return the name of.
*
* @return The name of the column.
*
* @exception SQLException If an error occurs.
*/
public abstract String
getColumnName(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the name of the schema that contains the specified
* column.
*
* @param index The index of the column to check the schema name for.
*
* @return The name of the schema that contains the column.
*
* @exception SQLException If an error occurs.
*/
public abstract String
getSchemaName(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the precision of the specified column, which is the
* number of decimal digits it contains.
*
* @param index The index of the column to check the precision on.
*
* @return The precision of the specified column.
*
* @exception SQLException If an error occurs.
*/
public abstract int
getPrecision(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the scale of the specified column, which is the
* number of digits to the right of the decimal point.
*
* @param index The index column to check the scale of.
*
* @return The scale of the column.
*
* @exception SQLException If an error occurs.
*/
public abstract int
getScale(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the name of the table containing the specified
* column.
*
* @param index The index of the column to check the table name for.
*
* @return The name of the table containing the column.
*
* @exception SQLException If an error occurs.
*/
public abstract String
getTableName(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the name of the catalog containing the specified
* column.
*
* @param index The index of the column to check the catalog name for.
*
* @return The name of the catalog containing the column.
*
* @exception SQLException If an error occurs.
*/
public abstract String
getCatalogName(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the SQL type of the specified column. This will
* be one of the constants from <code>Types</code>.
*
* @param index The index of the column to check the SQL type of.
*
* @return The SQL type for this column.
*
* @exception SQLException If an error occurs.
*
* @see Types
*/
public abstract int
getColumnType(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the name of the SQL type for this column.
*
* @param index The index of the column to check the SQL type name for.
*
* @return The name of the SQL type for this column.
*
* @exception SQLException If an error occurs.
*/
public abstract String
getColumnTypeName(int index) throws SQLException;
/*************************************************************************/
/**
* This method tests whether or not the specified column is read only.
*
* @param index The index of the column to check.
*
* @return <code>true</code> if the column is read only, <code>false</code>
* otherwise.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
isReadOnly(int index) throws SQLException;
/*************************************************************************/
/**
* This method tests whether or not the column may be writable. This
* does not guarantee that a write will be successful.
*
* @param index The index of the column to check for writability.
*
* @return <code>true</code> if the column may be writable,
* <code>false</code> otherwise.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
isWritable(int index) throws SQLException;
/*************************************************************************/
/**
* This method tests whether or not the column is writable. This
* does guarantee that a write will be successful.
*
* @param index The index of the column to check for writability.
*
* @return <code>true</code> if the column is writable,
* <code>false</code> otherwise.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
isDefinitelyWritable(int index) throws SQLException;
} // interface ResultSetMetaData
|
