01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.modules.sql.framework.model;
43:
44: import java.util.List;
45:
46: import org.w3c.dom.Element;
47:
48: import com.sun.sql.framework.exception.BaseException;
49:
50: /**
51: * @author Ritesh Adval
52: * @author Ahimanikya Satapathy
53: */
54: public interface SQLGroupBy {
55:
56: /**
57: * Gets the list of columns participating as group by clauses
58: *
59: * @return List of SourceColumn instances
60: */
61: public List getColumns();
62:
63: public SQLCondition getHavingCondition();
64:
65: public Object getParentObject();
66:
67: public boolean isValid();
68:
69: /**
70: * Parses the XML content, if any, represented by the given DOM element.
71: *
72: * @param groupByElement DOM element to be parsed for groupBy content
73: * @exception BaseException thrown while parsing XML, or if groupByElement is null
74: */
75: public void parseXML(Element groupByElement) throws BaseException;
76:
77: /**
78: * @see SQLGroupBy#removeExpression
79: */
80: public void removeColumn(SQLObject obj);
81:
82: public void setColumns(List newColumnList);
83:
84: public void setHavingCondition(SQLCondition having);
85:
86: public void setParentObject(Object obj);
87:
88: /**
89: * Generates XML document representing this object's content, using the given String
90: * as a prefix for each line.
91: *
92: * @param prefix String to be prepended to each line of the generated XML document
93: * @return String containing XML representation
94: */
95: public String toXMLString(String prefix) throws BaseException;
96: }
|