/**
 * Licensed to JumpMind Inc under one or more contributor
 * license agreements.  See the NOTICE file distributed
 * with this work for additional information regarding
 * copyright ownership.  JumpMind Inc licenses this file
 * to you under the GNU General Public License, version 3.0 (GPLv3)
 * (the "License"); you may not use this file except in compliance
 * with the License.
 *
 * You should have received a copy of the GNU General Public License,
 * version 3.0 (GPLv3) along with this library; if not, see
 * <http://www.gnu.org/licenses/>.
 *
 * 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.
 */
package org.jumpmind.symmetric.io.data.writer;

import org.jumpmind.db.model.Table;
import org.jumpmind.extension.IExtensionPoint;
import org.jumpmind.symmetric.io.data.CsvData;
import org.jumpmind.symmetric.io.data.DataContext;

public interface IDatabaseWriterFilter extends IExtensionPoint {

    /**
     * Called before a DML statement will be executed against the database for
     * the data.
     * 
     * @return true if the row should be loaded. false if the filter has handled
     *         the row and it should be ignored.
     */
    public boolean beforeWrite(
            DataContext context, Table table, CsvData data);

    /**
     * Called right after a DML statement has been successfully executed against
     * the database for the data.
     */
    public void afterWrite(
            DataContext context, Table table, CsvData data);

    /**
     * Give the filter a chance to indicate that is can handle a table that is
     * missing. This might return true if the filter will be performing
     * transformations on the data and inserting the data itself.
     */
    public boolean handlesMissingTable(
            DataContext context, Table table);

    /**
     * If the {@link ParameterConstants#DATA_LOADER_MAX_ROWS_BEFORE_COMMIT}
     * property is set and the max number of rows is reached and a commit is
     * about to happen, then this method is called.
     */
    public void earlyCommit(
            DataContext context);

    /**
     * This method is called after a batch has been successfully processed. It
     * is called in the scope of the transaction that controls the batch commit.
     */
    public void batchComplete(
            DataContext context);

    /**
     * This method is called after the database transaction for the batch has
     * been committed.
     */
    public void batchCommitted(
            DataContext context);

    /**
     * This method is called after the database transaction for the batch has
     * been rolled back.
     */
    public void batchRolledback(
            DataContext context);

}