001 package org.apache.ojb.broker.accesslayer.sql;
002
003 /* Copyright 2002-2005 The Apache Software Foundation
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018 import org.apache.ojb.broker.metadata.FieldDescriptor;
019 import org.apache.ojb.broker.query.Query;
020
021 /**
022 * This class
023 *
024 * @author <a href="mailto:arminw@apache.org">Armin Waibel</a>
025 * @version $Id: SelectStatement.java,v 1.1 2007-08-24 22:17:39 ewestfal Exp $
026 */
027 public interface SelectStatement extends SqlStatement
028 {
029 /**
030 * Returns the {@link org.apache.ojb.broker.query.Query} instance
031 * this statement based on.
032 * @return The {@link org.apache.ojb.broker.query.Query} instance or <em>null</em>
033 * if no query is used to generate the select string.
034 */
035 public Query getQueryInstance();
036
037 /**
038 * Returns the column index of the specified {@link org.apache.ojb.broker.metadata.FieldDescriptor}
039 * in the {@link java.sql.ResultSet} after performing the query.
040 *
041 * @param fld The {@link org.apache.ojb.broker.metadata.FieldDescriptor}.
042 * @return The column index or {@link org.apache.ojb.broker.metadata.JdbcType#MIN_INT} if
043 * column index is not supported.
044 */
045 public int getColumnIndex(FieldDescriptor fld);
046 }