oracle.toplink.essentials.internal.parsing.GroupByNode Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2007, Oracle. All rights reserved.
package oracle.toplink.essentials.internal.parsing;
// Java imports
import java.util.*;
// TopLink Imports
import oracle.toplink.essentials.exceptions.EJBQLException;
import oracle.toplink.essentials.queryframework.ReportQuery;
import oracle.toplink.essentials.queryframework.ObjectLevelReadQuery;
/**
* INTERNAL
* Purpose: Represent an GROUP BY
*
Responsibilities:
* - Generate the correct expression for an GROUP BY
*
*/
public class GroupByNode extends MajorNode {
List groupByItems = null;
/**
* Return a new GroupByNode.
*/
public GroupByNode() {
super();
}
/**
* INTERNAL
* Validate the current node.
*/
public void validate(ParseTreeContext context, SelectNode selectNode) {
for (Iterator i = groupByItems.iterator(); i.hasNext(); ) {
Node item = (Node)i.next();
item.validate(context);
}
List selectExprs = selectNode.getSelectExpressions();
// check select expressions
for (Iterator i = selectExprs.iterator(); i.hasNext(); ) {
Node selectExpr = (Node)i.next();
if (!isValidSelectExpr(selectExpr)) {
throw EJBQLException.invalidSelectForGroupByQuery(
context.getQueryInfo(),
selectExpr.getLine(), selectExpr.getColumn(),
selectExpr.getAsString(), getAsString());
}
}
}
/**
* INTERNAL
* Add an Group By Item to this node
*/
private void addGroupByItem(Object theNode) {
getGroupByItems().add(theNode);
}
/**
* INTERNAL
* Add the grouping expressions to the passed query
*/
public void addGroupingToQuery(ObjectLevelReadQuery theQuery, GenerationContext context) {
if (theQuery.isReportQuery()) {
Iterator iter = getGroupByItems().iterator();
while (iter.hasNext()) {
Node nextNode = (Node)iter.next();
((ReportQuery)theQuery).addGrouping(nextNode.generateExpression(context));
}
}
}
/**
* INTERNAL
* Returns true if the sp
*/
public boolean isValidHavingExpr(Node expr) {
if (expr.isDotNode() || expr.isVariableNode()) {
return isGroupbyItem(expr);
} else {
// delegate to child node if any
Node left = expr.getLeft();
Node right = expr.getRight();
return ((left == null) || isValidHavingExpr(left)) &&
((right == null) || isValidHavingExpr(right));
}
}
/**
* INTERNAL
* Returns true if the specified expr is a valid SELECT clause expression.
*/
private boolean isValidSelectExpr(Node expr) {
if (expr.isAggregateNode()) {
return true;
} else if (expr.isConstructorNode()) {
List args = ((ConstructorNode)expr).getConstructorItems();
for (Iterator i = args.iterator(); i.hasNext(); ) {
Node arg = (Node)i.next();
if (!isValidSelectExpr(arg)) {
return false;
}
}
return true;
}
return isGroupbyItem(expr);
}
/**
* INTERNAL
* Return true if the specified expr is a groupby item.
*/
private boolean isGroupbyItem(Node expr) {
if (expr.isDotNode() || expr.isVariableNode()) {
String exprRepr = expr.getAsString();
for (Iterator i = groupByItems.iterator(); i.hasNext();) {
Node item = (Node)i.next();
String itemRepr = item.getAsString();
if (exprRepr.equals(itemRepr)) {
return true;
}
}
}
return false;
}
/**
* INTERNAL
* Return the GROUP BY statements
*/
public List getGroupByItems() {
if (groupByItems == null) {
setGroupByItems(new Vector());
}
return groupByItems;
}
/**
* INTERNAL
* Set the GROUP BY statements
*/
public void setGroupByItems(List newItems) {
groupByItems = newItems;
}
/**
* INTERNAL
* Get the string representation of this node.
*/
public String getAsString() {
StringBuffer repr = new StringBuffer();
for (Iterator i = groupByItems.iterator(); i.hasNext(); ) {
Node expr = (Node)i.next();
if (repr.length() > 0) {
repr.append(", ");
}
repr.append(expr.getAsString());
}
return "GROUP BY " + repr.toString();
}
}