Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
SelectStatement |
|
| 1.0;1 |
1 | package org.apache.ojb.broker.accesslayer.sql; | |
2 | ||
3 | /* Copyright 2002-2005 The Apache Software Foundation | |
4 | * | |
5 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
6 | * you may not use this file except in compliance with the License. | |
7 | * You may obtain a copy of the License at | |
8 | * | |
9 | * http://www.apache.org/licenses/LICENSE-2.0 | |
10 | * | |
11 | * Unless required by applicable law or agreed to in writing, software | |
12 | * distributed under the License is distributed on an "AS IS" BASIS, | |
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
14 | * See the License for the specific language governing permissions and | |
15 | * limitations under the License. | |
16 | */ | |
17 | ||
18 | import org.apache.ojb.broker.metadata.FieldDescriptor; | |
19 | import org.apache.ojb.broker.query.Query; | |
20 | ||
21 | /** | |
22 | * This class | |
23 | * | |
24 | * @author <a href="mailto:arminw@apache.org">Armin Waibel</a> | |
25 | * @version $Id: SelectStatement.java,v 1.1 2007-08-24 22:17:39 ewestfal Exp $ | |
26 | */ | |
27 | public interface SelectStatement extends SqlStatement | |
28 | { | |
29 | /** | |
30 | * Returns the {@link org.apache.ojb.broker.query.Query} instance | |
31 | * this statement based on. | |
32 | * @return The {@link org.apache.ojb.broker.query.Query} instance or <em>null</em> | |
33 | * if no query is used to generate the select string. | |
34 | */ | |
35 | public Query getQueryInstance(); | |
36 | ||
37 | /** | |
38 | * Returns the column index of the specified {@link org.apache.ojb.broker.metadata.FieldDescriptor} | |
39 | * in the {@link java.sql.ResultSet} after performing the query. | |
40 | * | |
41 | * @param fld The {@link org.apache.ojb.broker.metadata.FieldDescriptor}. | |
42 | * @return The column index or {@link org.apache.ojb.broker.metadata.JdbcType#MIN_INT} if | |
43 | * column index is not supported. | |
44 | */ | |
45 | public int getColumnIndex(FieldDescriptor fld); | |
46 | } |