001 /*
002 * Copyright 2000-2005 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.sql;
027
028 import java.sql.*;
029
030 /**
031 * An object that contains information about the columns in a
032 * <code>RowSet</code> object. This interface is
033 * an extension of the <code>ResultSetMetaData</code> interface with
034 * methods for setting the values in a <code>RowSetMetaData</code> object.
035 * When a <code>RowSetReader</code> object reads data into a <code>RowSet</code>
036 * object, it creates a <code>RowSetMetaData</code> object and initializes it
037 * using the methods in the <code>RowSetMetaData</code> interface. Then the
038 * reader passes the <code>RowSetMetaData</code> object to the rowset.
039 * <P>
040 * The methods in this interface are invoked internally when an application
041 * calls the method <code>RowSet.execute</code>; an application
042 * programmer would not use them directly.
043 *
044 * @since 1.4
045 */
046
047 public interface RowSetMetaData extends ResultSetMetaData {
048
049 /**
050 * Sets the number of columns in the <code>RowSet</code> object to
051 * the given number.
052 *
053 * @param columnCount the number of columns in the <code>RowSet</code> object
054 * @exception SQLException if a database access error occurs
055 */
056 void setColumnCount(int columnCount) throws SQLException;
057
058 /**
059 * Sets whether the designated column is automatically numbered,
060 * The default is for a <code>RowSet</code> object's
061 * columns not to be automatically numbered.
062 *
063 * @param columnIndex the first column is 1, the second is 2, ...
064 * @param property <code>true</code> if the column is automatically
065 * numbered; <code>false</code> if it is not
066 *
067 * @exception SQLException if a database access error occurs
068 */
069 void setAutoIncrement(int columnIndex, boolean property)
070 throws SQLException;
071
072 /**
073 * Sets whether the designated column is case sensitive.
074 * The default is <code>false</code>.
075 *
076 * @param columnIndex the first column is 1, the second is 2, ...
077 * @param property <code>true</code> if the column is case sensitive;
078 * <code>false</code> if it is not
079 *
080 * @exception SQLException if a database access error occurs
081 */
082 void setCaseSensitive(int columnIndex, boolean property)
083 throws SQLException;
084
085 /**
086 * Sets whether the designated column can be used in a where clause.
087 * The default is <code>false</code>.
088 *
089 * @param columnIndex the first column is 1, the second is 2, ...
090 * @param property <code>true</code> if the column can be used in a
091 * <code>WHERE</code> clause; <code>false</code> if it cannot
092 *
093 * @exception SQLException if a database access error occurs
094 */
095 void setSearchable(int columnIndex, boolean property)
096 throws SQLException;
097
098 /**
099 * Sets whether the designated column is a cash value.
100 * The default is <code>false</code>.
101 *
102 * @param columnIndex the first column is 1, the second is 2, ...
103 * @param property <code>true</code> if the column is a cash value;
104 * <code>false</code> if it is not
105 *
106 * @exception SQLException if a database access error occurs
107 */
108 void setCurrency(int columnIndex, boolean property)
109 throws SQLException;
110
111 /**
112 * Sets whether the designated column's value can be set to
113 * <code>NULL</code>.
114 * The default is <code>ResultSetMetaData.columnNullableUnknown</code>
115 *
116 * @param columnIndex the first column is 1, the second is 2, ...
117 * @param property one of the following constants:
118 * <code>ResultSetMetaData.columnNoNulls</code>,
119 * <code>ResultSetMetaData.columnNullable</code>, or
120 * <code>ResultSetMetaData.columnNullableUnknown</code>
121 *
122 * @exception SQLException if a database access error occurs
123 */
124 void setNullable(int columnIndex, int property) throws SQLException;
125
126 /**
127 * Sets whether the designated column is a signed number.
128 * The default is <code>false</code>.
129 *
130 * @param columnIndex the first column is 1, the second is 2, ...
131 * @param property <code>true</code> if the column is a signed number;
132 * <code>false</code> if it is not
133 *
134 * @exception SQLException if a database access error occurs
135 */
136 void setSigned(int columnIndex, boolean property)
137 throws SQLException;
138
139 /**
140 * Sets the designated column's normal maximum width in chars to the
141 * given <code>int</code>.
142 *
143 * @param columnIndex the first column is 1, the second is 2, ...
144 * @param size the normal maximum number of characters for
145 * the designated column
146 *
147 * @exception SQLException if a database access error occurs
148 */
149 void setColumnDisplaySize(int columnIndex, int size)
150 throws SQLException;
151
152 /**
153 * Sets the suggested column title for use in printouts and
154 * displays, if any, to the given <code>String</code>.
155 *
156 * @param columnIndex the first column is 1, the second is 2, ...
157 * @param label the column title
158 * @exception SQLException if a database access error occurs
159 */
160 void setColumnLabel(int columnIndex, String label)
161 throws SQLException;
162
163 /**
164 * Sets the name of the designated column to the given <code>String</code>.
165 *
166 * @param columnIndex the first column is 1, the second is 2, ...
167 * @param columnName the designated column's name
168 * @exception SQLException if a database access error occurs
169 */
170 void setColumnName(int columnIndex, String columnName)
171 throws SQLException;
172
173 /**
174 * Sets the name of the designated column's table's schema, if any, to
175 * the given <code>String</code>.
176 *
177 * @param columnIndex the first column is 1, the second is 2, ...
178 * @param schemaName the schema name
179 * @exception SQLException if a database access error occurs
180 */
181 void setSchemaName(int columnIndex, String schemaName)
182 throws SQLException;
183
184 /**
185 * Sets the designated column's number of decimal digits to the
186 * given <code>int</code>.
187 *
188 * @param columnIndex the first column is 1, the second is 2, ...
189 * @param precision the total number of decimal digits
190 * @exception SQLException if a database access error occurs
191 */
192 void setPrecision(int columnIndex, int precision)
193 throws SQLException;
194
195 /**
196 * Sets the designated column's number of digits to the
197 * right of the decimal point to the given <code>int</code>.
198 *
199 * @param columnIndex the first column is 1, the second is 2, ...
200 * @param scale the number of digits to right of decimal point
201 * @exception SQLException if a database access error occurs
202 */
203 void setScale(int columnIndex, int scale) throws SQLException;
204
205 /**
206 * Sets the designated column's table name, if any, to the given
207 * <code>String</code>.
208 *
209 * @param columnIndex the first column is 1, the second is 2, ...
210 * @param tableName the column's table name
211 * @exception SQLException if a database access error occurs
212 */
213 void setTableName(int columnIndex, String tableName)
214 throws SQLException;
215
216 /**
217 * Sets the designated column's table's catalog name, if any, to the given
218 * <code>String</code>.
219 *
220 * @param columnIndex the first column is 1, the second is 2, ...
221 * @param catalogName the column's catalog name
222 * @exception SQLException if a database access error occurs
223 */
224 void setCatalogName(int columnIndex, String catalogName)
225 throws SQLException;
226
227 /**
228 * Sets the designated column's SQL type to the one given.
229 *
230 * @param columnIndex the first column is 1, the second is 2, ...
231 * @param SQLType the column's SQL type
232 * @exception SQLException if a database access error occurs
233 * @see Types
234 */
235 void setColumnType(int columnIndex, int SQLType)
236 throws SQLException;
237
238 /**
239 * Sets the designated column's type name that is specific to the
240 * data source, if any, to the given <code>String</code>.
241 *
242 * @param columnIndex the first column is 1, the second is 2, ...
243 * @param typeName data source specific type name.
244 * @exception SQLException if a database access error occurs
245 */
246 void setColumnTypeName(int columnIndex, String typeName)
247 throws SQLException;
248
249 }
|