KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > db > sql > visualeditor > querymodel > QueryItem


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-2007 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19 package org.netbeans.modules.db.sql.visualeditor.querymodel;
20
21 import java.util.Collection JavaDoc;
22
23 // the comon base type of every item present in a query
24
// provides common functionalities to all items
25
public interface QueryItem {
26     // generate text that represent the item
27
public String JavaDoc genText();
28     // walks recursively the specific item to find all teh columns that are referenced from this item.
29
// For instance, called on a WHERE cluase will return all teh columns used in the expression of the WHERE clause
30
// could be used by the editor to obtain info on all teh column used in a particular clause
31
public void getReferencedColumns(Collection JavaDoc columns);
32     // fills the provided Collection with a list of all the items used in this specific item, but only one level
33
// So for instance on Query it would provide what the query is composed of (Select, From, Where, etc.)
34
// on Where it would provide the expression used
35
// on Column it would do nothing as that does not have any "nested" query item
36
public void getQueryItems(Collection JavaDoc items);
37 }
38
39
Popular Tags