org.efaps.db.wrapper.SQLInsert Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation
Show all versions of efaps-kernel Show documentation
eFaps is a framework used to map objects with or without attached files to
a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface.
The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.
/*
* Copyright 2003 - 2011 The eFaps Team
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Revision: $Rev: 6210 $
* Last Changed: $Date: 2011-02-18 16:02:56 -0500 (Fri, 18 Feb 2011) $
* Last Changed By: $Author: [email protected] $
*/
package org.efaps.db.wrapper;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import org.efaps.db.Context;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An easy wrapper for a SQL update statement. To initialize this class use
* {@link org.efaps.db.databases.AbstractDatabase#newInsert(String, String, boolean)}
* to get a database specific insert.
*
* Example:
*
* SQLInsert insert = Context.getDbType().newInsert("MYTABLE", "ID", true);
*
*
* @see org.efaps.db.databases.AbstractDatabase#newInsert(String, String, boolean)
* @author The eFaps Team
* @version $Id: SQLInsert.java 6210 2011-02-18 21:02:56Z [email protected] $
*/
public class SQLInsert
extends AbstractSQLInsertUpdate
{
/**
* Logging instance used in this class.
*/
private static final Logger LOG = LoggerFactory.getLogger(SQLInsert.class);
/**
* Must a new id created within this insert?
*/
private final boolean newId;
/**
* Initializes the insert. Do not call the constructor directly, instead
* use
* {@link org.efaps.db.databases.AbstractDatabase#newInsert(String, String, boolean)}
* to get the database specific implementation.
*
* @param _tableName name of the table to insert
* @param _idCol column holding the id
* @param _newId true if a new id must be created; otherwise
* false
*/
public SQLInsert(final String _tableName,
final String _idCol,
final boolean _newId)
{
super(_tableName, _idCol);
this.newId = _newId;
}
/**
* Executes the SQL insert.
*
* @param _con SQL connection
* @return if a new id must be created (defined in {@link #newId}) this new
* generated id is returned
* @throws SQLException if insert failed
*/
public Long execute(final Connection _con)
throws SQLException
{
final boolean supGenKey = Context.getDbType().supportsGetGeneratedKeys();
Long ret = null;
if (this.newId && !supGenKey) {
ret = Context.getDbType().getNewId(_con, getTableName(), getIdColumn());
this.column(getIdColumn(), ret);
}
final StringBuilder cmd = new StringBuilder()
.append(Context.getDbType().getSQLPart(SQLPart.INSERT))
.append(" ")
.append(Context.getDbType().getSQLPart(SQLPart.INTO))
.append(" ")
.append(Context.getDbType().getTableQuote())
.append(getTableName())
.append(Context.getDbType().getTableQuote())
.append(" ")
.append(Context.getDbType().getSQLPart(SQLPart.PARENTHESIS_OPEN));
final StringBuilder val = new StringBuilder();
// append SQL values
boolean first = true;
for (final ColumnWithSQLValue col : getColumnWithSQLValues()) {
if (first) {
first = false;
} else {
cmd.append(Context.getDbType().getSQLPart(SQLPart.COMMA));
val.append(Context.getDbType().getSQLPart(SQLPart.COMMA));
}
cmd.append(Context.getDbType().getColumnQuote())
.append(col.getColumnName())
.append(Context.getDbType().getColumnQuote());
val.append(col.getSqlValue());
}
// append values
for (final AbstractColumnWithValue col : getColumnWithValues()) {
if (first) {
first = false;
} else {
cmd.append(Context.getDbType().getSQLPart(SQLPart.COMMA));
val.append(Context.getDbType().getSQLPart(SQLPart.COMMA));
}
cmd.append(Context.getDbType().getColumnQuote())
.append(col.getColumnName())
.append(Context.getDbType().getColumnQuote());
val.append('?');
}
cmd.append(Context.getDbType().getSQLPart(SQLPart.PARENTHESIS_CLOSE))
.append(Context.getDbType().getSQLPart(SQLPart.VALUES))
.append(Context.getDbType().getSQLPart(SQLPart.PARENTHESIS_OPEN))
.append(val)
.append(Context.getDbType().getSQLPart(SQLPart.PARENTHESIS_CLOSE));
if (SQLInsert.LOG.isDebugEnabled()) {
SQLInsert.LOG.debug(cmd.toString());
}
PreparedStatement stmt;
if (this.newId && supGenKey) {
if (Context.getDbType().supportsMultiGeneratedKeys()) {
stmt = _con.prepareStatement(cmd.toString(), new String[]{getIdColumn()});
} else {
stmt = _con.prepareStatement(cmd.toString(), Statement.RETURN_GENERATED_KEYS);
}
} else {
stmt = _con.prepareStatement(cmd.toString());
}
int index = 1;
for (final AbstractColumnWithValue col : getColumnWithValues()) {
if (SQLInsert.LOG.isDebugEnabled()) {
SQLInsert.LOG.debug(" " + index + " = " + col.getValue());
}
col.set(index++, stmt);
}
try {
final int rows = stmt.executeUpdate();
if (rows == 0) {
throw new SQLException("Object for SQL table '" + getTableName()
+ "' does not exists and was not inserted.");
}
// if auto generated get new id
if (this.newId && supGenKey) {
final ResultSet resultset = stmt.getGeneratedKeys();
if (resultset.next()) {
ret = resultset.getLong(1);
}
resultset.close();
}
} finally {
stmt.close();
}
if (this.newId && SQLInsert.LOG.isDebugEnabled()) {
SQLInsert.LOG.debug("new generated id " + ret);
}
return ret;
}
}