KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > dbschema > ReferenceKey


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.dbschema;
21
22 /** Describes a reference key in a table.
23  */
24 public interface ReferenceKey extends ColumnPairElementHolder {
25     //================== Naming ===============================
26
27     /** Get the name of this element.
28      * @return the name
29      */
30     public String JavaDoc getKeyName();
31     
32     /** Set the name of this element.
33     * @param name the name
34     * @throws Exception if impossible
35     */
36     public void setKeyName (String JavaDoc name) throws Exception JavaDoc;
37
38
39     //================== Tables ===============================
40
41     /** Get the declaring table.
42      * @return the table that owns this reference key element, or
43      * <code>null</code> if the element is not attached to any table
44      */
45     public TableElement getDeclaringTable ();
46
47     /** Set the declaring table.
48     * @param te the table to set
49      */
50     public void setDeclaringTable (TableElement te);
51
52     /** Get the referenced table of the reference key.
53      * @return the referenced table
54      */
55     public TableElement getReferencedTable();
56
57
58     //================== Columns ===============================
59
60     // column convenience methods
61
62     /** Get all referenced columns in this reference key.
63      * @return the columns
64      */
65     public ColumnElement[] getReferencedColumns ();
66     
67     /** Get all local columns in this reference key.
68      * @return the columns
69      */
70     public ColumnElement[] getLocalColumns();
71
72     // end column convenience methods
73 }
74
Popular Tags