oracle.toplink.essentials.internal.databaseaccess.OutputParameterForCallableStatement Maven / Gradle / Ivy
/*
* 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.databaseaccess;
import java.sql.*;
import oracle.toplink.essentials.internal.helper.*;
import oracle.toplink.essentials.internal.sessions.AbstractSession;
public class OutputParameterForCallableStatement extends BindCallCustomParameter {
// this attribute is provided by the caller
protected boolean isCursor;
// these attributes are generated by prepare method
protected int jdbcType;
protected String typeName;
protected boolean isTypeNameRequired;
public OutputParameterForCallableStatement(DatabaseField field) {
super(field);
}
public OutputParameterForCallableStatement(DatabaseField field, DatabasePlatform platform) {
this(field, platform, false);
}
public OutputParameterForCallableStatement(DatabaseField field, DatabasePlatform platform, boolean isCursor) {
this(field);
this.isCursor = isCursor;
prepare(platform);
}
public OutputParameterForCallableStatement(OutputParameterForCallableStatement outParameter) {
super(outParameter.obj);
this.isCursor = outParameter.isCursor;
this.jdbcType = outParameter.jdbcType;
this.typeName = outParameter.typeName;
this.isTypeNameRequired = outParameter.isTypeNameRequired;
}
protected OutputParameterForCallableStatement() {
}
public void setIsCursor(boolean isCursor) {
this.isCursor = isCursor;
}
// make sure to call prepare() method after this
public boolean isCursor() {
return isCursor;
}
public boolean isTypeNameRequired() {
return isTypeNameRequired;
}
public int getJdbcType() {
return jdbcType;
}
public String getTypeName() {
return typeName;
}
public DatabaseField getOutputField() {
return (DatabaseField)obj;
}
public void prepare(DatabasePlatform platform) {
if (isCursor()) {
jdbcType = platform.getCursorCode();// Oracle code for cursors
} else {
jdbcType = platform.getJDBCType(getOutputField());
isTypeNameRequired = platform.requiresTypeNameToRegisterOutputParameter();
if (isTypeNameRequired) {
typeName = platform.getJdbcTypeName(jdbcType);
}
}
}
public void set(DatabasePlatform platform, PreparedStatement statement, int index, AbstractSession session) throws SQLException {
if (isTypeNameRequired) {
((CallableStatement)statement).registerOutParameter(index, jdbcType, typeName);
} else {
((CallableStatement)statement).registerOutParameter(index, jdbcType);
}
}
public String toString() {
return "=> " + getOutputField().getName();
}
}