final release

src/main/java/namesayer/Main.java

@@ -1,20 +1,16 @@
 package namesayer;
 
 import javafx.application.Application;
-import javafx.fxml.FXMLLoader;
 import javafx.scene.Scene;
 import javafx.stage.Stage;
 import namesayer.persist.NameStorageManager;
 import namesayer.persist.SessionStorageManager;
 import namesayer.persist.StatsManager;
 
-
 import static namesayer.util.Screen.MAIN_MENU;
 
 
 public class Main extends Application {
-    //TODO Implement Rewards screen
-    //TODO Make the card number display actually work
 
     @Override
     public void start(Stage primaryStage) throws Exception {

src/main/java/namesayer/model/CompositeName.java

@@ -1,8 +1,6 @@
 package namesayer.model;
 
 import javafx.application.Platform;
-import javafx.collections.FXCollections;
-import javafx.collections.ObservableList;
 import javafx.event.ActionEvent;
 import javafx.event.EventHandler;
 
@@ -14,16 +12,16 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import static namesayer.persist.Config.BUFFER_TIME;
-import static namesayer.persist.Config.USER_ATTEMPTS;
-import static namesayer.persist.Config.WAV_EXTENSION;
+import static namesayer.persist.Config.*;
+
+
+/**
+ * Represents a full-name created by the user.
+ * This name combines various PartialNames which come bundled with the Names Corpus Database.
+ */
 
 public class CompositeName extends Name implements Serializable {
 
-    /**
-     * These recordings are permanently associated with this name
-     * NameStorageManager accesses this list, any other class will only be able to see an empty list
-     */
 
     private List<CompositeRecording> userAttempts = new ArrayList<>();
     private Exemplar exemplar;
@@ -48,8 +46,14 @@ public void setExemplar(Exemplar exemplar) {
         this.exemplar = exemplar;
     }
 
+    /**
+     * Creates a new recording for this name using FFmpeg.
+     * This command is executed by a bash shell in a separate thread.
+     *
+     *
+     * @param onFinished The EventHandler executed after recording is complete
+     */
     public void makeNewRecording(EventHandler<ActionEvent> onFinished) {
-        //TODO Assume that the name provided is in a suitable format, will provide need regex to check later
         String temp = "se206_" +
                 LocalDateTime.now().format(DateTimeFormatter.ofPattern("d-M-yyyy_HH:mm:ss")) +
                 " " +
@@ -75,9 +79,4 @@ public void makeNewRecording(EventHandler<ActionEvent> onFinished) {
         thread.start();
     }
 
-    public void makeNewRecording() {
-        this.makeNewRecording(event -> {});
-    }
-
-
 }

src/main/java/namesayer/model/CompositeRecording.java

@@ -6,8 +6,13 @@
 import java.nio.file.Path;
 import java.time.LocalDateTime;
 
+/**
+ * Represents an audio file of a CompositeName
+ */
+
 public class CompositeRecording extends Recording {
 
+    //Default rating is 3.0
     private double rating = 3.0;
 
     private LocalDateTime timeStamp;

src/main/java/namesayer/model/Exemplar.java

@@ -3,6 +3,12 @@
 import java.io.Serializable;
 import java.util.List;
 
+
+/**
+ * Represents the exemplar of a CompositeName
+ * This Exemplar is created by extracting PartialNames from the Names Corpus Database
+ */
+
 public class Exemplar implements Serializable {
 
     private List<PartialRecording> exemplarComponents;
@@ -11,11 +17,15 @@ public Exemplar(List<PartialRecording> exemplarComponents) {
         this.exemplarComponents = exemplarComponents;
     }
 
+    /**
+     * Plays the exemplar on a new thread
+     */
     public void playAudio() {
         new Thread(() -> {
             for (PartialRecording recording : exemplarComponents) {
                 recording.playAudio();
                 try {
+                    //Wait for the PartialRecording to finish playing before playing the next one
                     Thread.sleep((long) (recording.getLength() * 1000));
                 } catch (InterruptedException e) {
                     e.printStackTrace();

src/main/java/namesayer/model/Name.java

@@ -2,6 +2,9 @@
 
 import java.io.Serializable;
 
+/**
+ * Abstract base class for any type of Name
+ */
 public abstract class Name implements Comparable<Name>, Serializable {
 
     protected String name;

src/main/java/namesayer/model/PartialName.java

@@ -1,13 +1,15 @@
 package namesayer.model;
 
-import javafx.collections.FXCollections;
-import javafx.collections.ObservableList;
-
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * PartialNames are those which came bundled with the Names Corpus DB.
+ */
+
 public class PartialName extends Name {
 
+    //Ony-to-many relationship PartialNames and PartialRecordings
     private List<PartialRecording> partialRecordings = new ArrayList<>();
 
     public PartialName(String name) {

src/main/java/namesayer/model/PartialRecording.java

@@ -2,6 +2,10 @@
 
 import java.nio.file.Path;
 
+/**
+ *  Represents the audio file of a PartialName
+ */
+
 public class PartialRecording extends Recording {
 
     private boolean isBadQuality = false;

src/main/java/namesayer/model/Recording.java

@@ -10,6 +10,11 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
+/**
+ * Abstract base class of any type of Recording
+ * Represents a WAV audio file
+ */
+
 public abstract class Recording implements Serializable {
 
     private String recordingPath;
@@ -21,7 +26,9 @@ public Recording(Path recordingPath) {
     }
 
 
-    //Play audio using bash command
+    /**
+     * Play audio using FFplay in separate thread
+     */
     public void playAudio() {
         Thread thread = new Thread(() -> {
             String command = "ffplay -nodisp -autoexit -loglevel quiet \"" + recordingPath + "\"";
@@ -45,7 +52,9 @@ public void setRecordingPath(Path newPath) {
     }
 
 
-    //Calculates the length
+    /**
+     * Calculates the length using Java AudioStream API
+     */
     public double getLength() {
         double durationInSeconds = 0.0;
         try {

src/main/java/namesayer/persist/CompositeNamesLoader.java

@@ -8,6 +8,10 @@
 
 import static namesayer.persist.Config.SAVED_RECORDINGS;
 
+/**
+ * Responsible for loading CompositeNames which have been saved in the generated database.
+ */
+
 public class CompositeNamesLoader extends NamesLoader<CompositeName, CompositeRecording> {
 
     @Override

src/main/java/namesayer/persist/Config.java

@@ -5,7 +5,7 @@
 import java.nio.file.Paths;
 
 /**
- * Defines constants which are mainly folder names
+ * Defines constants which describe the required folder structure
  */
 public class Config {
     public static final Path DATABASE_FOLDER = Paths.get("database");
@@ -18,6 +18,8 @@ public class Config {
     public static final Path BAD_QUALITY_FILE = GENERATED_FOLDER.resolve("bad_quality_names.txt");
     public static final Path STATS_FOLDER = GENERATED_FOLDER.resolve("stats");
     public static final Path STATS_FILE = STATS_FOLDER.resolve("data.ser");
+    public static final Path SCRIPT_FILE = Paths.get("script").resolve("VolumeEdit.sh");
 
-    public static final double BUFFER_TIME = 1;
+
+    public static final double BUFFER_TIME = 0.5;
 }