001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Florent Guillaume
018 */
019package org.nuxeo.ecm.core.storage.sql.jdbc;
020
021import java.io.Serializable;
022import java.sql.PreparedStatement;
023import java.sql.ResultSet;
024import java.sql.SQLException;
025import java.util.List;
026
027import org.nuxeo.ecm.core.storage.sql.Model;
028import org.nuxeo.ecm.core.storage.sql.RowMapper.RowUpdate;
029import org.nuxeo.ecm.core.storage.sql.jdbc.db.Column;
030
031/**
032 * Interface for a class that knows how to get a collection's value from a result set, and set a collection's values to
033 * a prepared statement (and execute it).
034 */
035public interface CollectionIO {
036
037    /**
038     * Gets one value from the current position of the result set.
039     */
040    Serializable getCurrentFromResultSet(ResultSet rs, List<Column> columns, Model model, Serializable[] returnId,
041            int[] returnPos) throws SQLException;
042
043    /**
044     * Sets the values of a fragment to a SQL prepared statement, and executes the statement for each value. Uses
045     * batching if possible.
046     */
047    void executeInserts(PreparedStatement ps, List<RowUpdate> rowus, List<Column> columns, boolean supportsBatchUpdates,
048            String sql, JDBCConnection connection) throws SQLException;
049
050}