/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* // Copyright (c) 1998, 2007, Oracle. All rights reserved.
*
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package oracle.toplink.essentials.internal.expressions;
import java.io.*;
import oracle.toplink.essentials.internal.helper.*;
import oracle.toplink.essentials.internal.sessions.DatabaseSessionImpl;
import oracle.toplink.essentials.expressions.*;
import oracle.toplink.essentials.internal.databaseaccess.DatabaseCall;
import oracle.toplink.essentials.internal.sessions.AbstractRecord;
import oracle.toplink.essentials.internal.sessions.AbstractSession;
/**
* <p><b>Purpose</b>: Mirror SQL behavior.
* <p><b>Responsibilities</b>:<ul>
* <li> Mirror SQL behavior.
* <li> Print as SQL string.
* </ul>
* @author Dorin Sandu
* @since TOPLink/Java 1.0
*/
public abstract class SQLStatement implements Serializable, Cloneable {
protected Expression whereClause;
protected ExpressionBuilder builder;
protected AbstractRecord translationRow;
/**
* Return SQL call for the statement, through generating the SQL string.
*/
public abstract DatabaseCall buildCall(AbstractSession session);
/**
* Clone the Statement
*/
public Object clone() {
try {
return super.clone();
} catch (CloneNotSupportedException e) {
throw new InternalError();
}
}
public ExpressionBuilder getBuilder() {
return builder;
}
public ExpressionBuilder getExpressionBuilder() {
return builder;
}
/**
* INTERNAL:
* Return the row for translation
*/
public AbstractRecord getTranslationRow() {
return translationRow;
}
public Expression getWhereClause() {
return whereClause;
}
protected void setBuilder(ExpressionBuilder aBuilder) {
builder = aBuilder;
}
/**
* INTERNAL:
* Set the row for translation
*/
public void setTranslationRow(AbstractRecord theRow) {
translationRow = theRow;
}
public void setWhereClause(Expression expression) {
whereClause = expression;
if (expression != null) {
builder = expression.getBuilder();
}
}
/**
* Try to print the SQL.
*/
public String toString() {
StringWriter writer = new StringWriter();
writer.write(Helper.getShortClassName(getClass()));
writer.write("(");
try {
DatabaseCall call = buildCall(new DatabaseSessionImpl(new oracle.toplink.essentials.sessions.DatabaseLogin()));
writer.write(call.getSQLString());
} catch (Exception exception) {
}
writer.write(")");
return writer.toString();
}
}