renamed a method

Author: JohannesJander

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>io.frictionlessdata</groupId>
     <artifactId>tableschema-java</artifactId>
-    <version>0.5.2-SNAPSHOT</version>
+    <version>0.6.0-SNAPSHOT</version>
     <packaging>jar</packaging>
     <issueManagement>
         <url>https://github.com/frictionlessdata/tableschema-java/issues</url>

src/main/java/io/frictionlessdata/tableschema/Table.java

@@ -214,12 +214,14 @@ public BeanIterator<?> iterator(Class<?> beanType, boolean relations){
     /**
      * This is the simplest case to read data from a Table referencing a file or URL.
      *
-     * Each row of the table will be returned as an Object array. Values in each column
-     * are parsed and converted ("cast) to Java objects on a best guess approach.
-     * @return Interator returning table rows as Object Arrays
+     * If a Schema is set on a table, each row will be returned as an Object array. Values in each column
+     * are parsed and converted ("cast") to Java objects based on the Field definitions of the Schema. If no Schema is
+     * present, rows will always return string arrays
+     *
+     * @return Iterator returning table rows as Object/String Arrays
      */
     public Iterator<Object[]> iterator() {
-       return new TableIterator<>(this, false, false, true, false);
+        return new TableIterator<>(this, false, false, true, false);
     }
 
     /**
@@ -237,8 +239,14 @@ public Iterator<Object[]> iterator() {
      *   <  li> Resolving references to other data sources (parameter `relations` = true)</li>
      *  </ul>
      *
-     * Without a Schema, values in each column are parsed and converted ("cast) to Java objects on a
-     * best guess approach. If a Schema is set on a table, the Field definitions will be used for parsing
+     * The following rules apply:
+     * <ul>
+     *   <li>if no Schema is present, rows will always return string arrays, not objects, as if `cast` was always off</li>
+     *   <li>if `extended` is true, then `cast` is also true, but `keyed` is false</li>
+     *   <li>if `keyed` is true, then `cast` is also true, but `extended` is false</li>
+     * </ul>
+     *
+     * If a Schema is set on a table, the Field definitions will be used for parsing
      * data values to objects.
      *
      * @return Interator returning table rows as Objects, either Arrays or Maps
@@ -249,7 +257,7 @@ public Iterator<Object> iterator(boolean keyed, boolean extended, boolean cast,
 
     /**
      * This method creates an Iterator that will return table rows as String arrays.
-     * It therefore disregards the Schema set on the table.
+     * It therefore disregards the Schema set on the table. It does not follow relations.
      *
      * @return Iterator that returns rows as string arrays.
      */
@@ -259,7 +267,7 @@ public Iterator<String[]> stringArrayIterator() {
 
     /**
      * This method creates an Iterator that will return table rows as String arrays.
-     * It therefore disregards the Schema set on the table.
+     * It therefore disregards the Schema set on the table. It can be configured to follow relations.
      *
      * @param relations Whether references to other data sources get resolved
      * @return Iterator that returns rows as string arrays.
@@ -270,7 +278,7 @@ public Iterator<String[]> stringArrayIterator(boolean relations) {
 
     /**
      * This method creates an Iterator that will return table rows as a Map&lt;String,Object&gt;
-     * where key is the header name, and val is the data converted to Java objects
+     * where key is the header name, and val is the data converted to Java objects. It does not follow relations.
      *
      * @return Iterator that returns rows as Maps.
      */
@@ -280,12 +288,13 @@ public Iterator<Map<String, Object>> mappingIterator() {
 
     /**
      * This method creates an Iterator that will return table rows as a Map&lt;String,Object&gt;
-     * where key is the header name, and val is the data converted to Java objects
+     * where key is the header name, and val is the data converted to Java objects.
+     * It can be configured to follow relations
      *
      * @param relations Whether references to other data sources get resolved
      * @return Iterator that returns rows as Maps.
      */
-    public Iterator<Map<String, Object>> keyedIterator(boolean extended, boolean cast, boolean relations){
+    public Iterator<Map<String, Object>> mappingIterator(boolean extended, boolean cast, boolean relations){
         return new TableIterator<>(this, true, extended, cast, relations);
     }
 

src/test/java/io/frictionlessdata/tableschema/iterator/TableIteratorTest.java

@@ -18,10 +18,7 @@
 import java.time.Duration;
 import java.time.LocalDate;
 import java.time.format.DateTimeFormatter;
-import java.util.ArrayList;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
 import static io.frictionlessdata.tableschema.TestHelper.getResourceFile;
 import static io.frictionlessdata.tableschema.TestHelper.getTestDataDirectory;
@@ -79,6 +76,35 @@ void hasNext() throws Exception {
         Assertions.assertFalse(Table.fromSource("").iterator().hasNext());
     }
 
+    @Test
+    @DisplayName("Test non-casting Iterator")
+    void nonCasting() {
+        validPopulationTable.iterator(false, false, false, false).forEachRemaining((r) -> {
+            Assertions.assertTrue(r instanceof Object[]);
+            Arrays.stream(((Object[])r)).forEach((c)->{
+                Assertions.assertTrue(c instanceof String);
+            });
+        });
+
+    }
+
+
+    @Test
+    @DisplayName("Test no Schema, but casting Iterator")
+    void noSchema() throws Exception {
+        File testDataDir = getTestDataDirectory();
+        File file = new File("data/population.csv");
+        Table populationTable
+                = Table.fromSource(file, testDataDir, null, TableDataSource.getDefaultCsvFormat());
+        populationTable.iterator(false, false, true, false).forEachRemaining((r) -> {
+            Assertions.assertTrue(r instanceof Object[]);
+            Arrays.stream(((Object[])r)).forEach((c)->{
+                Assertions.assertTrue(c instanceof String);
+            });
+        });
+
+    }
+
     @Test
     @DisplayName("Test Iterator throws on remove")
     void remove() {
@@ -89,12 +115,12 @@ void remove() {
 
     @Test
     @DisplayName("Test casting Iterator")
-    void testNextCast() throws Exception {
+    void testNextCast()  {
         Iterator<Map<String, Object>> iter
-                = nullValuesPopulationTable.keyedIterator( false, true, false);
-        Map<String, Object> obj =  (Map<String, Object>)iter.next();
+                = nullValuesPopulationTable.mappingIterator( false, true, false);
+        Map<String, Object> obj = iter.next();
         Assertions.assertNull(obj.get("year"));
-        obj =  (Map<String, Object>)iter.next();
+        obj = iter.next();
         Assertions.assertNull(obj.get("year"));
     }
 
@@ -248,7 +274,7 @@ void testStringObjectMapIterateDataFromJSONFormatAlternateSchema() throws Except
         List<String[]> expectedData = this.getExpectedAlternatePopulationData();
 
         // Get Iterator.
-        Iterator<Map<String, Object>> iter = table.keyedIterator(false, true, false);
+        Iterator<Map<String, Object>> iter = table.mappingIterator(false, true, false);
         int expectedDataIndex = 0;
 
         // Assert data.

src/test/java/io/frictionlessdata/tableschema/table_tests/TableOtherTest.java

@@ -233,7 +233,7 @@ public void testIterateCastKeyedData() throws Exception{
         File file = new File("data/employee_data.csv");
         Table employeeTable = Table.fromSource(file, testDataDir, employeeTableSchema, TableDataSource.getDefaultCsvFormat());
 
-        Iterator<Map<String, Object>> iter = employeeTable.keyedIterator(false, false, false);
+        Iterator<Map<String, Object>> iter = employeeTable.mappingIterator(false, false, false);
 
         while(iter.hasNext()){
             Map row = iter.next();