KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ojb > broker > query > ReportQuery


1 package org.apache.ojb.broker.query;
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 java.util.Map JavaDoc;
19
20 /**
21  * Interface for ReportQueries
22  *
23  * @author <a HREF="mailto:jbraeuchi@gmx.ch">Jakob Braeuchi</a>
24  * @version $Id: ReportQuery.java,v 1.6.2.2 2005/12/21 22:27:09 tomdz Exp $
25  */

26
27 public interface ReportQuery
28 {
29     /**
30      * Gets the columns used for the Report.
31      * @return Returns a String[]
32      * @deprecated use getAttributes()
33      */

34     String JavaDoc[] getColumns();
35
36     /**
37      * Gets the attributes used for the Report.
38      * @return Returns a String[]
39      */

40     String JavaDoc[] getAttributes();
41
42     /**
43      * Gets the Jdbc-Types of the columns used for the Report.
44      * If null the Jdbc-Type is taken from the ResultSet
45      * @return Returns an int[] of Jdbc-Types
46      * @see java.sql.Types
47      */

48     int[] getJdbcTypes();
49     
50     /**
51      * Gets the additional attributes used for building the Join.
52      * These Attributes are not appended to the select-clause.
53      * @return Returns a String[]
54      */

55     String JavaDoc[] getJoinAttributes();
56     
57     /**
58      * Returns a Map with FieldDescriptors identified by Attribute
59      * @return Map
60      */

61     Map JavaDoc getAttributeFieldDescriptors();
62 }
63
Popular Tags