From 2bf0c91929d157c9c7b6b84196bfbbeca7651e9d Mon Sep 17 00:00:00 2001
From: Richard Cordovano <rcordovano@basistech.com>
Date: Mon, 25 Jan 2016 18:08:27 -0500
Subject: [PATCH] Update documentation of data source id

---
 .../autopsy/casemodule/AddImageTask.java      | 42 ++++++++++++++++---
 .../autopsy/casemodule/ImageDSProcessor.java  |  2 +-
 .../casemodule/LocalDiskDSProcessor.java      |  5 ++-
 3 files changed, 40 insertions(+), 9 deletions(-)

diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/AddImageTask.java b/Core/src/org/sleuthkit/autopsy/casemodule/AddImageTask.java
index 57d3e6efe0..b2a47b29f3 100644
--- a/Core/src/org/sleuthkit/autopsy/casemodule/AddImageTask.java
+++ b/Core/src/org/sleuthkit/autopsy/casemodule/AddImageTask.java
@@ -113,14 +113,44 @@ class AddImageTask implements Runnable {
         }
     }
 
-    AddImageTask(String dataSourceId, String imgPath, String tz, boolean noOrphans, DataSourceProcessorProgressMonitor aProgressMonitor, DataSourceProcessorCallback cbObj) {
+    /**
+     * Runs the data source processor in a separate thread without requiring use
+     * the configuration panel.
+     *
+     * @param dataSourceId         An ASCII-printable identifier for the data
+     *                             source that is unique across multiple cases
+     *                             (e.g., a UUID).
+     * @param imagePath            Path to the image file.
+     * @param timeZone             The time zone to use when processing dates
+     *                             and times for the image, obtained from
+     *                             java.util.TimeZone.getID.
+     * @param ignoreFatOrphanFiles Whether to parse orphans if the image has a
+     *                             FAT filesystem.
+     * @param monitor              Progress monitor to report progress during
+     *                             processing.
+     * @param cbObj                Callback to call when processing is done.
+     */
+    /**
+     * Constructs a runnable task that adds an image to the case database.
+     *
+     * @param imagePath            Path to the image file.
+     * @param timeZone             The time zone to use when processing dates
+     *                             and times for the image, obtained from
+     *                             java.util.TimeZone.getID.
+     * @param ignoreFatOrphanFiles Whether to parse orphans if the image has a
+     *                             FAT filesystem.
+     * @param monitor              Progress monitor to report progress during
+     *                             processing.
+     * @param cbObj                Callback to call when processing is done.
+     */
+    AddImageTask(String dataSourceId, String imagePath, String timeZone, boolean ignoreFatOrphanFiles, DataSourceProcessorProgressMonitor monitor, DataSourceProcessorCallback cbObj) {
         currentCase = Case.getCurrentCase();
         this.dataSourceId = dataSourceId;
-        this.imagePath = imgPath;
-        this.timeZone = tz;
-        this.noFatOrphans = noOrphans;
+        this.imagePath = imagePath;
+        this.timeZone = timeZone;
+        this.noFatOrphans = ignoreFatOrphanFiles;
         this.callbackObj = cbObj;
-        this.progressMonitor = aProgressMonitor;
+        this.progressMonitor = monitor;
     }
 
     /**
@@ -141,7 +171,7 @@ class AddImageTask implements Runnable {
                 progressMonitor.setIndeterminate(true);
                 progressMonitor.setProgress(0);
                 dirFetcher.start();
-                addImageProcess.run(dataSourceId, imagePath);
+                addImageProcess.run(dataSourceId, new String[]{imagePath});
             } catch (TskCoreException ex) {
                 logger.log(Level.SEVERE, "Core errors occurred while running add image. ", ex); //NON-NLS
                 hasCritError = true;
diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/ImageDSProcessor.java b/Core/src/org/sleuthkit/autopsy/casemodule/ImageDSProcessor.java
index 8368d4352e..963b572467 100644
--- a/Core/src/org/sleuthkit/autopsy/casemodule/ImageDSProcessor.java
+++ b/Core/src/org/sleuthkit/autopsy/casemodule/ImageDSProcessor.java
@@ -147,7 +147,7 @@ public class ImageDSProcessor implements DataSourceProcessor {
      * Runs the data source processor in a separate thread without requiring use
      * the configuration panel.
      *
-     * @param dataSourceId         A identifier for the data source that is
+     * @param dataSourceId         An ASCII-printable identifier for the data source that is
      *                             unique across multiple cases (e.g., a UUID).
      * @param imagePath            Path to the image file.
      * @param timeZone             The time zone to use when processing dates
diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/LocalDiskDSProcessor.java b/Core/src/org/sleuthkit/autopsy/casemodule/LocalDiskDSProcessor.java
index 1b2d2c1b4f..0e9203fceb 100644
--- a/Core/src/org/sleuthkit/autopsy/casemodule/LocalDiskDSProcessor.java
+++ b/Core/src/org/sleuthkit/autopsy/casemodule/LocalDiskDSProcessor.java
@@ -130,8 +130,9 @@ public class LocalDiskDSProcessor implements DataSourceProcessor {
      * Runs the data source processor in a separate thread without requiring use
      * the configuration panel.
      *
-     * @param dataSourceId         A identifier for the data source that is
-     *                             unique across multiple cases (e.g., a UUID).
+     * @param dataSourceId         An ASCII-printable identifier for the data
+     *                             source that is unique across multiple cases
+     *                             (e.g., a UUID).
      * @param drivePath            Path to the local drive.
      * @param timeZone             The time zone to use when processing dates
      *                             and times for the image, obtained from