Update docs for corecomponents/TableFilterChildren, TableFilterNode

Core/src/org/sleuthkit/autopsy/corecomponents/TableFilterChildren.java

@@ -1,7 +1,7 @@
 /*
  * Autopsy Forensic Browser
  *
- * Copyright 2011 Basis Technology Corp.
+ * Copyright 2011-2016 Basis Technology Corp.
  * Contact: carrier <at> sleuthkit <dot> org
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,38 +23,67 @@ import org.openide.nodes.FilterNode;
 import org.openide.nodes.Node;
 
 /**
- * Complementary class to TableFilterNode.
+ * A children (child factory) implementation for a TableFilterNode. A
+ * TableFilterNode creates at most one layer of child nodes for the node it
+ * wraps. It is designed to be used for nodes displayed in Autopsy table views.
  */
 class TableFilterChildren extends FilterNode.Children {
 
     /**
-     * the constructor
+     * Constructs a children (child factory) implementation for a
+     * TableFilterNode. A TableFilterNode creates at most one layer of child
+     * nodes for the node it wraps. It is designed to be used for nodes
+     * displayed in Autopsy table views.
+     *
+     * @param wrappedNode The node wrapped by the TableFilterNode.
      */
-    TableFilterChildren(Node arg) {
+    TableFilterChildren(Node wrappedNode) {
-        super(arg);
+        super(wrappedNode);
-    }
-
-    @Override
-    protected Node copyNode(Node arg0) {
-        return new TableFilterNode(arg0, false);
-    }
-
-    @Override
-    protected Node[] createNodes(Node arg0) {
-        // filter out the children
-        return new Node[]{this.copyNode(arg0)};
     }
 
     /**
-     * Converts the given FsContent into "Children".
+     * Copies a TableFilterNode, with the create children (child factory) flag
+     * set to false.
      *
-     * @param fs
+     * @param nodeToCopy The TableFilterNode to copy.
      *
-     * @return children
+     * @return A copy of a TableFilterNode.
      */
-    public static Children createInstance(Node arg, boolean createChild) {
+    @Override
-        if (createChild) {
+    protected Node copyNode(Node nodeToCopy) {
-            return new TableFilterChildren(arg);
+        return new TableFilterNode(nodeToCopy, false);
+    }
+
+    /**
+     * Creates the child nodes represented by this children (child factory)
+     * object.
+     *
+     * @param key The key, i.e., the node, for which to create the child nodes.
+     *
+     * @return
+     */
+    @Override
+    protected Node[] createNodes(Node key) {
+        return new Node[]{this.copyNode(key)};
+    }
+
+    /**
+     * Creates a children (child factory) object for a node wrapped in a
+     * TableFilterNode. A TableFilterNode creates at most one layer of child
+     * nodes for the node it wraps. It is designed to be used for nodes
+     * displayed in Autopsy table views.
+     *
+     *
+     * @param wrappedNode    The node wrapped by the TableFilterNode.
+     * @param createChildren True if a children (child factory) object should be
+     *                       created for the wrapped node.
+     *
+     * @return A children (child factory) object for a node wrapped by a
+     *         TableFilterNode.
+     */
+    public static Children createInstance(Node wrappedNode, boolean createChildren) {
+        if (createChildren) {
+            return new TableFilterChildren(wrappedNode);
         } else {
             return Children.LEAF;
         }

Core/src/org/sleuthkit/autopsy/corecomponents/TableFilterNode.java

@@ -23,24 +23,25 @@ import org.openide.nodes.Node;
 import org.openide.util.NbBundle;
 
 /**
- * A filter node that creates at most one layer of children for the node it
+ * A filter node that creates at most one layer of child nodes for the node it
  * wraps. It is designed to be used for nodes displayed in Autopsy table views.
  */
 public class TableFilterNode extends FilterNode {
 
-    private final boolean isLeaf;
+    private final boolean createChildren;
 
     /**
-     * Constructs a filter node that creates at most one layer of children for
+     * Constructs a filter node that creates at most one layer of child nodes
-     * the node it wraps. It is designed to be used for nodes displayed in
+     * for the node it wraps. It is designed to be used for nodes displayed in
      * Autopsy table views.
      *
-     * @param wrappedNode The node to wrap in the filter node.
+     * @param wrappedNode    The node to wrap in the filter node.
-     * @param isLeaf      True if the wrapped node is a leaf node.
+     * @param createChildren True if a children (child factory) object should be
+     *                       created for the wrapped node.
      */
-    public TableFilterNode(Node wrappedNode, boolean isLeaf) {
+    public TableFilterNode(Node wrappedNode, boolean createChildren) {
-        super(wrappedNode, TableFilterChildren.createInstance(wrappedNode, isLeaf));
+        super(wrappedNode, TableFilterChildren.createInstance(wrappedNode, createChildren));
-        this.isLeaf = isLeaf;
+        this.createChildren = createChildren;
     }
 
     /**
@@ -51,7 +52,7 @@ public class TableFilterNode extends FilterNode {
      */
     @Override
     public String getDisplayName() {
-        if (isLeaf) {
+        if (createChildren) {
             return NbBundle.getMessage(this.getClass(), "TableFilterNode.displayName.text");
         } else {
             return super.getDisplayName();