Lab 9: Morse Code Decoder

Learning Outcomes

• Implement a binary tree
• Recursively traverse a tree

Overview

Morse Code is a method for communicating using two symbols: dots and dashes. Each character has a code, consisting of zero or more dots and zero or more dashes. The following table describes the mapping for many popular characters:

In this assignment, you will create a Morse Code decoder. You will write and test two classes: MorseDecoder and MorseTree<E>.

In order to decode each series of dots and dashes, you must build a binary tree. A partially constructed tree is shown below. The tree contains the letters A to E in the alphabet.

Notice that the resulting binary tree provides a decoding path. For example, the letter D can be decoded from its Morse Code: -... To accomplish this, we start at the root of the tree and traverse to the left or right depending on whether the code begins with a dot or a dash respectively. In this case, -.. begins with a dash followed by two dots, so we would traverse from the root of the tree once to the right and then twice to the left. Doing so causes us to arrive at a node in the tree with the value D.

In fact, once the tree is fully populated, all symbols in it can be decoded by visiting the left child when a dot is encountered and visiting the right child when a dash is encountered. When all of the dots/dashes in the code have been processed, the resulting node in the tree contains the symbol represented by the code.

Procedure

Your program must read in a file consisting of characters that have been encoded in Morse Code. In the encoded file, each character is translated into its morse code. Each code is separated by a space. For example, HI THERE would appear in an encoded file as: .... .. .-... - .... . .-. .. Your MorseDecoder class must read an encoded file and write the decoded result to an output file. Your program must make use of a MorseTree<E> class to store the Morse Code in a binary tree.

The MorseTree<E> class must define a private Node class that uses generics to denote the type of data stored in the tree. Each node will contain the instance variable symbol as an E as well as its left and right children. If the node does not contain a symbol, it should be null. The MorseTree<E> will have a single instance variable, root.

The MorseTree<E> class must have the following public methods:

• MorseTree() — constructor that ensures that the content in root is set to null.
• add(E symbol, String code) — where symbol is the letter/digit/punctuation mark and code is the Morse Code associated with the symbol and inserts it into the tree. Keep in mind that this may involve adding multiple nodes to the tree. For example, if A is added to the tree first, the following nodes are added to the tree: An empty node (that is, a node no symbol) as the root node as well as an empty node that is the root node's left child. That node must have a right child that is a node whose content is set to A. This method should throw an IllegalArgumentException if the code passed to the method contains anything other than . or -.
• decode(String code) — where code is the code for a symbol that is returned by the method (in an Optional<E>). If a code is not found, the method should return an empty optional. This method should throw an IllegalArgumentException if the String passed to the method contains anything other than . or -. This method must make a call to a private recursive method that does most of the work. Note: This method will function correctly only if the tree has been correctly populated in advance.
• toString() — Use a preorder traversal to visit each node. For every symbol that is not null, add to the return String the symbol using a left-justified width of 4, then add the code, followed by a newline.

The logic of your program should be implemented in the MorseDecoder utility class. The design for this class is your responsibility; however, you are required to have two methods. The first is loadDecoder(Path path) that accepts a Path object containing the Morse Code file as an argument. The method calls the add() from the MorseTree<E> class multiple times in order to populate the tree. Each line of the file contains one codeword mapping. The first character is the symbol (e.g., D) immediately followed by the corresponding morse codeword (e.g., -..). The method will return a completed MorseTree object.

The second required method is decodeMessage(File input, MorseTree<Character> tree) which decodes the contents of the file using the MorseTree. It will traverse one symbol at a time through the encoded file and translate the symbol into a character, returning a String contaiing the decoded message.

Notes:

• Your program should not decode symbols that are not found in the tree. A warning message should be displayed to the console for any code encountered that is not in the morse code tree.
• Line breaks in the following file are included for clarity but should be treated as whitespace. Newlines should be added to the output file only when the .-.- codeword is encountered.

Interface

Your program should use a clean GUI that automatically loads the dictionary file of morse code and builds the MorseTree. When a user loads an encoded file, the program should decode the file and present it to the user below the original, encoded file. Below is an example interface:

Your Controller class will need to implement the Initializable interface and define at minimum the following functionality

• public void initialize(URL url, ResourceBundle resourceBundle) — Loads the Morse Code table once the GUI has been loaded.

• void open() — will ask the user for the text file to decode, display the message, decode the message, and display the decoded message.

• void save() — will ask the user for a filename, then save the decoded message as that file.

• void quit() — will exit the program

• void clear() — will clear the input and output text from the GUI.

• void about() — will generate a Dialog window with instructions on how to use the program

• There will be three menus in your GUI, File, Edit, and Help.

• File will be contain the following items:

  • Open
  • Save
  • Quit

• Edit will contain just Clear

• Help will contain just About

Running your program on this file:

.- .-... ... .--. .- -.-. . .-... ... .... --- ..- .-.. -.. .-... -... . .-... .--. .-.. .- -.-. . -.. .-... -... . - .-- . . -. .-... . .- -.-. .... .-... . -. -.-. --- -.. . -.. .-... -.-. .... .- .-. .- -.-. - . .-. .-.-.- .-.-
.-.-
.- .-... * .-... ... .... --- ..- .-.. -.. .-... -... . .-... .--. .-.. .- -.-. . -.. .-... -... . - .-- . . -. .-... . .- -.-. .... .-... .-- --- .-. -.. .-.-.- .-.-
.-.-
.-.. .. -. . .-... -... .-. . .- -.- ... .-... .. -. .-... - .... . .-... .. -. .--. ..- - .-... ..-. .. .-.. . .-... ... .... --- ..- .-.. -.. .-... -... . .-... .-. . .--. .-.. .. -.-. .- - . -.. .-... .. -. .-... - .... . .-... . -. -.-. --- -.. . -.. .-... ..-. .. .-.. . .-.-.-  .-.-

should display this decoded message:

A SPACE SHOULD BE PLACED BETWEEN EACH ENCODED CHARACTER.

A  SHOULD BE PLACED BETWEEN EACH WORD.

LINE BREAKS IN THE INPUT FILE SHOULD BE REPLICATED IN THE ENCODED FILE.

Additionally, if there were any illegal characters found during decoding, an alert listing all of the characters skipped should pop up when the decoding is complete.

Acknowledgements

This assignment was originally developed by Dr. Jay Urbain.