KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > daffodilwoods > daffodildb > server > sql99 > dql > queryexpression > _OrderByClause


1 package com.daffodilwoods.daffodildb.server.sql99.dql.queryexpression;
2
3 import com.daffodilwoods.daffodildb.server.sql99.common.ColumnDetails;
4 import com.daffodilwoods.daffodildb.server.sql99.common.TableDetails;
5 import com.daffodilwoods.daffodildb.server.sql99.utils._Reference;
6 import com.daffodilwoods.database.resource.DException;
7 import java.util.ArrayList JavaDoc;
8 import com.daffodilwoods.database.sqlinitiator._Order;
9 import com.daffodilwoods.daffodildb.server.serversystem._ServerSession;
10
11 /**
12  * It represents the order by clause of select query. It is needed to obtain
13  * desired information about order by clause.
14  * <p>Title: </p>
15  * <p>Description: </p>
16  * <p>Copyright: Copyright (c) 2003</p>
17  * <p>Company: </p>
18  * @author unascribed
19  * @version 1.0
20  */
21
22 public interface _OrderByClause {
23
24    /**
25     * It allows user to obtain all the columns present in order by clause.
26     * @return Array of ColumnDetails
27     * @throws DException
28     */
29
30    public ColumnDetails[] getColumnDetails() throws DException;
31
32    /**
33     * It allows user to obtain as many columns as separated by commas in order
34     * by clause. There may present expression which are combination of more
35     * than one columns. Also in this case only one column with type functional
36     * is returned.
37     * @return
38     * @throws DException
39     */
40
41    public ColumnDetails[] getKeyColumnDetails() throws DException;
42
43    /**
44     * This method is used to ensure the semantic validity of the order by clause.
45     * @param serverSession
46     * @return Array of Object whose value is to be provided by user(like ?).
47     * @throws DException
48     */
49
50    public _Reference[] checkSemantic(_ServerSession serverSession) throws DException;
51
52    /**
53     * It is needed by DDL. It adds the name of tables in passed list.
54     * @param aList
55     * @throws DException
56     */
57
58    public void getTablesIncluded(ArrayList JavaDoc aList) throws DException ;
59
60    /**
61     * It is needed by DDL. It adds the name of columns in passed list.
62     * @param aList
63     * @throws DException
64     */
65
66    public void getColumnsIncluded(ArrayList JavaDoc aList) throws DException ;
67
68    /**
69     * Returns the columns which do not belong to passed tables. It is required
70     * to check whether the columns present in order by clause, belong to tables
71     * of from clause.
72     * @param tableDetails
73     * @return
74     * @throws DException
75     */
76
77    public _Reference[] getReferences(TableDetails[] tableDetails)throws DException;
78
79    /**
80     * It is required to get the order denoting by order by clause.
81     * @return SelectOrder
82     * @throws DException
83     */
84
85    public _Order getOrder() throws DException;
86 }
87
Popular Tags