KickJava   Java API By Example, From Geeks To Geeks.

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


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 an object which holds a list of columns.
23  */
24 public interface ColumnElementHolder {
25     /** Add a new column to the holder.
26      * @param el the column to add
27      * @throws Exception if impossible
28      */
29     public void addColumn (ColumnElement el) throws Exception JavaDoc;
30
31     /** Add some new columns to the holder.
32      * @param els the columns to add
33      * @throws Exception if impossible
34      */
35     public void addColumns (ColumnElement[] els) throws Exception JavaDoc;
36
37     /** Remove a column from the holder.
38      * @param el the column to remove
39      * @throws Exception if impossible
40      */
41     public void removeColumn (ColumnElement el) throws Exception JavaDoc;
42
43     /** Remove some columns from the holder.
44      * @param els the columns to remove
45      * @throws Exception if impossible
46      */
47     public void removeColumns (ColumnElement[] els) throws Exception JavaDoc;
48
49     /** Set the columns for this holder.
50      * Previous columns are removed.
51      * @param els the new columns
52      * @throws Exception if impossible
53      */
54     public void setColumns (ColumnElement[] els) throws Exception JavaDoc;
55
56     /** Get all columns in this holder.
57      * @return the columns
58      */
59     public ColumnElement[] getColumns ();
60
61     /** Find a column by name.
62      * @param name the name of the column for which to look
63      * @return the element or <code>null</code> if not found
64      */
65     public ColumnElement getColumn (DBIdentifier name);
66 }
67
Popular Tags