refactored builder to use nicer abstraction

Core/src/org/sleuthkit/autopsy/commonfilesearch/CommonFilesMetaDataBuilder.java

@@ -35,21 +35,17 @@ import org.sleuthkit.datamodel.TskCoreException;
 
 /**
  *
- * Generates a List<CommonFilesMetaData> when collateFiles() is called, which organizes
+ * Generates a List<CommonFilesMetaData> when collateFiles() is called, which
- * AbstractFiles by md5 to prepare to display in viewer.
+ * organizes AbstractFiles by md5 to prepare to display in viewer.
- * 
+ *
  * This entire thing runs on a background thread where exceptions are handled.
  */
-class CommonFilesMetaDataBuilder {
+abstract class CommonFilesMetaDataBuilder {
 
-    private final Long selectedDataSourceId;
     private final Map<Long, String> dataSourceIdToNameMap;
     //TODO subclass this class to specify where clause and/or additional algorithms.
-    private final String singleDataSourceWhereClause = "md5 in (select md5 from tsk_files where data_source_obj_id=%s and (known != 1 OR known IS NULL) GROUP BY  md5 HAVING  COUNT(*) > 1) AND data_source_obj_id=%s order by md5";
-    private final String allDataSourcesWhereClause = "md5 in (select md5 from tsk_files where (known != 1 OR known IS NULL) GROUP BY  md5 HAVING  COUNT(*) > 1) order by md5";
 
-    CommonFilesMetaDataBuilder(Long dataSourceId, Map<Long, String> dataSourceIdMap) {
+    CommonFilesMetaDataBuilder(Map<Long, String> dataSourceIdMap) {
-        selectedDataSourceId = dataSourceId;
         dataSourceIdToNameMap = dataSourceIdMap;
     }
 
@@ -85,18 +81,25 @@ class CommonFilesMetaDataBuilder {
 
         return metaDataModels;
     }
+    
+    /**
+     * Should build a SQL WHERE clause to be passed to SleuthkitCase.findAllFilesWhere(sql) 
+     * which will select the desired common files ordered by  MD5.
+     * @return sql string where clause
+     */
+    protected abstract String buildSqlWhereClause();
 
     private void collateParentChildRelationships(List<AbstractFile> files, Map<String, List<AbstractFile>> parentNodes, Map<String, Set<String>> md5ToDataSourcesStringMap) {
         for (AbstractFile file : files) {
-            
+
             String currentMd5 = file.getMd5Hash();
-            
+
             if (parentNodes.containsKey(currentMd5)) {
                 parentNodes.get(currentMd5).add(file);
                 Set<String> currentDataSources = md5ToDataSourcesStringMap.get(currentMd5);
                 addDataSource(currentDataSources, file, dataSourceIdToNameMap);
                 md5ToDataSourcesStringMap.put(currentMd5, currentDataSources);
-                
+
             } else {
                 List<AbstractFile> children = new ArrayList<>();
                 Set<String> dataSources = new HashSet<>();
@@ -105,20 +108,47 @@ class CommonFilesMetaDataBuilder {
                 addDataSource(dataSources, file, dataSourceIdToNameMap);
                 md5ToDataSourcesStringMap.put(currentMd5, dataSources);
             }
-            
+
         }
     }
 
     private List<AbstractFile> findCommonFiles() throws TskCoreException, NoCurrentCaseException {
         SleuthkitCase sleuthkitCase;
         sleuthkitCase = Case.getOpenCase().getSleuthkitCase();
-        String whereClause = allDataSourcesWhereClause;
+        String whereClause = this.buildSqlWhereClause();
-        if (selectedDataSourceId != 0L) {
-            Object[] args = new String[]{Long.toString(selectedDataSourceId), Long.toString(selectedDataSourceId)};
-            whereClause = String.format(singleDataSourceWhereClause, args);
-        }
         List<AbstractFile> files = sleuthkitCase.findAllFilesWhere(whereClause);
         return files;
     }
-
+}
+
+class SingleDataSource extends CommonFilesMetaDataBuilder {
+
+    private static final String allDataSourcesWhereClause = "md5 in (select md5 from tsk_files where (known != 1 OR known IS NULL) GROUP BY  md5 HAVING  COUNT(*) > 1) order by md5";
+
+    private final Long selectedDataSourceId;
+
+    public SingleDataSource(Long dataSourceId, Map<Long, String> dataSourceIdMap) {
+        super(dataSourceIdMap);
+        this.selectedDataSourceId = dataSourceId;
+    }
+
+    @Override
+    protected String buildSqlWhereClause() {
+        Object[] args = new String[]{Long.toString(this.selectedDataSourceId), Long.toString(this.selectedDataSourceId)};
+        return String.format(SingleDataSource.allDataSourcesWhereClause, args);        
+    }
+}
+
+class AllDataSources extends CommonFilesMetaDataBuilder {
+
+    private static final String singleDataSourceWhereClause = "md5 in (select md5 from tsk_files where data_source_obj_id=%s and (known != 1 OR known IS NULL) GROUP BY  md5 HAVING  COUNT(*) > 1) AND data_source_obj_id=%s order by md5";
+
+    public AllDataSources(Map<Long, String> dataSourceIdMap) {
+        super(dataSourceIdMap);
+    }
+
+    @Override
+    protected String buildSqlWhereClause() {
+        return AllDataSources.singleDataSourceWhereClause;
+    }
 }

Core/src/org/sleuthkit/autopsy/commonfilesearch/CommonFilesPanel.java

@@ -52,6 +52,8 @@ public final class CommonFilesPanel extends javax.swing.JPanel {
 
     private static final long serialVersionUID = 1L;
 
+    public static final Long NO_DATA_SOURCE_SELECTED = -1L; 
+    
     private ComboBoxModel<String> dataSourcesList = new DataSourceComboBoxModel();
     private Map<Long, String> dataSourceMap;
 
@@ -182,7 +184,7 @@ public final class CommonFilesPanel extends javax.swing.JPanel {
         new SwingWorker<List<CommonFilesMetaData>, Void>() {
 
             private Long determineDataSourceId() {
-                Long selectedObjId = 0L;
+                Long selectedObjId = CommonFilesPanel.NO_DATA_SOURCE_SELECTED;
                 if (CommonFilesPanel.this.singleDataSource) {
                     for (Entry<Long, String> dataSource : CommonFilesPanel.this.dataSourceMap.entrySet()) {
                         if (dataSource.getValue().equals(CommonFilesPanel.this.selectedDataSource)) {
@@ -196,8 +198,17 @@ public final class CommonFilesPanel extends javax.swing.JPanel {
 
             @Override
             protected List<CommonFilesMetaData> doInBackground() throws TskCoreException, NoCurrentCaseException, SQLException {
-                Long selectedObjId = determineDataSourceId();
+                Long dataSourceId = determineDataSourceId();
-                return new CommonFilesMetaDataBuilder(selectedObjId, CommonFilesPanel.this.dataSourceMap).collateFiles();
+                
+                CommonFilesMetaDataBuilder builder;
+                
+                if (dataSourceId == CommonFilesPanel.NO_DATA_SOURCE_SELECTED) {
+                    builder = new AllDataSources(dataSourceMap);
+                } else {
+                    builder = new SingleDataSource(dataSourceId, dataSourceMap);
+                }
+                
+                return builder.collateFiles();
             }
 
             @Override