org.neo4j.kernel.impl.api.index.ValidatedIndexUpdates Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation

Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.

There is a newer version: 2025.02.0

Show newest version

/*
 * Copyright (c) 2002-2015 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.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 .
 */
package org.neo4j.kernel.impl.api.index;

import java.io.IOException;

import org.neo4j.kernel.api.exceptions.index.IndexCapacityExceededException;
import org.neo4j.kernel.api.index.IndexEntryConflictException;

/**
 * This class represents validated and prepared index updates that are ready to be flushed.
 * Flushing is performed with {@link ValidatedIndexUpdates#flush()} method.
 * Releasing of resources is performed with {@link ValidatedIndexUpdates#close()} method.
 * 
 * Notion of being 'prepared' indicates that index updates are placed in internal data structures and no
 * pre-processing before {@link ValidatedIndexUpdates#flush()} is needed. Such data structure might represent simply
 * a mapping 'Index -> [set of updates]'.
 * 
 * Notion of being 'validated' indicates that all updates in this batch can be consumed by corresponding indexes.
 * This mostly mean that index size permit new insertions {@see IndexCapacityExceededException}.
 */
public interface ValidatedIndexUpdates extends AutoCloseable
{
    ValidatedIndexUpdates NONE = new ValidatedIndexUpdates()
    {
        @Override
        public void flush()
        {
        }

        @Override
        public void close()
        {
        }

        @Override
        public boolean hasChanges()
        {
            return false;
        }
    };

    /**
     * @return whether or not there are any updates to be {@link #flush() flushed}.
     */
    boolean hasChanges();

    /**
     * Flush all validated and prepared index updates to corresponding indexes.
     */
    void flush() throws IOException, IndexEntryConflictException, IndexCapacityExceededException;

    /**
     * Release all possible resources used by this batch of index updates. Such resources might include
     * {@link org.neo4j.kernel.api.index.IndexUpdater} and {@link org.neo4j.kernel.api.index.Reservation}.
     */
    @Override
    void close();
}