KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > derby > iapi > sql > ResultDescription


1 /*
2
3    Derby - Class org.apache.derby.iapi.sql.ResultDescription
4
5    Licensed to the Apache Software Foundation (ASF) under one or more
6    contributor license agreements. See the NOTICE file distributed with
7    this work for additional information regarding copyright ownership.
8    The ASF licenses this file to you under the Apache License, Version 2.0
9    (the "License"); you may not use this file except in compliance with
10    the License. You may obtain a copy of the License at
11
12       http://www.apache.org/licenses/LICENSE-2.0
13
14    Unless required by applicable law or agreed to in writing, software
15    distributed under the License is distributed on an "AS IS" BASIS,
16    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17    See the License for the specific language governing permissions and
18    limitations under the License.
19
20  */
21
22 package org.apache.derby.iapi.sql;
23
24 /**
25  * The ResultDescription interface provides methods to get metadata on the
26  * results returned by a statement.
27  *
28  * @author Jeff Lichtman
29  */
30
31 public interface ResultDescription
32 {
33     /**
34      * Returns an identifier that tells what type of statement has been
35      * executed. This can be used to determine what other methods to call
36      * to get the results back from a statement. For example, a SELECT
37      * statement returns rows and columns, while other statements don't,
38      * so you would only call getColumnCount() or getColumnType() for
39      * SELECT statements.
40      *
41      * @return A String identifier telling what type of statement this
42      * is.
43      */
44     String JavaDoc getStatementType();
45
46     /**
47      * Returns the number of columns in the result set.
48      *
49      * @return The number of columns in the result set.
50      */
51     int getColumnCount();
52
53     /**
54         Return information about all the columns.
55     */
56     public ResultColumnDescriptor[] getColumnInfo();
57
58     /**
59      * Returns a ResultColumnDescriptor for the column, given the oridinal
60      * position of the column.
61      * NOTE - position is 1-based.
62      *
63      * @param position The oridinal position of a column in the
64      * ResultSet.
65      *
66      * @return A ResultColumnDescriptor describing the
67      * column in the ResultSet.
68      */
69     ResultColumnDescriptor getColumnDescriptor(int position);
70
71     /**
72      * Get a new result description that has been truncated
73      * from input column number. If the input column is
74      * 5, then columns 5 to getColumnCount() are removed.
75      * The new ResultDescription points to the same
76      * ColumnDescriptors (this method performs a shallow
77      * copy.
78      *
79      * @param truncateFrom the starting column to remove,
80      * 1-based.
81      *
82      * @return a new ResultDescription
83      */
84     public ResultDescription truncateColumns(int truncateFrom);
85 }
86
Popular Tags