From ad8705e299d53bd5ec49bbd51af4987a0384f1b4 Mon Sep 17 00:00:00 2001
From: Tom Morris <tfmorris@gmail.com>
Date: Fri, 28 Oct 2011 17:29:35 +0000
Subject: [PATCH] Javadoc only

git-svn-id: http://google-refine.googlecode.com/svn/trunk@2348 7d457c2a-affb-35e4-300a-418c747d4874
---
 .../google/refine/importers/tree/ImportColumn.java  | 13 +++++++++++--
 .../refine/importers/tree/ImportColumnGroup.java    |  2 +-
 .../refine/importers/tree/ImportVertical.java       |  9 +++++++++
 3 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/main/src/com/google/refine/importers/tree/ImportColumn.java b/main/src/com/google/refine/importers/tree/ImportColumn.java
index ec07a7ca4..4bc7898ea 100644
--- a/main/src/com/google/refine/importers/tree/ImportColumn.java
+++ b/main/src/com/google/refine/importers/tree/ImportColumn.java
@@ -6,8 +6,17 @@ package com.google.refine.importers.tree;
  *
  */
 public class ImportColumn extends ImportVertical {
+    /**
+     * Index of this column.
+     */
     public int      cellIndex;
-    public int      nextRowIndex;
+    /**
+     * Index of next row to allocate.
+     */
+    public int      nextRowIndex;  // TODO: this can be hoisted into superclass
+    /**
+     * ??? - this field is never written to
+     */
     public boolean  blankOnFirstRow;
 
     public ImportColumn() {}
@@ -18,6 +27,6 @@ public class ImportColumn extends ImportVertical {
 
     @Override
     void tabulate() {
-        // already done the tabulation elsewhere
+        // Nothing to do since our nonBlankCount is always up-to-date and we have no children.
     }
 }
\ No newline at end of file
diff --git a/main/src/com/google/refine/importers/tree/ImportColumnGroup.java b/main/src/com/google/refine/importers/tree/ImportColumnGroup.java
index d50e2838d..233ac0da2 100644
--- a/main/src/com/google/refine/importers/tree/ImportColumnGroup.java
+++ b/main/src/com/google/refine/importers/tree/ImportColumnGroup.java
@@ -11,7 +11,7 @@ import org.apache.commons.lang.StringUtils;
 public class ImportColumnGroup extends ImportVertical {
     public Map<String, ImportColumnGroup> subgroups = new HashMap<String, ImportColumnGroup>();
     public Map<String, ImportColumn> columns = new HashMap<String, ImportColumn>();
-    public int nextRowIndex;
+    public int nextRowIndex; // TODO: this can be hoisted into superclass
 
     @Override
     void tabulate() {
diff --git a/main/src/com/google/refine/importers/tree/ImportVertical.java b/main/src/com/google/refine/importers/tree/ImportVertical.java
index 0a29e8d75..58524bfd4 100644
--- a/main/src/com/google/refine/importers/tree/ImportVertical.java
+++ b/main/src/com/google/refine/importers/tree/ImportVertical.java
@@ -1,9 +1,18 @@
 package com.google.refine.importers.tree;
 
+/**
+ * Abstract base class for ImportColumn and ImportColumnGroup
+ */
 abstract class ImportVertical {
     public String name = "";
+    /**
+     * Number of cells which have values in this column/column group.
+     */
     public int nonBlankCount;
 
+    /**
+     * Sum up counts for all children and update.
+     */
     abstract void tabulate();
     
     @Override