Moves IndexWriter into .gbptree and renames to Writer

community/index/src/main/java/org/neo4j/index/gbptree/GBPTree.java

@@ -35,9 +35,6 @@
 import org.neo4j.collection.primitive.Primitive;
 import org.neo4j.collection.primitive.PrimitiveLongSet;
 import org.neo4j.cursor.RawCursor;
-import org.neo4j.index.IndexWriter;
-import org.neo4j.index.ValueMerger;
-import org.neo4j.index.ValueMergers;
 import org.neo4j.io.pagecache.CursorException;
 import org.neo4j.io.pagecache.IOLimiter;
 import org.neo4j.io.pagecache.PageCache;
@@ -72,7 +69,7 @@
  * while at the same time keeping one pointer to the stable version, in case there's a crash or non-clean
  * shutdown, followed by recovery.
  * <p>
- * Currently no leaves will be removed or merged as part of {@link IndexWriter#remove(Object) removals}.
+ * Currently no leaves will be removed or merged as part of {@link Writer#remove(Object) removals}.
  * <p>
  * A single writer w/ multiple concurrent readers is supported. Assuming usage adheres to this
  * constraint neither writer nor readers are blocking. Readers are virtually garbage-free.
@@ -186,9 +183,9 @@ default void checkpointCompleted()
     private final FreeListIdProvider freeList;
 
     /**
-     * A single instance {@link IndexWriter} because tree only supports single writer.
+     * A single instance {@link Writer} because tree only supports single writer.
      */
-    private final SingleIndexWriter writer;
+    private final SingleWriter writer;
 
     /**
      * Check-pointing flushes updates to stable storage.
@@ -284,7 +281,7 @@ public GBPTree( PageCache pageCache, File indexFile, Layout<KEY,VALUE> layout, i
         this.pagedFile = openOrCreate( pageCache, indexFile, tentativePageSize, layout );
         this.bTreeNode = new TreeNode<>( pageSize, layout );
         this.freeList = new FreeListIdProvider( pagedFile, pageSize, rootId, FreeListIdProvider.NO_MONITOR );
-        this.writer = new SingleIndexWriter( new InternalTreeLogic<>( freeList, bTreeNode, layout ) );
+        this.writer = new SingleWriter( new InternalTreeLogic<>( freeList, bTreeNode, layout ) );
 
         try
         {
@@ -616,16 +613,16 @@ public void close() throws IOException
     }
 
     /**
-     * Returns a {@link IndexWriter} able to modify the index, i.e. insert and remove keys/values.
+     * Returns a {@link Writer} able to modify the index, i.e. insert and remove keys/values.
      * After usage the returned writer must be closed, typically by using try-with-resource clause.
      *
-     * @return the single {@link IndexWriter} for this index. The returned writer must be
-     * {@link IndexWriter#close() closed} before another caller can acquire this writer.
+     * @return the single {@link Writer} for this index. The returned writer must be
+     * {@link Writer#close() closed} before another caller can acquire this writer.
      * @throws IOException on error accessing the index.
      * @throws IllegalStateException for calls made between a successful call to this method and closing the
      * returned writer.
      */
-    public IndexWriter<KEY,VALUE> writer() throws IOException
+    public Writer<KEY,VALUE> writer() throws IOException
     {
         if ( !writerTaken.compareAndSet( false, true ) )
         {
@@ -728,7 +725,7 @@ public String toString()
                 stableGeneration( generation ), unstableGeneration( generation ) );
     }
 
-    private class SingleIndexWriter implements IndexWriter<KEY,VALUE>
+    private class SingleWriter implements Writer<KEY,VALUE>
     {
         private final InternalTreeLogic<KEY,VALUE> treeLogic;
         private final StructurePropagation<KEY> structurePropagation;
@@ -739,7 +736,7 @@ private class SingleIndexWriter implements IndexWriter<KEY,VALUE>
         private long stableGeneration;
         private long unstableGeneration;
 
-        SingleIndexWriter( InternalTreeLogic<KEY,VALUE> treeLogic )
+        SingleWriter( InternalTreeLogic<KEY,VALUE> treeLogic )
         {
             this.structurePropagation = new StructurePropagation<>( layout.newKey() );
             this.treeLogic = treeLogic;

community/index/src/main/java/org/neo4j/index/gbptree/InternalTreeLogic.java

@@ -23,7 +23,6 @@
 import java.util.Arrays;
 import java.util.Comparator;
 
-import org.neo4j.index.ValueMerger;
 import org.neo4j.io.pagecache.PageCursor;
 
 import static org.neo4j.index.gbptree.KeySearch.isHit;

community/index/src/main/java/org/neo4j/index/ValueMerger.java → community/index/src/main/java/org/neo4j/index/gbptree/ValueMerger.java

@@ -17,7 +17,7 @@
  * 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.index;
+package org.neo4j.index.gbptree;
 
 /**
  * Decides what to do when inserting key which already exists in index. Different implementations of

community/index/src/main/java/org/neo4j/index/ValueMergers.java → community/index/src/main/java/org/neo4j/index/gbptree/ValueMergers.java

@@ -17,7 +17,7 @@
  * 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.index;
+package org.neo4j.index.gbptree;
 
 /**
  * Common {@link ValueMerger} implementations.

community/index/src/main/java/org/neo4j/index/IndexWriter.java → community/index/src/main/java/org/neo4j/index/gbptree/Writer.java

@@ -17,7 +17,7 @@
  * 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.index;
+package org.neo4j.index.gbptree;
 
 import java.io.Closeable;
 import java.io.IOException;
@@ -30,7 +30,7 @@
  * @param <KEY> type of keys
  * @param <VALUE> type of values
  */
-public interface IndexWriter<KEY,VALUE> extends Closeable
+public interface Writer<KEY,VALUE> extends Closeable
 {
     /**
      * Associate given {@code key} with given {@code value}.

community/index/src/test/java/org/neo4j/index/gbptree/ConsistencyCheckerTest.java

@@ -23,7 +23,6 @@
 import org.junit.Test;
 
 import org.neo4j.collection.primitive.PrimitiveLongCollections;
-import org.neo4j.index.ValueMergers;
 import org.neo4j.io.pagecache.CursorException;
 import org.neo4j.io.pagecache.PageCursor;
 

community/index/src/test/java/org/neo4j/index/gbptree/GBPTreeIT.java

@@ -40,7 +40,6 @@
 import java.util.concurrent.atomic.AtomicReference;
 
 import org.neo4j.cursor.RawCursor;
-import org.neo4j.index.IndexWriter;
 import org.neo4j.io.pagecache.IOLimiter;
 import org.neo4j.io.pagecache.PageCache;
 import org.neo4j.test.rule.PageCacheRule;
@@ -110,7 +109,7 @@ public void shouldStayCorrectAfterRandomModifications() throws Exception
         }
 
         // WHEN
-        try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+        try ( Writer<MutableLong,MutableLong> writer = index.writer() )
         {
             for ( Map.Entry<MutableLong,MutableLong> entry : data.entrySet() )
             {
@@ -274,7 +273,7 @@ public void shouldReadCorrectlyWhenConcurrentlyInsertingInOrder() throws Throwab
             int inserted = 0;
             while ( (inserted < 100_000 || numberOfReads.get() < 10_000) && !failHalt.get() )
             {
-                try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+                try ( Writer<MutableLong,MutableLong> writer = index.writer() )
                 {
                     int groupCount = random1.nextInt( 1000 ) + 1;
                     for ( int i = 0; i < groupCount; i++, inserted++ )
@@ -354,7 +353,7 @@ public void shouldReadCorrectlyWhenConcurrentlyInsertingOutOfOrder() throws Thro
             int iteration = currentWriteIteration.get();
             while ( !failHalt.get() && numberOfReads.get() < wantedNbrOfReads )
             {
-                try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+                try ( Writer<MutableLong,MutableLong> writer = index.writer() )
                 {
                     for ( long i = minRange( nbrOfGroups, rangeWidth, iteration ) + iteration % nbrOfGroups;
                           i < maxRange( nbrOfGroups, rangeWidth, iteration ); i += nbrOfGroups )
@@ -443,7 +442,7 @@ public void shouldReadCorrectlyWhenConcurrentlyInsertingOutOfOrderAndSeekingBack
             while ( !failHalt.get() &&
                     (numberOfReads.get() < wantedNbrOfReads || iteration < nbrOfLeastWantedIterations) )
             {
-                try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+                try ( Writer<MutableLong,MutableLong> writer = index.writer() )
                 {
                     for ( long i = maxRange( nbrOfGroups, rangeWidth, iteration ) - iteration % nbrOfGroups;
                           i > minRange( nbrOfGroups, rangeWidth, iteration ); i -= nbrOfGroups )
@@ -531,7 +530,7 @@ public void shouldReadCorrectlyWhenConcurrentlyRemovingOutOfOrder() throws Throw
             int iteration = currentWriteIteration.get();
             while ( !failHalt.get() && lastRemovedKey.get() < maxValue - 2)
             {
-                try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+                try ( Writer<MutableLong,MutableLong> writer = index.writer() )
                 {
                     int minRange = minRange( nbrOfGroups, rangeWidth, iteration );
                     int maxRange = maxRange( nbrOfGroups, rangeWidth, iteration );
@@ -620,7 +619,7 @@ public void shouldReadCorrectlyWhenConcurrentlyRemovingOutOfOrderBackwards() thr
             int iteration = currentWriteIteration.get();
             while ( !failHalt.get() && lastRemovedKey.get() < maxValue + 1)
             {
-                try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+                try ( Writer<MutableLong,MutableLong> writer = index.writer() )
                 {
                     int minRange = minRange( nbrOfGroups, rangeWidth, iteration );
                     int maxRange = maxRange( nbrOfGroups, rangeWidth, iteration );
@@ -662,7 +661,7 @@ private void insertEverythingInRange( GBPTree<MutableLong,MutableLong> index, lo
         MutableLong key = new MutableLong();
         MutableLong value = new MutableLong();
 
-        try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+        try ( Writer<MutableLong,MutableLong> writer = index.writer() )
         {
             while ( nextToInsert < maxValue )
             {
@@ -710,7 +709,7 @@ private static void randomlyModifyIndex( GBPTree<MutableLong,MutableLong> index,
             Map<MutableLong,MutableLong> data, Random random ) throws IOException
     {
         int changeCount = random.nextInt( 10 ) + 10;
-        try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+        try ( Writer<MutableLong,MutableLong> writer = index.writer() )
         {
             for ( int i = 0; i < changeCount; i++ )
             {

community/index/src/test/java/org/neo4j/index/gbptree/GBPTreeRecoveryTest.java

@@ -33,7 +33,6 @@
 import java.util.stream.Collectors;
 
 import org.neo4j.cursor.RawCursor;
-import org.neo4j.index.IndexWriter;
 import org.neo4j.io.pagecache.PageCache;
 import org.neo4j.test.rule.PageCacheRule;
 import org.neo4j.test.rule.RandomRule;
@@ -76,7 +75,7 @@ public void shouldRecoverFromCrashBeforeFirstCheckpoint() throws Exception
         {
             PageCache pageCache = createPageCache();
             GBPTree<MutableLong,MutableLong> index = createIndex( pageCache, file );
-            IndexWriter<MutableLong,MutableLong> writer = index.writer();
+            Writer<MutableLong,MutableLong> writer = index.writer();
 
             key.setValue( 1L );
             value.setValue( 10L );
@@ -97,7 +96,7 @@ public void shouldRecoverFromCrashBeforeFirstCheckpoint() throws Exception
             // this is the mimic:ed recovery
             index.prepareForRecovery();
 
-            try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+            try ( Writer<MutableLong,MutableLong> writer = index.writer() )
             {
                 writer.put( key, value );
             }
@@ -428,7 +427,7 @@ class InsertAction extends RecoverableAction
         @Override
         public void execute( GBPTree<MutableLong,MutableLong> index ) throws IOException
         {
-            try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+            try ( Writer<MutableLong,MutableLong> writer = index.writer() )
             {
                 for ( int i = 0; i < data.length; )
                 {
@@ -450,7 +449,7 @@ class RemoveAction extends RecoverableAction
         @Override
         public void execute( GBPTree<MutableLong,MutableLong> index ) throws IOException
         {
-            try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+            try ( Writer<MutableLong,MutableLong> writer = index.writer() )
             {
                 for ( int i = 0; i < data.length; )
                 {

community/index/src/test/java/org/neo4j/index/gbptree/GBPTreeTest.java

@@ -36,7 +36,6 @@
 import org.neo4j.collection.primitive.PrimitiveLongCollections;
 import org.neo4j.collection.primitive.PrimitiveLongSet;
 import org.neo4j.cursor.RawCursor;
-import org.neo4j.index.IndexWriter;
 import org.neo4j.index.gbptree.GBPTree.Monitor;
 import org.neo4j.io.pagecache.IOLimiter;
 import org.neo4j.io.pagecache.PageCache;
@@ -330,7 +329,7 @@ public void shouldRemapFileIfMappedWithPageSizeLargerThanCreationSize() throws E
                 new GBPTree<>( pageCache, indexFile, layout, pageSize / 2, NO_MONITOR ) )
         {
             // Insert some data
-            try ( IndexWriter<MutableLong, MutableLong> writer = index.writer() )
+            try ( Writer<MutableLong, MutableLong> writer = index.writer() )
             {
                 MutableLong key = new MutableLong();
                 MutableLong value = new MutableLong();
@@ -406,7 +405,7 @@ public void shouldNotBeAbleToAcquireModifierTwice() throws Exception
     {
         // GIVEN
         index = createIndex( 256 );
-        IndexWriter<MutableLong,MutableLong> writer = index.writer();
+        Writer<MutableLong,MutableLong> writer = index.writer();
 
         // WHEN
         try
@@ -423,11 +422,11 @@ public void shouldNotBeAbleToAcquireModifierTwice() throws Exception
     }
 
     @Test
-    public void shouldAllowClosingIndexWriterMultipleTimes() throws Exception
+    public void shouldAllowClosingWriterMultipleTimes() throws Exception
     {
         // GIVEN
         index = createIndex( 256 );
-        IndexWriter<MutableLong,MutableLong> writer = index.writer();
+        Writer<MutableLong,MutableLong> writer = index.writer();
         writer.put( new MutableLong( 0 ), new MutableLong( 1 ) );
         writer.close();
 
@@ -446,7 +445,7 @@ public void checkPointShouldLockOutWriter() throws Exception
         CheckpointControlledMonitor monitor = new CheckpointControlledMonitor();
         index = createIndex( 1024, monitor );
         long key = 10;
-        try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+        try ( Writer<MutableLong,MutableLong> writer = index.writer() )
         {
             writer.put( new MutableLong( key ), new MutableLong( key ) );
         }
@@ -477,7 +476,7 @@ public void checkPointShouldWaitForWriter() throws Exception
         Barrier.Control barrier = new Barrier.Control();
         Thread writerThread = new Thread( throwing( () ->
         {
-            try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+            try ( Writer<MutableLong,MutableLong> writer = index.writer() )
             {
                 writer.put( new MutableLong( 1 ), new MutableLong( 1 ) );
                 barrier.reached();
@@ -502,7 +501,7 @@ public void shouldSeeSimpleInsertions() throws Exception
     {
         index = createIndex( 256 );
         int count = 1000;
-        try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+        try ( Writer<MutableLong,MutableLong> writer = index.writer() )
         {
             for ( int i = 0; i < count; i++ )
             {
@@ -533,7 +532,7 @@ public void shouldSplitCorrectly() throws Exception
         // WHEN
         int count = 1_000;
         PrimitiveLongSet seen = Primitive.longSet( count );
-        try ( IndexWriter<MutableLong,MutableLong> writer = index.writer() )
+        try ( Writer<MutableLong,MutableLong> writer = index.writer() )
         {
             for ( int i = 0; i < count; i++ )
             {

community/index/src/test/java/org/neo4j/index/gbptree/InternalTreeLogicTest.java

@@ -31,8 +31,6 @@
 import java.util.Collection;
 import java.util.List;
 
-import org.neo4j.index.ValueMerger;
-import org.neo4j.index.ValueMergers;
 import org.neo4j.io.pagecache.PageCursor;
 import org.neo4j.test.rule.RandomRule;
 import static org.hamcrest.CoreMatchers.is;
@@ -43,9 +41,10 @@
 import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assume.assumeTrue;
-import static org.neo4j.index.ValueMergers.overwrite;
+
 import static org.neo4j.index.gbptree.ConsistencyChecker.assertNoCrashOrBrokenPointerInGSPP;
 import static org.neo4j.index.gbptree.GenSafePointerPair.pointer;
+import static org.neo4j.index.gbptree.ValueMergers.overwrite;
 
 @RunWith( Parameterized.class )
 public class InternalTreeLogicTest

community/index/src/test/java/org/neo4j/index/gbptree/SeekCursorTest.java

@@ -42,8 +42,8 @@
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 
-import static org.neo4j.index.ValueMergers.overwrite;
 import static org.neo4j.index.gbptree.GenSafePointerPair.pointer;
+import static org.neo4j.index.gbptree.ValueMergers.overwrite;
 
 public class SeekCursorTest
 {