KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ws > jaxme > sqls > TableReference


1 /*
2  * Copyright 2003, 2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15
16  */
17 package org.apache.ws.jaxme.sqls;
18
19 /** <p>A table reference is used in the {@link Statement}.</p>
20  *
21  * @author <a HREF="mailto:joe@ispsoft.de">Jochen Wiedmann</a>
22  */
23 public interface TableReference {
24    /** <p>Returns the {@link Statement} that created the reference.</p>
25     */
26    public Statement getStatement();
27
28    /** <p>Returns the referenced {@link Table}.</p>
29     */
30    public Table getTable();
31
32    /** <p>Returns the references alias name. Null indicates that
33     * an arbitrary alias name may be choosen.</p>
34     */
35    public Table.Name getAlias();
36
37    /** <p>Sets the references alias name. Null indicates that
38     * an arbitrary alias name may be choosen.</p>
39     */
40    public void setAlias(Table.Name pName);
41
42    /** <p>Returns the references alias name. Null indicates that
43     * an arbitrary alias name may be choosen.</p>
44     */
45    public void setAlias(String JavaDoc pName);
46
47    /** <p>Returns a reference to the column named <code>pName</code>
48     * in the table.</p>
49     */
50    public ColumnReference newColumnReference(String JavaDoc pName);
51
52    /** <p>Returns a reference to the column named <code>pName</code>
53     * in the table.</p>
54     */
55    public ColumnReference newColumnReference(Column.Name pName);
56
57    /** <p>Returns a reference to the given column in the table.</p>
58     */
59    public ColumnReference newColumnReference(Column pColumn);
60 }
61
Popular Tags