/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j 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 <http://www.gnu.org/licenses/>.
 */
package org.neo4j.kernel.impl.api.index;

import java.util.Map;
import org.neo4j.values.storable.Value;

/**
 * A consumer of a scan over entities generating a tuple of entity id, tokens and property map
 * for each scanned entity.
 */
public interface PropertyScanConsumer {
    Batch newBatch();

    interface Batch {
        /**
         * Adds a record to the batch.
         */
        void addRecord(long entityId, long[] tokens, Map<Integer, Value> properties);

        /**
         * Processes the batch.
         */
        void process();
    }
}
