com.graphaware.tx.executor.batch.UnitOfWork Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2013-2020 GraphAware
 *
 * This file is part of the GraphAware Framework.
 *
 * GraphAware Framework is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of
 * the GNU General Public License along with this program.  If not, see
 * .
 */

package com.graphaware.tx.executor.batch;

import org.neo4j.graphdb.Transaction;

/**
 * A unit of work to be executed as a part of batch execution by {@link BatchTransactionExecutor}.
 *
 * @param  type of the input/parameter for the unit of work.
 */
public interface UnitOfWork {

    /**
     * Execute the unit of work.
     *
     * @param tx          in the context of which to execute the work.
     * @param input       to the unit of work.
     * @param batchNumber current batch number.
     * @param stepNumber  current step number.
     */
    void execute(Transaction tx, T input, int batchNumber, int stepNumber);
}