/usr/share/doc/libhsqldb-java-doc/src/org/hsqldb/jdbc/jdbcResultSetMetaData.html is in libhsqldb-java-doc 1.8.0.10-9ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.4.2_11) on Sun Jun 01 22:49:43 BST 2008 -->
<TITLE>
jdbcResultSetMetaData (HSQLDB 1.8.0.10 API)
</TITLE>
<META NAME="keywords" CONTENT="org.hsqldb.jdbc.jdbcResultSetMetaData class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../hsqldbstylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="jdbcResultSetMetaData (HSQLDB 1.8.0.10 API)";
}
</SCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/jdbcResultSetMetaData.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/hsqldb/jdbc/jdbcResultSet.html" title="class in org.hsqldb.jdbc"><B>PREV CLASS</B></A>
<A HREF="../../../org/hsqldb/jdbc/jdbcSavepoint.html" title="class in org.hsqldb.jdbc"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="jdbcResultSetMetaData.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.hsqldb.jdbc</FONT>
<BR>
Class jdbcResultSetMetaData</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>org.hsqldb.jdbc.jdbcResultSetMetaData</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.sql.ResultSetMetaData</DD>
</DL>
<HR>
<DL>
<DT>public class <B>jdbcResultSetMetaData</B><DT>extends java.lang.Object<DT>implements java.sql.ResultSetMetaData</DL>
<P>
<!-- start generic documentation -->
An object that can be used to get information about the types
and properties of the columns in a <code>ResultSet</code> object.
The following code fragment creates the <code>ResultSet</code>
object rs, creates the <code>ResultSetMetaData</code> object rsmd,
and uses rsmd to find out how many columns rs has and whether the
first column in rs can be used in a <code>WHERE</code> clause.
<PRE>
ResultSet rs = stmt.executeQuery("SELECT a, b, c FROM TABLE2");
ResultSetMetaData rsmd = rs.getMetaData();
int numberOfColumns = rsmd.getColumnCount();
boolean b = rsmd.isSearchable(1);
</PRE>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
HSQLDB supports a subset of the <code>ResultSetMetaData</code> interface.<p>
The JDBC specification for <code>ResultSetMetaData</code> is in part very
vague. This causes potential incompatibility between interpretations of the
specification as realized in different JDBC driver implementations. As such,
deciding to what degree reporting ResultSetMetaData is accurate has been
considered very carefully. Hopefully, the design decisions made in light of
these considerations have yeilded precisely the subset of full
ResultSetMetaData support that is most commonly needed and that is most
important, while also providing, under the most common use-cases, the
fastest access with the least overhead and the best comprimise between
speed, accuracy, jar-foootprint and retention of JDBC resources. <p>
(fredt@users) <br>
(boucherb@users)<p>
</div>
<!-- end release-specific documentation -->
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>boucherb@users</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/hsqldb/jdbc/jdbcStatement.html#executeQuery(java.lang.String)"><CODE>jdbcStatement.executeQuery(java.lang.String)</CODE></A>,
<A HREF="../../../org/hsqldb/jdbc/jdbcStatement.html#getResultSet()"><CODE>jdbcStatement.getResultSet()</CODE></A>,
<CODE>ResultSetMetaData</CODE></DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_java.sql.ResultSetMetaData"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Fields inherited from interface java.sql.ResultSetMetaData</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>columnNoNulls, columnNullable, columnNullableUnknown</CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getCatalogName(int)">getCatalogName</A></B>(int column)</CODE>
<BR>
Gets the designated column's table's catalog name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getColumnClassName(int)">getColumnClassName</A></B>(int column)</CODE>
<BR>
Returns the fully-qualified name of the Java class whose instances
are manufactured if the method <code>ResultSet.getObject</code>
is called to retrieve a value from the column.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getColumnCount()">getColumnCount</A></B>()</CODE>
<BR>
Returns the number of columns in this <code>ResultSet</code>
object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getColumnDisplaySize(int)">getColumnDisplaySize</A></B>(int column)</CODE>
<BR>
Indicates the designated column's normal maximum width in
characters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getColumnLabel(int)">getColumnLabel</A></B>(int column)</CODE>
<BR>
Gets the designated column's suggested title for use in printouts and
displays.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getColumnName(int)">getColumnName</A></B>(int column)</CODE>
<BR>
Get the designated column's name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getColumnType(int)">getColumnType</A></B>(int column)</CODE>
<BR>
Retrieves the designated column's SQL type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getColumnTypeName(int)">getColumnTypeName</A></B>(int column)</CODE>
<BR>
Retrieves the designated column's database-specific type name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getPrecision(int)">getPrecision</A></B>(int column)</CODE>
<BR>
Get the designated column's number of decimal digits.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getScale(int)">getScale</A></B>(int column)</CODE>
<BR>
Gets the designated column's number of digits to right of the
decimal point.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getSchemaName(int)">getSchemaName</A></B>(int column)</CODE>
<BR>
Get the designated column's table's schema.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getTableName(int)">getTableName</A></B>(int column)</CODE>
<BR>
Gets the designated column's table name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#isAutoIncrement(int)">isAutoIncrement</A></B>(int column)</CODE>
<BR>
Indicates whether the designated column is automatically numbered,
thus read-only.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#isCaseSensitive(int)">isCaseSensitive</A></B>(int column)</CODE>
<BR>
Indicates whether a column's case matters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#isCurrency(int)">isCurrency</A></B>(int column)</CODE>
<BR>
Indicates whether the designated column is a cash value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#isDefinitelyWritable(int)">isDefinitelyWritable</A></B>(int column)</CODE>
<BR>
Indicates whether a write on the designated column will definitely
succeed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#isNullable(int)">isNullable</A></B>(int column)</CODE>
<BR>
Indicates the nullability of values in the designated column.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#isReadOnly(int)">isReadOnly</A></B>(int column)</CODE>
<BR>
Indicates whether the designated column is definitely not writable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#isSearchable(int)">isSearchable</A></B>(int column)</CODE>
<BR>
Indicates whether the designated column can be used in a where
clause.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#isSigned(int)">isSigned</A></B>(int column)</CODE>
<BR>
Indicates whether values in the designated column are signed
numbers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#isWritable(int)">isWritable</A></B>(int column)</CODE>
<BR>
Indicates whether it is possible for a write on the designated
column to succeed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#toString()">toString</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getColumnCount()"><!-- --></A><H3>
getColumnCount</H3>
<PRE>
public int <B>getColumnCount</B>()
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Returns the number of columns in this <code>ResultSet</code>
object. <p>
<!-- end generic documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getColumnCount</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the number of columns
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="isAutoIncrement(int)"><!-- --></A><H3>
isAutoIncrement</H3>
<PRE>
public boolean <B>isAutoIncrement</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Indicates whether the designated column is automatically numbered,
thus read-only. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
HSQLDB 1.7.1 did not report this value accurately,
either always throwing or always returning false, depending
upon client property values.<p>
Starting with HSQLDB 1.7.2, this feature is better supported. <p>
<hr>
However, it must be stated here that, contrary to the generic
documentation above, HSQLDB automatically numbered columns
(IDENTITY columns, in HSQLDB parlance) are not read-only. <p>
In fact, the generic documentation above seems to contradict the general
definition of what, at minimum, an auto-increment column is: <p>
Simply, an auto-increment column is one that guarantees it has a
unique value after a successful insert or update operation, even if
no value is supplied or NULL is explicitly specified by the application
or a default value expression. <p>
Further, without SQL Feature T176, Sequence generator support, the
attributes of the internal source consulted for unique values are not
defined. That is, unlike for a standard SQL SEQUENCE object or a system
with full SQL 9x or 200n support for SQL Feature T174, Identity columns,
an application must not assume and cannot determine in a standard way
that auto-increment values start at any particular point, increment by
any particular value or have any of the other attributes generally
associated with SQL SEQUENCE generators. Further still, without full
support for both feature T174 and T176, if a unique value is supplied
by an application or provided by a declared or implicit default value
expression, then whether that value is used or substituted with one
from the automatic unique value source is implementation-defined
and cannot be known in a standard way. Finally, without full support
for features T174 and T176, it is also implementation-defined and
cannot be know in a standard way whether an exception is thrown or
a unique value is automatically substituted when an application or
default value expression supplies a non-NULL,
non-unique value. <p>
Up to and including HSQLDB 1.7.2, values supplied by an application or
default value expression are used if they are indeed non-NULL unique
values, while an exception is thrown if either possible value source
for the site attempts to supply a non-NULL, non-unique value. This is
very likely to remain the behaviour of HSQLDB for its foreseable
lifetime and at the very least for the duration of the 1.7.x release
series.<p>
<hr>
Regardless of the new and better support for reporting
isAutoIncrement(), it is still possible under certain conditions that
accurate reporting may be impossible. For example, if this object's
parent Connection is closed before the first call to this method or to
any other method of this class that initializes the connection-dependent
ResultSetMetaData values, then it is impossible to report accurately for
result set columns that directly represent table column values.<p>
Under such special circumstances, the driver rethrows the exception that
occured during the initialization, or a SQLException wrapping it. <p>
Those wishing to determine the auto-increment status of a table column
in isolation from ResultSetMetaData can do so by inspecting the
corresponding value of the SYSTEM_COLUMNS.IS_IDENTITY BOOLEAN column which
is also currently included (in a fashion proprietary to HSQLDB) as the
last column of the jdbcDatabaseMetaData.getColumns() result.
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isAutoIncrement</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD><code>true</code> if so; <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="isCaseSensitive(int)"><!-- --></A><H3>
isCaseSensitive</H3>
<PRE>
public boolean <B>isCaseSensitive</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Indicates whether a column's case matters. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
HSQLDB 1.7.1 did not report this value accurately. <p>
Starting with 1.7.2, this feature is better supported. <p>
This method returns true for any column whose data type is a character
type, with the exception of VARCHAR_IGNORECASE for which it returns
false. It also returns false for any column whose data type is a
not a character data type. <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isCaseSensitive</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD><code>true</code> if so; <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="isSearchable(int)"><!-- --></A><H3>
isSearchable</H3>
<PRE>
public boolean <B>isSearchable</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Indicates whether the designated column can be used in a where
clause. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
HSQLDB 1.7.1 did not report this value accurately. <p>
Starting with 1.7.2, this feature is better supported. <p>
If the data type of the column is definitely known to be searchable
in any way under HSQLDB, then true is returned, else false. That is,
if the type is reported in DatabaseMetaData.getTypeInfo() as having
DatabaseMetaData.typePredNone or is not reported, then false is
returned, else true.
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isSearchable</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD><code>true</code> if so; <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="isCurrency(int)"><!-- --></A><H3>
isCurrency</H3>
<PRE>
public boolean <B>isCurrency</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Indicates whether the designated column is a cash value. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
Up to and including HSQLDB 1.7.2, this method always returns
false. <p>
This is because true fixed (precision,scale) data types are not yet
supported. That is, DECIMAL and NUMERIC types are implemented
as a thin wrap of java.math.BigDecimal, which cannot, without
additional, as yet unimplemented constraint enforcement code, be
said to be a fixed (precision,scale) types. <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isCurrency</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD><code>true</code> if so; <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="isNullable(int)"><!-- --></A><H3>
isNullable</H3>
<PRE>
public int <B>isNullable</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Indicates the nullability of values in the designated column. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
Up to 1.7.1, HSQLDB did not report this value accurately. <p>
Starting with 1.7.2, this feature is better supported. <p>
columnNullableUnknown is always returned for result set columns that
do not directly represent table column values (i.e. are calculated),
while the corresponding value in SYSTEM_COLUMNS.NULLABLE is returned
for result set columns that do directly represent table column values. <p>
Those wishing to determine the nullable status of a table column in
isolation from ResultSetMetaData and in a DBMS-independent fashion
can do so by calling DatabaseMetaData.getColumns() with the appropriate
filter values and inspecting the result at the position described in
the API documentation. <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isNullable</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>the nullability status of the given column; one of
<code>columnNoNulls</code>,
<code>columnNullable</code> or <code>columnNullableUnknown</code>
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="isSigned(int)"><!-- --></A><H3>
isSigned</H3>
<PRE>
public boolean <B>isSigned</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Indicates whether values in the designated column are signed
numbers. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
HSQLDB 1.7.1 introduced support for this feature and 1.7.2
reports identical values (although using a slightly different
implementation).<p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isSigned</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD><code>true</code> if so; <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getColumnDisplaySize(int)"><!-- --></A><H3>
getColumnDisplaySize</H3>
<PRE>
public int <B>getColumnDisplaySize</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Indicates the designated column's normal maximum width in
characters. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
Up to and including HSQLDB 1.7.1, this method always returned
0, which was intended to convey unknown display size.
Unfortunately, this value is not universally handled by all
clients and in the worst case can cause some applications to
crash. <p>
Starting with 1.7.2, this feature is better supported. <p>
The current calculation follows these rules: <p>
<ol>
<li>Long character types and datetime types:<p>
The maximum length/precision, repectively.<p>
<li>CHAR and VARCHAR types: <p>
<ul>
<li> If the result set column is a direct pass through of a table
column value, column size was declared and the connection is
to an embedded database instance, then the declared value is
returned.<p>
<li> Otherwise, the value of the system property
hsqldb.max_xxxchar_display_size or the magic value
32766 (0x7FFE) (tested usable/accepted by most tools and
compatible with assumptions made by java.io read/write
UTF) when the system property is not defined or is not
accessible, due to security constraints. <p>
</ul>
It must be noted that the latter value in no way affects the
ability of the HSQLDB JDBC driver to retrieve longer values
and serves only as the current best effort at providing a
value that maximizes usability across a wide range of tools,
given that the HSQLDB database engine does not require the
length to be declared and does not necessarily enforce it,
even if declared. <p>
<li>Number types: <p>
The max precision, plus the length of the negation character (1),
plus (if applicable) the maximum number of characters that may
occupy the exponent character sequence. Note that some legacy tools
do not correctly handle BIGINT values of greater than 18 digits. <p>
<li>BOOLEAN (BIT) type: <p>
The length of the character sequence "false" (5), the longer of the
two boolean value String representations. <p>
<li>Remaining types: <p>
The maximum length/precision, respectively, as reported by
DatabaseMetaData.getTypeInfo(), when applicable. If the maximum
display size is unknown, unknowable or inapplicable, then zero is
returned. <p>
</ol>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getColumnDisplaySize</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>the normal maximum number of characters allowed as the width
of the designated column
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getColumnLabel(int)"><!-- --></A><H3>
getColumnLabel</H3>
<PRE>
public java.lang.String <B>getColumnLabel</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Gets the designated column's suggested title for use in printouts and
displays. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
In HSQLDB a <code>ResultSet</code> column label is determined in the
following order of precedence:<p>
<OL>
<LI>The label (alias) specified in the generating query.</LI>
<LI>The name of the underlying column, if no label is specified.<br>
This also applies to aggregate functions.</LI>
<LI>An empty <code>String</code>.</LI>
</OL> <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getColumnLabel</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>the suggested column title
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getColumnName(int)"><!-- --></A><H3>
getColumnName</H3>
<PRE>
public java.lang.String <B>getColumnName</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Get the designated column's name. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
In HSQLDB a ResultSet column name is determined in the following
order of prcedence:<p>
<OL>
<LI>The name of the underlying columnm, if the ResultSet column
represents a column in a table.</LI>
<LI>The label or alias specified in the generating query.</LI>
<LI>An empty <code>String</code>.</LI>
</OL> <p>
If the <code>jdbc.get_column_name</code> property of the database
has been set to false, this method returns the same value as
<A HREF="../../../org/hsqldb/jdbc/jdbcResultSetMetaData.html#getColumnLabel(int)"><CODE>getColumnLabel(int)</CODE></A>.<p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getColumnName</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>column name
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getSchemaName(int)"><!-- --></A><H3>
getSchemaName</H3>
<PRE>
public java.lang.String <B>getSchemaName</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Get the designated column's table's schema. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
Up to 1.7.1, HSQLDB did not support the notion of schemas at all,
including schema names in result set metadata; this method always
returned "". <p>
Staring with 1.7.2, schema name reporting is supported only as an
optional, experimental feature that is disabled by default.
Enabling this feature requires setting the database property
"hsqldb.schemas=true". <p>
Specifically, when this feature is enabled under 1.7.2, only very
limited support is provided by the engine for executing SQL containing
schema-qualified database object identifiers. That is, when this
feature is enabled under 1.7.2, it is not yet possible in most cases
to use what would otherwise be the correct, canonical SQL calculated
from ResultSetMetaData. <p>
Regardless, reporting is done only in system table content and is
not yet carried over to ResultSetMetaData. <p>
For greater detail, see discussion at:
<A HREF="../../../org/hsqldb/jdbc/jdbcDatabaseMetaData.html" title="class in org.hsqldb.jdbc"><CODE>jdbcDatabaseMetaData</CODE></A>. <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getSchemaName</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>schema name or "" if not applicable
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getPrecision(int)"><!-- --></A><H3>
getPrecision</H3>
<PRE>
public int <B>getPrecision</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Get the designated column's number of decimal digits. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
Starting with 1.8.0, HSQLDB reports the the declared
length or precision specifiers for table columns (if they are defined,
which up to 1.7.2 is not a requirement in DDL), as these values may or
may not be enforced, depending on the value of the database
property: <p>
<pre>
sql.enforce_strict_size
</pre>
Because the property may change from one instantiation of a Database
to the next and because, when set true, is not applied to existing
values in table columns (only to new values introduced by following
inserts and updates), the length and/or precision specifiers for table
columns still do not neccessarily accurately reflect true constraints
upon the contents of the columns. This situation may or may not change
in a future release. <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getPrecision</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>precision
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getScale(int)"><!-- --></A><H3>
getScale</H3>
<PRE>
public int <B>getScale</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Gets the designated column's number of digits to right of the
decimal point. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
Starting with 1.8.0, HSQLDB reports the declared
scale for table columns depending on the value of the database
property: <p>
<pre>
sql.enforce_strict_size
</pre>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getScale</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>scale
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getTableName(int)"><!-- --></A><H3>
getTableName</H3>
<PRE>
public java.lang.String <B>getTableName</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Gets the designated column's table name. <p>
<!-- end generic documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getTableName</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>table name or "" if not applicable
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getCatalogName(int)"><!-- --></A><H3>
getCatalogName</H3>
<PRE>
public java.lang.String <B>getCatalogName</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Gets the designated column's table's catalog name. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
Up to and including 1.7.1, HSQLDB did not support the notion of
catalog and this method always returned "". <p>
Starting with 1.7.2, HSQLDB supports catalog reporting only as an
optional, experimental feature that is disabled by default. Enabling
this feature requires setting the database property
"hsqldb.catalogs=true". When enabled, the catalog name for table columns
is reported as the name by which the hosting Database knows itself. <p>
HSQLDB does not yet support any use of catalog qualification in
DLL or DML. This fact is accurately indicated in the corresponding
DatabaseMetaData.supportsXXX() method return values. <p>
Regardless, reporting is done only in system table content and is
not yet carried over to ResultSetMetaData. <p>
For greater detail, see discussion at:
<A HREF="../../../org/hsqldb/jdbc/jdbcDatabaseMetaData.html" title="class in org.hsqldb.jdbc"><CODE>jdbcDatabaseMetaData</CODE></A>. <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getCatalogName</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>the name of the catalog for the table in which the given column
appears or "" if not applicable
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getColumnType(int)"><!-- --></A><H3>
getColumnType</H3>
<PRE>
public int <B>getColumnType</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Retrieves the designated column's SQL type. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
This reports the SQL type of the column. HSQLDB can return Objects in
any Java integral type wider than <code>Integer</code> for an SQL
integral type.<p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getColumnType</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>SQL type from java.sql.Types
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs<DT><B>See Also:</B><DD><CODE>Types</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getColumnTypeName(int)"><!-- --></A><H3>
getColumnTypeName</H3>
<PRE>
public java.lang.String <B>getColumnTypeName</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Retrieves the designated column's database-specific type name. <p>
<!-- end generic documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getColumnTypeName</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>type name used by the database. If the column type is
a user-defined type, then a fully-qualified type name is returned.
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="isReadOnly(int)"><!-- --></A><H3>
isReadOnly</H3>
<PRE>
public boolean <B>isReadOnly</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Indicates whether the designated column is definitely not writable.<p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
Up to and including 1.7.1, HSQLDB did not report this value accurately.
<p>
Starting with HSQLDB 1.7.2, this feature is better supported. <p>
For result set columns that do not directly
represent table column values (i.e. are calculated), true is reported.
Otherwise, the read only status of the table and the database are used
in the calculation, but not the read-only status of the session. <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isReadOnly</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD><code>true</code> if so; <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="isWritable(int)"><!-- --></A><H3>
isWritable</H3>
<PRE>
public boolean <B>isWritable</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Indicates whether it is possible for a write on the designated
column to succeed. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
Up to and including 1.7.1, HSQLDB did not report this value accurately.
<p>
Starting with HSQLDB 1.7.2, this feature is better supported. <p>
In essense, the negation of isReadOnly() is reported. <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isWritable</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD><code>true</code> if so; <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="isDefinitelyWritable(int)"><!-- --></A><H3>
isDefinitelyWritable</H3>
<PRE>
public boolean <B>isDefinitelyWritable</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Indicates whether a write on the designated column will definitely
succeed. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
HSQLDB 1.7.1 did not report this value accurately. <p>
Starting with HSQLDB 1.7.2, this method always returns false. The
reason for this is that it is generally either very complex or
simply impossible to calculate deterministically true for table columns
under all concievable conditions. The value is of dubious usefulness, except
perhaps if there were support for updateable result sets using
"SELECT ... FOR UPDATE" style locking. However, this is not anticipated to
occur any time in the 1.7.x release series. <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isDefinitelyWritable</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD><code>true</code> if so; <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="getColumnClassName(int)"><!-- --></A><H3>
getColumnClassName</H3>
<PRE>
public java.lang.String <B>getColumnClassName</B>(int column)
throws java.sql.SQLException</PRE>
<DL>
<DD><!-- start generic documentation -->
Returns the fully-qualified name of the Java class whose instances
are manufactured if the method <code>ResultSet.getObject</code>
is called to retrieve a value from the column.
<code>ResultSet.getObject</code> may return a subclass of the class
returned by this method. <p>
<!-- end generic documentation -->
<!-- start Release-specific documentation -->
<div class="ReleaseSpecificDocumentation">
<h3>HSQLDB-Specific Information:</h3> <p>
HSQLDB 1.7.1 did not support this feature; calling this method
always caused an <code>SQLException</code> to be thrown,
stating that the function was not supported. <p>
</div>
<!-- end release-specific documentation -->
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getColumnClassName</CODE> in interface <CODE>java.sql.ResultSetMetaData</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>column</CODE> - the first column is 1, the second is 2, ...
<DT><B>Returns:</B><DD>the fully-qualified name of the class in the Java programming
language that would be used by the method
<code>ResultSet.getObject</code> to retrieve the value in the
specified column. This is the class name used for custom mapping.
<DT><B>Throws:</B>
<DD><CODE>java.sql.SQLException</CODE> - if a database access error occurs<DT><B>Since:</B></DT>
<DD>JDK 1.2 (JDK 1.1.x developers: read the new overview for
jdbcResultSet)</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/jdbcResultSetMetaData.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/hsqldb/jdbc/jdbcResultSet.html" title="class in org.hsqldb.jdbc"><B>PREV CLASS</B></A>
<A HREF="../../../org/hsqldb/jdbc/jdbcSavepoint.html" title="class in org.hsqldb.jdbc"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="jdbcResultSetMetaData.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<i>Copyright © 2001 - 2005 HSQL Development Group. All Rights Reserved.</i>
</BODY>
</HTML>
|