oracle.toplink.essentials.internal.parsing.OrderByNode Maven / Gradle / Ivy
The newest version!
/*
* 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, 2006, Oracle. All rights reserved.
package oracle.toplink.essentials.internal.parsing;
// Java imports
import java.util.*;
// TopLink Imports
import oracle.toplink.essentials.queryframework.ReadAllQuery;
import oracle.toplink.essentials.queryframework.ObjectLevelReadQuery;
/**
* INTERNAL
* Purpose: Represent an ORDER BY
*
Responsibilities:
* - Generate the correct expression for an ORDER BY
*
* @author Jon Driscoll
* @since TopLink 5.0
*/
public class OrderByNode extends MajorNode {
List orderByItems = null;
/**
* Return a new OrderByNode.
*/
public OrderByNode() {
super();
}
/**
* INTERNAL
* Add an Order By Item to this node
*/
private void addOrderByItem(Object theNode) {
getOrderByItems().add(theNode);
}
/**
* INTERNAL
* Add the ordering expressions to the passed query
*/
public void addOrderingToQuery(ObjectLevelReadQuery theQuery, GenerationContext context) {
if (theQuery.isReadAllQuery()) {
Iterator iter = getOrderByItems().iterator();
while (iter.hasNext()) {
Node nextNode = (Node)iter.next();
((ReadAllQuery)theQuery).addOrdering(nextNode.generateExpression(context));
}
}
}
/**
* INTERNAL
* Validate node.
*/
public void validate(ParseTreeContext context, SelectNode selectNode) {
for (Iterator i = orderByItems.iterator(); i.hasNext(); ) {
Node item = (Node)i.next();
item.validate(context);
}
}
/**
* INTERNAL
* Return the order by statements
*/
public List getOrderByItems() {
if (orderByItems == null) {
setOrderByItems(new Vector());
}
return orderByItems;
}
/**
* INTERNAL
* Set the order by statements
*/
public void setOrderByItems(List newItems) {
orderByItems = newItems;
}
}