Put menu in a loop rather than quitting after each query

Author: daniel-keogh

README.md

@@ -1,6 +1,6 @@
 # Language Detector
 
-Y3S1 Object Oriented Programming Assignment
+Y3S1 Object-Oriented Programming Assignment
 
 ## Description
 
@@ -39,29 +39,29 @@ While the application's accuracy is limited, it is still often able to accuratel
 ### Japanese
 
 ```
-$ Enter WiLi data location (or press enter to use the default): datasets/wili-2018-Large-117500-Edited.txt
+$ Choose WiLi dataset ('L' for Large, 'S' for Small): S
 $ Enter the query text/file: samples/jp.txt
+Query file entered.
 Processing query...
 Building subject database...
 Finished processing query.
 Finished building subject database.
 
 The text appears to be written in Japanese.
-
-Time: 2.643 (s)
+Time: 0.433 (s)
 ```
 
 ### French
 
 ```
-$ Enter WiLi data location (or press enter to use the default):
+$ Choose WiLi dataset ('L' for Large, 'S' for Small): L
 $ Enter the query text/file: samples/fr.txt
+Query file entered.
 Processing query...
 Building subject database...
 Finished processing query.
 Finished building subject database.
 
 The text appears to be written in French.
-
-Time: 35.619 (s)
+Time: 34.957 (s)
 ```

src/ie/gmit/sw/query/QueryFile.java

@@ -11,6 +11,7 @@
  */
 public class QueryFile implements Query {
     private final Path filepath;
+    private String queryString;
 
     /**
      * Constructs a new QueryFile using the given filepath
@@ -30,12 +31,16 @@ public QueryFile(Path filepath) {
      */
     @Override
     public String getQuery() throws IOException {
-        String queryString = removeWhitespace(Files.readString(filepath));
+        if (this.queryString == null) {
+            String queryString = removeWhitespace(Files.readString(filepath));
 
-        if (queryString.length() > MAX_QUERY_LENGTH) {
-            return queryString.substring(0, MAX_QUERY_LENGTH);
+            if (queryString.length() > MAX_QUERY_LENGTH) {
+                this.queryString = queryString.substring(0, MAX_QUERY_LENGTH);
+            } else {
+                this.queryString = queryString;
+            }
         }
 
-        return queryString;
+        return this.queryString;
     }
 }

src/ie/gmit/sw/ui/Menu.java

@@ -10,7 +10,6 @@
 
 import java.io.File;
 import java.io.FileNotFoundException;
-import java.io.IOException;
 import java.nio.file.Path;
 import java.util.Scanner;
 import java.util.concurrent.ExecutionException;
@@ -30,7 +29,8 @@ public class Menu {
     private Path dataPath;
     private Query query;
 
-    private static final String DEFAULT_DATA_PATH = "datasets/wili-2018-Large-117500-Edited.txt";
+    private static final String LARGE_DATASET = "datasets/wili-2018-Large-117500-Edited.txt";
+    private static final String SMALL_DATASET = "datasets/wili-2018-Small-11750-Edited.txt";
 
     public Path getDataPath() {
         return dataPath;
@@ -65,38 +65,14 @@ public void display() {
         System.out.println("=============================================================================");
 
         try (var console = new Scanner(System.in)) {
-            String input;
-
             while (true) {
                 try {
                     if (dataPath == null) {
-                        System.out.print("$ Enter WiLi data location (or press enter to use the default): ");
-                        input = console.nextLine().trim();
-
-                        if (input.isEmpty()) {
-                            input = DEFAULT_DATA_PATH;
-                        }
-
-                        if (isFile(input)) {
-                            this.dataPath = Path.of(input);
-                        } else {
-                            throw new FileNotFoundException("The dataset file could not be found");
-                        }
+                        getDatasetInput(console);
                     }
 
                     if (query == null) {
-                        System.out.print("$ Enter the query text/file: ");
-                        input = console.nextLine().trim();
-
-                        if (input.isEmpty()) {
-                            continue;
-                        }
-
-                        if (isFile(input)) {
-                            this.query = new QueryFile(Path.of(input));
-                        } else {
-                            this.query = new QueryString(input);
-                        }
+                        getQueryInput(console);
                     }
 
                     break;
@@ -105,8 +81,53 @@ public void display() {
                 }
             }
         }
+    }
+
+    private void getDatasetInput(Scanner console) throws FileNotFoundException {
+        while (true) {
+            System.out.print("$ Choose WiLi dataset ('L' for Large, 'S' for Small): ");
+            String input = console.nextLine().toUpperCase().trim();
+
+            if (input.equals("L")) {
+                input = LARGE_DATASET;
+            } else if (input.equals("S")) {
+                input = SMALL_DATASET;
+            } else {
+                continue;
+            }
+
+            if (isFile(input)) {
+                this.dataPath = Path.of(input);
+                break;
+            } else {
+                throw new FileNotFoundException("The dataset file could not be found");
+            }
+        }
+    }
 
-        detect();
+    private void getQueryInput(Scanner console) {
+        while (true) {
+            System.out.print("$ Enter the query text/file: ");
+            String input = console.nextLine().trim();
+
+            if (input.isEmpty()) {
+                continue;
+            }
+
+            if (input.equals("-1")) {
+                break;
+            }
+
+            if (isFile(input)) {
+                this.query = new QueryFile(Path.of(input));
+                System.out.println("Query file entered.");
+            } else {
+                this.query = new QueryString(input);
+                System.out.println("Query string entered.");
+            }
+
+            detect();
+        }
     }
 
     private void detect() {
@@ -150,12 +171,12 @@ private void detect() {
 
         try {
             Language result = subParser.detect(qParser.getQueryMapping());
-            System.out.printf("\nThe text appears to be written in %s.\n", result.toString());
+            System.out.printf("\nThe text appears to be written in %s.", result.language());
         } catch (IllegalStateException e) {
             System.err.println("\n[Error] Failed to detect the language: " + e.getMessage());
         }
 
-        System.out.println("\nTime: " + calcDuration(startTime) + " (s)");
+        System.out.println("\nTime: " + calcDuration(startTime) + " (s)\n");
     }
 
     private static boolean isFile(String filename) {

src/ie/gmit/sw/utils/Script.java

@@ -1,9 +1,8 @@
 package ie.gmit.sw.utils;
 
-import java.util.Map;
+import java.util.SortedMap;
 import java.util.TreeMap;
 
-import static java.util.stream.Collectors.*;
 import static java.lang.Character.*;
 
 /**
@@ -14,35 +13,26 @@ private Script() {
     }
 
     /**
-     * Attempt to determine which script a given string is most likely written in.
+     * Determines which script a given string is most likely written in.
      * <p>
      * This is done by finding the {@link UnicodeScript} of each 1-gram in the text.
      * <p>
-     * Since the text may contain characters in multiple scripts, this method will try to return the closest match.
+     * Since the text may contain characters in multiple scripts, this method will return the closest match.
      *
      * @param text The text to process
-     * @return The {@link UnicodeScript} that was the closest match, or null if there was no match
+     * @return The {@link UnicodeScript} that was the closest match
      */
     public static UnicodeScript of(String text) {
-        // Find the highest Integer value in the map since that is most likely the script.
-        // Reference: https://codereview.stackexchange.com/a/153400
-        return findMatchingScripts(text)
-                .entrySet()
-                .stream()
-                .collect(groupingBy(Map.Entry::getValue, TreeMap::new, toMap(Map.Entry::getKey, Map.Entry::getValue)))
-                .lastEntry()
-                .getValue()
-                .keySet()
-                .stream()
-                .findFirst()
-                .orElse(null);
+        // Returns the script with the highest value/frequency in the map
+        return findMatchingScripts(text).lastKey();
     }
 
     /**
-     * Gets a mapping of each {@link UnicodeScript} found in a given String along with its frequency of occurrence.
+     * Gets a mapping of each {@link UnicodeScript} found in a given String along with its frequency of
+     * occurrence in ascending order.
      */
-    private static Map<UnicodeScript, Integer> findMatchingScripts(String text) {
-        Map<UnicodeScript, Integer> matchingScripts = new TreeMap<>();
+    private static SortedMap<UnicodeScript, Integer> findMatchingScripts(String text) {
+        SortedMap<UnicodeScript, Integer> matchingScripts = new TreeMap<>();
 
         text = stripWhitespace(text);