Merge pull request #142 from jakewins/1.0-summarize

Polish from user testing for summary

Author: pontusmelke

driver/src/main/java/org/neo4j/driver/internal/InternalStatementResult.java

@@ -38,7 +38,7 @@
 import org.neo4j.driver.v1.summary.ProfiledPlan;
 import org.neo4j.driver.v1.summary.ResultSummary;
 import org.neo4j.driver.v1.summary.StatementType;
-import org.neo4j.driver.v1.summary.UpdateStatistics;
+import org.neo4j.driver.v1.summary.SummaryCounters;
 import org.neo4j.driver.v1.util.Function;
 import org.neo4j.driver.v1.util.Functions;
 
@@ -83,7 +83,7 @@ public void record( Value[] fields ) {}
             public void statementType( StatementType type ) {}
 
             @Override
-            public void statementStatistics( UpdateStatistics statistics ) {}
+            public void statementStatistics( SummaryCounters statistics ) {}
 
             @Override
             public void plan( Plan plan ) {}
@@ -126,7 +126,7 @@ public void statementType( StatementType type )
             }
 
             @Override
-            public void statementStatistics( UpdateStatistics statistics )
+            public void statementStatistics( SummaryCounters statistics )
             {
                 summaryBuilder.statementStatistics( statistics );
             }
@@ -288,7 +288,7 @@ else if ( position == -1 && hasNext() )
             }
             while ( hasNext() );
 
-            discard();
+            consume();
             return result;
         }
         else
@@ -301,24 +301,11 @@ else if ( position == -1 && hasNext() )
 
     @SuppressWarnings("StatementWithEmptyBody")
     @Override
-    public ResultSummary summarize()
-    {
-        discard();
-        return summary;
-    }
-
-    @Override
-    public void remove()
-    {
-        throw new ClientException( "Removing records from a result is not supported." );
-    }
-
-    @Override
-    public void discard()
+    public ResultSummary consume()
     {
         if(!open)
         {
-            return;
+            return summary;
         }
 
         while ( !done )
@@ -327,6 +314,13 @@ public void discard()
         }
         recordBuffer.clear();
         open = false;
+        return summary;
+    }
+
+    @Override
+    public void remove()
+    {
+        throw new ClientException( "Removing records from a result is not supported." );
     }
 
     private void assertOpen()

driver/src/main/java/org/neo4j/driver/internal/connector/socket/SocketResponseHandler.java

@@ -27,7 +27,7 @@
 import org.neo4j.driver.internal.summary.InternalNotification;
 import org.neo4j.driver.internal.summary.InternalPlan;
 import org.neo4j.driver.internal.summary.InternalProfiledPlan;
-import org.neo4j.driver.internal.summary.InternalUpdateStatistics;
+import org.neo4j.driver.internal.summary.InternalSummaryCounters;
 import org.neo4j.driver.v1.Value;
 import org.neo4j.driver.v1.exceptions.ClientException;
 import org.neo4j.driver.v1.exceptions.DatabaseException;
@@ -146,7 +146,7 @@ private void collectStatistics( StreamCollector collector, Value stats )
         if ( stats != null )
         {
             collector.statementStatistics(
-                    new InternalUpdateStatistics(
+                    new InternalSummaryCounters(
                             statsValue( stats, "nodes-created" ),
                             statsValue( stats, "nodes-deleted" ),
                             statsValue( stats, "relationships-created" ),

driver/src/main/java/org/neo4j/driver/internal/spi/StreamCollector.java

@@ -24,7 +24,7 @@
 import org.neo4j.driver.v1.summary.Plan;
 import org.neo4j.driver.v1.summary.ProfiledPlan;
 import org.neo4j.driver.v1.summary.StatementType;
-import org.neo4j.driver.v1.summary.UpdateStatistics;
+import org.neo4j.driver.v1.summary.SummaryCounters;
 import org.neo4j.driver.v1.Value;
 
 public interface StreamCollector
@@ -41,7 +41,7 @@ public void record( Value[] fields ) {}
         public void statementType( StatementType type ) {}
 
         @Override
-        public void statementStatistics( UpdateStatistics statistics ) {}
+        public void statementStatistics( SummaryCounters statistics ) {}
 
         @Override
         public void plan( Plan plan ) {}
@@ -64,7 +64,7 @@ public void done() {}
 
     void statementType( StatementType type);
 
-    void statementStatistics( UpdateStatistics statistics );
+    void statementStatistics( SummaryCounters statistics );
 
     void plan( Plan plan );
 

driver/src/main/java/org/neo4j/driver/internal/summary/InternalUpdateStatistics.java renamed to driver/src/main/java/org/neo4j/driver/internal/summary/InternalSummaryCounters.java

@@ -18,12 +18,12 @@
  */
 package org.neo4j.driver.internal.summary;
 
-import org.neo4j.driver.v1.summary.UpdateStatistics;
+import org.neo4j.driver.v1.summary.SummaryCounters;
 
-public class InternalUpdateStatistics implements UpdateStatistics
+public class InternalSummaryCounters implements SummaryCounters
 {
-    public static final InternalUpdateStatistics EMPTY_STATS =
-            new InternalUpdateStatistics( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 );
+    public static final InternalSummaryCounters EMPTY_STATS =
+            new InternalSummaryCounters( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 );
     private final int nodesCreated;
     private final int nodesDeleted;
     private final int relationshipsCreated;
@@ -36,7 +36,7 @@ public class InternalUpdateStatistics implements UpdateStatistics
     private final int constraintsAdded;
     private final int constrainsRemoved;
 
-    public InternalUpdateStatistics(
+    public InternalSummaryCounters(
             int nodesCreated, int nodesDeleted,
             int relationshipsCreated, int relationshipsDeleted,
             int propertiesSet,
@@ -152,7 +152,7 @@ public boolean equals( Object o )
             return false;
         }
 
-        InternalUpdateStatistics that = (InternalUpdateStatistics) o;
+        InternalSummaryCounters that = (InternalSummaryCounters) o;
 
         return nodesCreated == that.nodesCreated
             && nodesDeleted == that.nodesDeleted

driver/src/main/java/org/neo4j/driver/internal/summary/SummaryBuilder.java

@@ -28,7 +28,7 @@
 import org.neo4j.driver.v1.summary.ResultSummary;
 import org.neo4j.driver.v1.Statement;
 import org.neo4j.driver.v1.summary.StatementType;
-import org.neo4j.driver.v1.summary.UpdateStatistics;
+import org.neo4j.driver.v1.summary.SummaryCounters;
 import org.neo4j.driver.v1.Value;
 import org.neo4j.driver.v1.exceptions.ClientException;
 
@@ -37,7 +37,7 @@ public class SummaryBuilder implements StreamCollector
     private final Statement statement;
 
     private StatementType type = null;
-    private UpdateStatistics statistics = null;
+    private SummaryCounters statistics = null;
     private Plan plan = null;
     private ProfiledPlan profile;
     private List<Notification> notifications = null;
@@ -71,7 +71,7 @@ public void statementType( StatementType type )
         }
     }
 
-    public void statementStatistics( UpdateStatistics statistics )
+    public void statementStatistics( SummaryCounters statistics )
     {
         if ( this.statistics == null )
         {
@@ -139,9 +139,9 @@ public Statement statement()
             }
 
             @Override
-            public UpdateStatistics updateStatistics()
+            public SummaryCounters counters()
             {
-                return statistics == null ? InternalUpdateStatistics.EMPTY_STATS : statistics;
+                return statistics == null ? InternalSummaryCounters.EMPTY_STATS : statistics;
             }
 
             @Override

driver/src/main/java/org/neo4j/driver/v1/Statement.java

@@ -34,7 +34,7 @@
  * @see Session
  * @see Transaction
  * @see StatementResult
- * @see StatementResult#summarize()
+ * @see StatementResult#consume()
  * @see ResultSummary
  * @since 1.0
  */

driver/src/main/java/org/neo4j/driver/v1/StatementResult.java

@@ -128,22 +128,17 @@ public interface StatementResult extends Iterator<Record>
     <T> List<T> list( Function<Record, T> mapFunction );
 
     /**
-     * Summarize the result.
+     * Consume the entire result, yielding a summary of it.
      *
      * Calling this method exhausts the result.
      *
      * <pre class="doctest:ResultDocIT#summarizeUsage">
      * {@code
-     * ResultSummary summary = session.run( "PROFILE MATCH (n:User {id: 12345}) RETURN n" ).summarize();
+     * ResultSummary summary = session.run( "PROFILE MATCH (n:User {id: 12345}) RETURN n" ).consume();
      * }
      * </pre>
      *
      * @return a summary for the whole query
      */
-    ResultSummary summarize();
-
-    /**
-     * Discard this result, freeing up any associated resources.
-     */
-    void discard();
+    ResultSummary consume();
 }

driver/src/main/java/org/neo4j/driver/v1/StatementRunner.java

@@ -44,7 +44,7 @@
  *
  * <ul>
  *     <li>Read from or discard a result, for instance via {@link StatementResult#next()},
- *     {@link StatementResult#summarize()}, {@link StatementResult#discard()}.</li>
+ *     {@link StatementResult#consume()}, {@link StatementResult#discard()}.</li>
  *     <li>Explicitly commit a transaction using {@link Transaction#close()}</li>
  *     <li>Return a session to the pool using {@link Session#close()}</li>
  * </ul>

driver/src/main/java/org/neo4j/driver/v1/summary/ResultSummary.java

@@ -42,9 +42,9 @@ public interface ResultSummary
     Statement statement();
 
     /**
-     * @return update statistics for the statement
+     * @return counters for operations the statement triggered
      */
-    UpdateStatistics updateStatistics();
+    SummaryCounters counters();
 
     /**
      * @return type of statement that has been executed

driver/src/main/java/org/neo4j/driver/v1/summary/UpdateStatistics.java renamed to driver/src/main/java/org/neo4j/driver/v1/summary/SummaryCounters.java

@@ -21,11 +21,11 @@
 import org.neo4j.driver.v1.util.Immutable;
 
 /**
- * Contains counters for the number of update operations performed by a statement.
+ * Contains counters for various operations that a statement triggered.
  * @since 1.0
  */
 @Immutable
-public interface UpdateStatistics
+public interface SummaryCounters
 {
     /**
      * Whether there were any updates at all, eg. any of the counters are greater than 0.

driver/src/test/java/org/neo4j/driver/internal/InternalBuilderTest.java

@@ -20,11 +20,11 @@
 
 import org.junit.Test;
 
-import org.neo4j.driver.internal.summary.InternalUpdateStatistics;
+import org.neo4j.driver.internal.summary.InternalSummaryCounters;
 import org.neo4j.driver.internal.summary.SummaryBuilder;
 import org.neo4j.driver.v1.summary.ResultSummary;
 import org.neo4j.driver.v1.Statement;
-import org.neo4j.driver.v1.summary.UpdateStatistics;
+import org.neo4j.driver.v1.summary.SummaryCounters;
 
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -42,10 +42,10 @@ public void shouldReturnEmptyStatisticsIfNotProvided() throws Throwable
 
         // When
         ResultSummary summary = builder.build();
-        UpdateStatistics stats = summary.updateStatistics();
+        SummaryCounters stats = summary.counters();
 
         // Then
-        assertEquals( stats, new InternalUpdateStatistics( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ) );
+        assertEquals( stats, new InternalSummaryCounters( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ) );
     }
 
 

driver/src/test/java/org/neo4j/driver/internal/connector/socket/SocketResponseHandlerTest.java

@@ -25,11 +25,11 @@
 import java.util.Map;
 
 import org.neo4j.driver.internal.spi.StreamCollector;
-import org.neo4j.driver.internal.summary.InternalUpdateStatistics;
+import org.neo4j.driver.internal.summary.InternalSummaryCounters;
 import org.neo4j.driver.v1.Value;
 import org.neo4j.driver.v1.summary.Plan;
 import org.neo4j.driver.v1.summary.StatementType;
-import org.neo4j.driver.v1.summary.UpdateStatistics;
+import org.neo4j.driver.v1.summary.SummaryCounters;
 
 import static java.util.Collections.emptyList;
 import static java.util.Collections.singletonList;
@@ -91,7 +91,7 @@ public void shouldCollectBasicMetadata() throws Throwable
                         "properties-set", 12
                 )
         ).asMap( ofValue());
-        UpdateStatistics stats = new InternalUpdateStatistics( 1, 0, 0, 0, 12, 0, 0, 0, 0, 0, 0);
+        SummaryCounters stats = new InternalSummaryCounters( 1, 0, 0, 0, 12, 0, 0, 0, 0, 0, 0);
 
         // When
         handler.handleSuccessMessage( data );
@@ -126,7 +126,7 @@ public void shouldCollectPlan() throws Throwable
                 )
         ).asMap( ofValue());
 
-        UpdateStatistics stats = new InternalUpdateStatistics( 1, 0, 0, 0, 12, 0, 0, 0, 0, 0, 0 );
+        SummaryCounters stats = new InternalSummaryCounters( 1, 0, 0, 0, 12, 0, 0, 0, 0, 0, 0 );
         Plan plan = plan(
             "ProduceResults",
                 parameters( "KeyNames", "num", "EstimatedRows", 1.0 ).asMap( ofValue()), singletonList( "num" ),