renaming of top level packages. part 1

Author: lwhite1

src/main/java/com/deathrayresearch/outlier/Query.java renamed to src/main/java/com/github/lwhite1/outlier/Query.java

@@ -1,7 +1,7 @@
-package com.deathrayresearch.outlier;
+package com.github.lwhite1.outlier;
 
-import com.deathrayresearch.outlier.columns.Column;
-import com.deathrayresearch.outlier.filter.Filter;
+import com.github.lwhite1.outlier.filter.Filter;
+import com.github.lwhite1.outlier.columns.Column;
 
 import java.util.ArrayList;
 import java.util.List;

src/main/java/com/deathrayresearch/outlier/Relation.java renamed to src/main/java/com/github/lwhite1/outlier/Relation.java

@@ -1,7 +1,16 @@
-package com.deathrayresearch.outlier;
-
-import com.deathrayresearch.outlier.api.ColumnType;
-import com.deathrayresearch.outlier.columns.*;
+package com.github.lwhite1.outlier;
+
+import com.github.lwhite1.outlier.columns.BooleanColumn;
+import com.github.lwhite1.outlier.columns.CategoryColumn;
+import com.github.lwhite1.outlier.columns.Column;
+import com.github.lwhite1.outlier.columns.FloatColumn;
+import com.github.lwhite1.outlier.columns.IntColumn;
+import com.github.lwhite1.outlier.columns.LocalDateColumn;
+import com.github.lwhite1.outlier.columns.LocalDateTimeColumn;
+import com.github.lwhite1.outlier.columns.LocalTimeColumn;
+import com.github.lwhite1.outlier.columns.LongColumn;
+import com.github.lwhite1.outlier.api.ColumnType;
+import com.github.lwhite1.outlier.columns.ShortColumn;
 import org.apache.commons.lang3.StringUtils;
 
 import java.util.List;

src/main/java/com/deathrayresearch/outlier/Rows.java renamed to src/main/java/com/github/lwhite1/outlier/Rows.java

@@ -1,8 +1,17 @@
-package com.deathrayresearch.outlier;
-
-import com.deathrayresearch.outlier.api.ColumnType;
-import com.deathrayresearch.outlier.columns.*;
-import com.deathrayresearch.outlier.util.ReverseIntComparator;
+package com.github.lwhite1.outlier;
+
+import com.github.lwhite1.outlier.columns.BooleanColumn;
+import com.github.lwhite1.outlier.columns.CategoryColumn;
+import com.github.lwhite1.outlier.columns.Column;
+import com.github.lwhite1.outlier.columns.FloatColumn;
+import com.github.lwhite1.outlier.columns.IntColumn;
+import com.github.lwhite1.outlier.columns.LocalDateColumn;
+import com.github.lwhite1.outlier.columns.LocalDateTimeColumn;
+import com.github.lwhite1.outlier.columns.LocalTimeColumn;
+import com.github.lwhite1.outlier.columns.LongColumn;
+import com.github.lwhite1.outlier.api.ColumnType;
+import com.github.lwhite1.outlier.columns.ShortColumn;
+import com.github.lwhite1.outlier.util.ReverseIntComparator;
 import it.unimi.dsi.fastutil.ints.IntArrayList;
 import it.unimi.dsi.fastutil.ints.IntComparator;
 import org.roaringbitmap.RoaringBitmap;

src/main/java/com/deathrayresearch/outlier/SubTable.java renamed to src/main/java/com/github/lwhite1/outlier/SubTable.java

@@ -1,7 +1,16 @@
-package com.deathrayresearch.outlier;
+package com.github.lwhite1.outlier;
 
-import com.deathrayresearch.outlier.api.ColumnType;
-import com.deathrayresearch.outlier.columns.*;
+import com.github.lwhite1.outlier.columns.BooleanColumn;
+import com.github.lwhite1.outlier.columns.CategoryColumn;
+import com.github.lwhite1.outlier.columns.Column;
+import com.github.lwhite1.outlier.columns.FloatColumn;
+import com.github.lwhite1.outlier.columns.IntColumn;
+import com.github.lwhite1.outlier.columns.LocalDateColumn;
+import com.github.lwhite1.outlier.columns.LocalDateTimeColumn;
+import com.github.lwhite1.outlier.columns.LocalTimeColumn;
+import com.github.lwhite1.outlier.columns.LongColumn;
+import com.github.lwhite1.outlier.api.ColumnType;
+import com.github.lwhite1.outlier.columns.ShortColumn;
 
 import java.util.List;
 

src/main/java/com/deathrayresearch/outlier/Table.java renamed to src/main/java/com/github/lwhite1/outlier/Table.java

@@ -1,13 +1,14 @@
-package com.deathrayresearch.outlier;
-
-import com.deathrayresearch.outlier.columns.CategoryColumn;
-import com.deathrayresearch.outlier.columns.Column;
-import com.deathrayresearch.outlier.columns.IntColumn;
-import com.deathrayresearch.outlier.filter.Filter;
-import com.deathrayresearch.outlier.sorting.Sort;
-import com.deathrayresearch.outlier.store.TableMetadata;
-import com.deathrayresearch.outlier.util.IntComparatorChain;
-import com.deathrayresearch.outlier.util.ReverseIntComparator;
+package com.github.lwhite1.outlier;
+
+import com.github.lwhite1.outlier.columns.IntColumn;
+import com.github.lwhite1.outlier.columns.CategoryColumn;
+import com.github.lwhite1.outlier.columns.Column;
+import com.github.lwhite1.outlier.filter.Filter;
+import com.github.lwhite1.outlier.sorting.Sort;
+import com.github.lwhite1.outlier.store.TableMetadata;
+import com.github.lwhite1.outlier.util.IntComparatorChain;
+import com.github.lwhite1.outlier.util.ReverseIntComparator;
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Preconditions;
 import it.unimi.dsi.fastutil.ints.IntArrayList;
 import it.unimi.dsi.fastutil.ints.IntArrays;
@@ -16,24 +17,43 @@
 
 import java.util.*;
 
-import static com.deathrayresearch.outlier.sorting.Sort.Order;
+import static com.github.lwhite1.outlier.sorting.Sort.Order;
 
 /**
- *
+ * A table of data, consisting of some number of columns, each of which has the same number of rows.
+ * All the data in a column has the same type: integer, float, category, etc.
  */
 public class Table implements Relation {
 
+  /**
+   * A unique identifier for the table.
+   * TODO(lwhite): consider removing
+   */
   private final String id;
 
+  /**
+   * The name of the table
+   */
   private String name;
 
+  /**
+   * The columns that hold the data in this table
+   */
   private final List<Column> columnList = new ArrayList<>();
 
+  /**
+   * Returns a new table initialized with the given name
+   */
   public Table(String name) {
     this.name = name;
     this.id = UUID.randomUUID().toString();
   }
 
+  /**
+   * Returns a new table initialized with data from the given TableMetadata object
+   * <p/>
+   * The metadata is used by the storage module to save tables and read their data from disk
+   */
   public Table(TableMetadata metadata) {
     this.name = metadata.getName();
     this.id = metadata.getId();
@@ -45,48 +65,72 @@ public Table(TableMetadata metadata) {
    * @param name    The name of the table
    * @param columns One or more columns, all of which must have either the same length or size 0
    */
-  public Table(String name, Column ... columns) {
+  public Table(String name, Column... columns) {
     this(name);
     for (Column column : columns) {
       this.addColumn(column);
     }
   }
 
+  /**
+   * Adds the given column to this table
+   */
   @Override
   public void addColumn(Column column) {
     columnList.add(column);
   }
 
+  /**
+   * Sets the name of the table
+   */
   @Override
   public void setName(String name) {
     this.name = name;
   }
 
+  /**
+   * Returns the column at the given index in the column list
+   *
+   * @param columnIndex an integer >= 0 and < number of columns in the relation
+   */
   @Override
   public Column column(int columnIndex) {
     return columnList.get(columnIndex);
   }
 
+  /**
+   * Returns the number of columns in the table
+   */
   @Override
   public int columnCount() {
     return columnList.size();
   }
 
+  /**
+   * Returns the number of rows in the table
+   */
   @Override
   public int rowCount() {
     int result = 0;
     if (!columnList.isEmpty()) {
+      // all the columns have the same number of elements, so we can check any of them
       result = columnList.get(0).size();
     }
     return result;
   }
 
+  /**
+   * Returns the list of columns
+   */
   @Override
   public List<Column> columns() {
     return columnList;
   }
 
-  // TODO(lwhite): Implement for views and add to relation api
+
+  /**
+   * Returns only the columns whose names are given in the input array
+   */
   public List<Column> columns(String[] columnNames) {
     List<Column> columns = new ArrayList<>();
     for (String columnName : columnNames) {
@@ -95,6 +139,11 @@ public List<Column> columns(String[] columnNames) {
     return columns;
   }
 
+  /**
+   * Returns the index of the column with the given name
+   *
+   * @throws IllegalArgumentException if the input string is not the name of any column in the table
+   */
   public int columnIndex(String columnName) {
     int columnIndex = -1;
     for (int i = 0; i < columnList.size(); i++) {
@@ -109,6 +158,12 @@ public int columnIndex(String columnName) {
     return columnIndex;
   }
 
+  /**
+   * Returns the index of the given column (its position in the list of columns)
+   * <p/>
+   *
+   * @throws IllegalArgumentException if the column is not present in this table
+   */
   public int columnIndex(Column column) {
     int columnIndex = -1;
     for (int i = 0; i < columnList.size(); i++) {
@@ -123,6 +178,9 @@ public int columnIndex(Column column) {
     return columnIndex;
   }
 
+  /**
+   * Returns the name of the table
+   */
   @Override
   public String name() {
     return name;
@@ -156,6 +214,12 @@ public int row(int r) {
     return r;
   }
 
+  /**
+   * Returns a string representation of the value at the given row and column indexes
+   *
+   * @param c the column index, 0 based
+   * @param r the row index, 0 based
+   */
   @Override
   public String get(int c, int r) {
     Column column = column(c);
@@ -173,13 +237,19 @@ public Table emptyCopy() {
     return copy;
   }
 
+  /**
+   * Clears all the data from this table
+   */
   @Override
   public void clear() {
     for (Column column : columnList) {
       column.clear();
     }
   }
 
+  /**
+   * Returns the unique id of this table
+   */
   public String id() {
     return id;
   }
@@ -218,6 +288,9 @@ public Table sortOn(String... columnNames) {
     return sortOn(key);
   }
 
+  /**
+   * Returns a copy of this table sorted in the order of the given column names, in ascending order
+   */
   public Table sortAscendingOn(String... columnNames) {
     return this.sortOn(columnNames);
   }
@@ -230,7 +303,11 @@ public Table sortDescendingOn(String... columnNames) {
     return sortOn(key);
   }
 
-  public static Sort getSort(String ... columnNames) {
+  /**
+   * Returns an object that can be used to sort this table in the order specified for by the given column names
+   */
+  @VisibleForTesting
+  public static Sort getSort(String... columnNames) {
     Sort key = null;
     for (String s : columnNames) {
       if (key == null) {
@@ -257,6 +334,9 @@ public Table sortOn(Sort key) {
     return sortOn(chain);
   }
 
+  /**
+   * Returns a comparator that can be used to sort the records in this table according to the given sort key
+   */
   public IntComparator getComparator(Sort key) {
     Iterator<Map.Entry<String, Sort.Order>> entries = key.iterator();
     Map.Entry<String, Sort.Order> sort = entries.next();
@@ -269,6 +349,9 @@ public IntComparator getComparator(Sort key) {
     return comparator;
   }
 
+  /**
+   * Returns a comparator chain for sorting according to the given key
+   */
   private IntComparatorChain getChain(Sort key) {
     Iterator<Map.Entry<String, Sort.Order>> entries = key.iterator();
     Map.Entry<String, Sort.Order> sort = entries.next();
@@ -305,7 +388,11 @@ public Table sortOn(IntComparator rowComparator) {
     return newTable;
   }
 
-  public int[] rows() {
+  /**
+   * Returns an array of ints of the same number of rows as the table
+   */
+  @VisibleForTesting
+  int[] rows() {
     int[] rowIndexes = new int[rowCount()];
     for (int i = 0; i < rowCount(); i++) {
       rowIndexes[i] = i;
@@ -344,7 +431,7 @@ public Table selectIf(Filter filter) {
     return newTable;
   }
 
-  public Query select(String ... columnName) {
+  public Query select(String... columnName) {
     return new Query(this, columnName);
   }
 
@@ -354,7 +441,7 @@ public Query select(String ... columnName) {
   @Override
   public void removeColumns(Column... columns) {
     for (Column c : columns)
-    columnList.remove(c);
+      columnList.remove(c);
   }
 
   public Table countBy(String byColumnName) {
@@ -379,24 +466,24 @@ private SubTable splitGroupingColumn(SubTable subTable, List<Column> columnNames
     Iterator row = columnNames.iterator();
 
     Column c;
-    while(row.hasNext()) {
-      c = (Column)row.next();
+    while (row.hasNext()) {
+      c = (Column) row.next();
       Column col = c.emptyCopy();
       newColumns.add(col);
     }
 
-    for(int var7 = 0; var7 < subTable.rowCount(); ++var7) {
+    for (int var7 = 0; var7 < subTable.rowCount(); ++var7) {
       String[] var8 = subTable.name().split("|||");
 
-      for(int var9 = 0; var9 < newColumns.size(); ++var9) {
-        ((Column)newColumns.get(var9)).addCell(var8[var9]);
+      for (int var9 = 0; var9 < newColumns.size(); ++var9) {
+        ((Column) newColumns.get(var9)).addCell(var8[var9]);
       }
     }
 
     row = newColumns.iterator();
 
-    while(row.hasNext()) {
-      c = (Column)row.next();
+    while (row.hasNext()) {
+      c = (Column) row.next();
       subTable.addColumn(c);
     }