oracle.toplink.essentials.internal.parsing.LiteralNode 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;
import oracle.toplink.essentials.queryframework.ObjectLevelReadQuery;
import oracle.toplink.essentials.queryframework.ReportQuery;
import oracle.toplink.essentials.expressions.*;
import oracle.toplink.essentials.internal.expressions.*;
/**
* INTERNAL
* Purpose: Superclass for literals (String, Integer, Float, Character, ...)
*
Responsibilities:
* - Maintain the literal being represented
*
- Print to a string
*
- Answer if the node is completely built
*
* @author Jon Driscoll and Joel Lucuik
* @since TopLink 4.0
*/
public class LiteralNode extends Node {
public java.lang.Object literal;
/**
* Return a new LiteralNode.
*/
public LiteralNode() {
super();
}
/**
* INTERNAL
* Apply this node to the passed query
*/
public void applyToQuery(ObjectLevelReadQuery theQuery, GenerationContext context) {
if (theQuery.isReportQuery()) {
ReportQuery reportQuery = (ReportQuery)theQuery;
reportQuery.addAttribute("CONSTANT", generateExpression(context));
}
}
/**
* INTERNAL
* Generate the a new TopLink ConstantExpression for this node.
*/
public Expression generateExpression(GenerationContext context) {
Expression whereClause = new ConstantExpression(getLiteral(), new ExpressionBuilder());
return whereClause;
}
/**
* INTERNAL
* Return the literal
*/
public String getAsString() {
return getLiteral().toString();
}
/**
* Insert the method's description here.
* Creation date: (12/21/00 10:51:48 AM)
* @return java.lang.Object
*/
public java.lang.Object getLiteral() {
return literal;
}
/**
* INTERNAL
* Is this a literal node
*/
public boolean isLiteralNode() {
return true;
}
/**
* Insert the method's description here.
* Creation date: (12/21/00 10:51:48 AM)
* @param newLiteral java.lang.Object
*/
public void setLiteral(java.lang.Object newLiteral) {
literal = newLiteral;
}
public String toString(int indent) {
StringBuffer buffer = new StringBuffer();
toStringIndent(indent, buffer);
buffer.append(toStringDisplayName() + "[" + getLiteral() + "]");
return buffer.toString();
}
}