org.openadaptor.auxil.connector.jdbc.writer.map.AbstractMapWriter.java Source code

Introduction

Here is the source code for org.openadaptor.auxil.connector.jdbc.writer.map.AbstractMapWriter.java

Source

/*
 Copyright (C) 2001 - 2010 The Software Conservancy as Trustee. All rights reserved.
    
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in the
 Software without restriction, including without limitation the rights to use, copy,
 modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
 and to permit persons to whom the Software is furnished to do so, subject to the
 following conditions:
    
 The above copyright notice and this permission notice shall be included in all 
 copies or substantial portions of the Software.
    
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    
 Nothing in this notice shall be deemed to grant any rights to trademarks, copyrights,
 patents, trade secrets or any other intellectual property of the licensor or any
 contributor except as expressly stated herein. No patent license is granted separate
 from the Software, for code that you delete from the Software, or for combinations
 of the Software with other software or hardware.
*/

package org.openadaptor.auxil.connector.jdbc.writer.map;

import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openadaptor.auxil.connector.jdbc.writer.AbstractSQLWriter;

/**
 * Base class for writing Maps to JDBC databases
 * @author higginse
 * @since 3.2.2
 */
public abstract class AbstractMapWriter extends AbstractSQLWriter {
    private static final Log log = LogFactory.getLog(AbstractMapWriter.class);

    /**
     * Create prepared statement to write a batch of  maps.
     * @param data Object[] which should contain Map instances.
     * @return PreparedStatement ready for execution.
     * @throws RuntimeException if supplied array is null or does not contain Maps
     * @throws SQLException
     */
    protected final PreparedStatement createBatchStatement(Object[] data) throws SQLException {
        if (data == null) {
            throw new RuntimeException("Null data provided");
        }
        Map[] maps = new Map[data.length];
        for (int i = 0; i < maps.length; i++) {
            Object datum = data[i];
            if (!(datum instanceof Map)) {
                throw new RuntimeException("Batch element [" + i + "]. Expected Map. Got - " + data.getClass());
            }
            maps[i] = (Map) datum;
        }
        return createBatchStatement(maps);
    }

    /**
     * Create prepared statement to write a single ordered map.
     * @param datum - an Object which should contain an IOrderedMap instance
     * @return PreparedStatement ready for execution
     * @throws RuntimeException if supplied Object is null or does not contain IOrderedMaps
     * @throws SQLException
     */
    protected final PreparedStatement createStatement(Object datum) throws SQLException {
        if (datum == null) {
            throw new RuntimeException("Null data provided");
        }
        if (!(datum instanceof Map)) {
            throw new RuntimeException("Expected Map. Got - " + datum.getClass());
        }
        return createStatement((Map) datum);
    }

    /**
     * Create prepared statement to write a batch of ordered maps.
     * @param data Non-null IOrderedMap[]
     * @return PreparedStatement ready for execution.
     * @throws SQLException
     */
    protected abstract PreparedStatement createBatchStatement(Map[] data) throws SQLException;

    /**
     * Create prepared statement to write a single ordered map.
     * @param datum Non-null IOrderedMap instance
     * @return PreparedStatement ready for execution
     * @throws SQLException
     */
    protected abstract PreparedStatement createStatement(Map datum) throws SQLException;

    /**
     * Setup arguments for a prepared statement.
     * <br>
     * Note that it only requires the SQL type as setObject(x,null) cannot be used.
     * Seems silly, since the driver must be able to determine the type itself
     * for the null call.
     * @throws SQLException
     */
    protected static void setArguments(PreparedStatement ps, Map map, String[] colNames, int[] sqlTypes)
            throws SQLException {
        for (int i = 1; i <= colNames.length; i++) {
            Object value = map.get(colNames[i - 1]); //Loop isn't zero based
            if (value != null || (sqlTypes == null)) { //Worth a try if sqlTypes ain't available! 
                ps.setObject(i, value); //Don't need type here
            } else {
                ps.setNull(i, sqlTypes[i - 1]);
            }
            if (log.isDebugEnabled()) {
                log.debug("PreparedStatement arg [" + i + "] " + value);
            }
        }
    }

}