From de0fe431d53c19f2eaa194bdd434cd9f12d310e4 Mon Sep 17 00:00:00 2001
From: "U-BASIS\\dsmyda" <dsmyda@win-dsmyd-2925.basistech.net>
Date: Wed, 2 Dec 2020 10:27:55 -0500
Subject: [PATCH] Added comments and renamed a function name

---
 .../discovery/search/DiscoveryAttributes.java        |  2 +-
 .../autopsy/discovery/search/DiscoveryKeyUtils.java  |  2 +-
 .../sleuthkit/autopsy/discovery/search/Result.java   | 12 ++++++++++--
 .../autopsy/discovery/search/SearchData.java         |  3 +++
 .../autopsy/discovery/search/SearchFiltering.java    |  2 +-
 5 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/Core/src/org/sleuthkit/autopsy/discovery/search/DiscoveryAttributes.java b/Core/src/org/sleuthkit/autopsy/discovery/search/DiscoveryAttributes.java
index 0a47894d30..58e906367e 100644
--- a/Core/src/org/sleuthkit/autopsy/discovery/search/DiscoveryAttributes.java
+++ b/Core/src/org/sleuthkit/autopsy/discovery/search/DiscoveryAttributes.java
@@ -334,7 +334,7 @@ public class DiscoveryAttributes {
                         String domain = resultSet.getString("domain_name");
                         List<ResultDomain> domainInstances = domainLookup.get(domain);
                         for (ResultDomain domainInstance : domainInstances) {
-                            domainInstance.markAsPreviouslyNotable();
+                            domainInstance.markAsPreviouslyNotableInCR();
                         }
                     }
                 } catch (SQLException ex) {
diff --git a/Core/src/org/sleuthkit/autopsy/discovery/search/DiscoveryKeyUtils.java b/Core/src/org/sleuthkit/autopsy/discovery/search/DiscoveryKeyUtils.java
index 82d0f48ce9..b271e91364 100644
--- a/Core/src/org/sleuthkit/autopsy/discovery/search/DiscoveryKeyUtils.java
+++ b/Core/src/org/sleuthkit/autopsy/discovery/search/DiscoveryKeyUtils.java
@@ -801,7 +801,7 @@ public class DiscoveryKeyUtils {
         private final SearchData.PreviouslyNotable notableStatus;
         
         PreviouslyNotableGroupKey(Result result) {
-            this.notableStatus = result.getPreviouslyNotable();
+            this.notableStatus = result.getPreviouslyNotableInCR();
         }
 
         @Override
diff --git a/Core/src/org/sleuthkit/autopsy/discovery/search/Result.java b/Core/src/org/sleuthkit/autopsy/discovery/search/Result.java
index 9d7f693f62..70bd345ad1 100644
--- a/Core/src/org/sleuthkit/autopsy/discovery/search/Result.java
+++ b/Core/src/org/sleuthkit/autopsy/discovery/search/Result.java
@@ -57,11 +57,19 @@ public abstract class Result {
      */
     public abstract TskData.FileKnown getKnown();
     
-    final public void markAsPreviouslyNotable() {
+    /**
+     * Mark the result as being previously notable in the CR.
+     */
+    final public void markAsPreviouslyNotableInCR() {
         this.isPreviouslyNotable = SearchData.PreviouslyNotable.PREVIOUSLY_NOTABLE;
     }
     
-    final public SearchData.PreviouslyNotable getPreviouslyNotable() {
+    /**
+     * Get the previously notable value of this result.
+     * 
+     * @return The previously notable status enum.
+     */
+    final public SearchData.PreviouslyNotable getPreviouslyNotableInCR() {
         return this.isPreviouslyNotable;
     }
 
diff --git a/Core/src/org/sleuthkit/autopsy/discovery/search/SearchData.java b/Core/src/org/sleuthkit/autopsy/discovery/search/SearchData.java
index 3de4ea7db7..05e89f1220 100644
--- a/Core/src/org/sleuthkit/autopsy/discovery/search/SearchData.java
+++ b/Core/src/org/sleuthkit/autopsy/discovery/search/SearchData.java
@@ -39,6 +39,9 @@ public final class SearchData {
     private static final Set<BlackboardArtifact.ARTIFACT_TYPE> DOMAIN_ARTIFACT_TYPES = EnumSet.of(BlackboardArtifact.ARTIFACT_TYPE.TSK_WEB_BOOKMARK, BlackboardArtifact.ARTIFACT_TYPE.TSK_WEB_CACHE, BlackboardArtifact.ARTIFACT_TYPE.TSK_WEB_COOKIE, BlackboardArtifact.ARTIFACT_TYPE.TSK_WEB_DOWNLOAD, BlackboardArtifact.ARTIFACT_TYPE.TSK_WEB_HISTORY, BlackboardArtifact.ARTIFACT_TYPE.TSK_WEB_SEARCH_QUERY);
 
     
+    /**
+     * Enum representing the notability of the result in the Central Repository.
+     */
     @NbBundle.Messages({
         "SearchData.prevNotable.displayName=Previously Notable",
         "SearchData.notPrevNotable.displayName=Previously Not Notable"
diff --git a/Core/src/org/sleuthkit/autopsy/discovery/search/SearchFiltering.java b/Core/src/org/sleuthkit/autopsy/discovery/search/SearchFiltering.java
index ade423488c..c9c00998c4 100644
--- a/Core/src/org/sleuthkit/autopsy/discovery/search/SearchFiltering.java
+++ b/Core/src/org/sleuthkit/autopsy/discovery/search/SearchFiltering.java
@@ -713,7 +713,7 @@ public class SearchFiltering {
 
             List<Result> filteredResults = new ArrayList<>();
             for (Result file : currentResults) {
-                if (file.getPreviouslyNotable() == SearchData.PreviouslyNotable.PREVIOUSLY_NOTABLE) {
+                if (file.getPreviouslyNotableInCR() == SearchData.PreviouslyNotable.PREVIOUSLY_NOTABLE) {
                     filteredResults.add(file);
                 }
             }