com.sop4j.dbutils.DeleteEntityExecutor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbutils Show documentation
A fork of Apache Commons-DbUtils.
The newest version!
/**
 *
 */
package com.sop4j.dbutils;

import java.sql.Connection;
import java.sql.SQLException;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * An EntityExecutor that is used to read entities.
 */
public class DeleteEntityExecutor extends AbstractEntityExecutor> {
    private static final Logger LOG = LoggerFactory.getLogger(DeleteEntityExecutor.class);

    private final Set excludeColumns;

    /**
     * Constructor.
     *
     * @param entity the entity to read.
     * @param conn the connection to use.
     */
    DeleteEntityExecutor(final Class entity, final Connection conn) {
        this(entity, conn, new HashSet());
    }

    /**
     * Constructor that excludes columns during binding.
     *
     * @param entity the entity to read.
     * @param conn the connection to use.
     */
    DeleteEntityExecutor(final Class entity, final Connection conn, final Set excludeColumns) {
        super(entity, conn);

        this.excludeColumns = excludeColumns;
    }

    /**
     * Reads the entity from the database.
     * @return the entity read from the database.
     * @throws SQLException thrown if any errors occur during reading.
     */
    public int delete() throws SQLException {
        final StringBuilder sb = new StringBuilder("delete from ");

        sb.append(tableName);

        if(!params.isEmpty()) {
            sb.append(" where ");

            sb.append(EntityUtils.joinColumnsEquals(params.keySet(), " and "));
        } else {
            throw new IllegalArgumentException("No parameters were bound, so this would delete the whole table.");
        }

        LOG.debug("DELETE: {}", sb.toString());

        // setup the QueryExecutor
        final UpdateExecutor exec = new UpdateExecutor(conn, sb.toString(), true);

        // go through and bind all the params
        for(Map.Entry entity:params.entrySet()) {

            if(excludeColumns.contains(entity.getKey())) {
                continue;
            }

            exec.bind(entity.getKey(), entity.getValue());
        }

        // execute using the BeanHandler
        return exec.execute();
    }
}