CS 151 - Introduction to Data Structures

Linked lists of baby names

1. name whose stats are reported
2. number - the total number of babies given that name for all years (this is "freq" in the listing below)
3. The number of times in which the user supplied name appears in the lists over all years. For many common names this will be exactly the number years of data scanned. Uncommon names may appear only once or twice over all of the years. Some names may appear twice in a given year so the number of times the name appears can be greater than the number of years. (Shown as "uses" below). In the list for a given year, this may be 0, 1 or 2.
4. Alphabetical rank of the user-supplied from among the names seen in all years read. For instance, if the complete list of names, in alphabetic order is (A D G K L) then the alphabetic position of G is 3. (Shown as Pos below.)

UNIX> java Main 2000 2001 2002

Name:   (q to quit) aaron
Aaron
    Uses:3
    Freq:28089
    Pos:1

Name:   (q to quit) SYDNEY
sydney
    Uses:3
    Freq:28913
    Pos:1911

Name:   (q to quit) SiDNEY
sidney
    Uses:6
    Freq:4135
    Pos:1868


Name:   (q to quit) SYDny
sydny not found


Name:   (q to quit) Marlen
marlen
    Uses:1
    Freq:212
    Pos:1468

Input Files

	https://cs.brynmawr.edu/cs151/Data/Hw9/NNYEAR.csv

	/home/gtowell/Public/151/Data/Hw9/NNYEAR.csv

name,number

1. name: a name;
2. number: a number of times name was used in that year -- note that the name may appear more than once in a given file, so this number is not necessarily the number of times the name was used in the year.

Jacob,34471
Emily,25953
Michael,32035
Hannah,23080
Matthew,28572
Madison,19967
Joshua,27538
Ashley,17997
Christopher,24931
Sarah,17697
Nicholas,24652
Alexis,17629
Andrew,23639
Samantha,17266

Requirements

• All data about individual names must be kept in a linked list.
• The linked list must be kept in alphabetically sorted order by name, case insensitive. The linked list must be in sorted order at all times.
• The linked lists you use should be from scratch; do not use Java's built-in LinkedList class. You may use any code discussed in class or lab or in the textbook. Your linked lists may be either singly or doubly linked. (you may use, in fact are encouraged to use, the linked list you worked on in lab 9.
• The year number(s) to be read must be given (giveable) on the command line as illustrated above.
• The program must use a class of your design that stores all the relevant stats for a particular name.
• Your name holding class must implement the Comparable interface.
• Your linked list class must use the fact that the data items implement the Comparable interface to keep the linked items in sorted order.
• The files to be searched may only be read once.
• The program should never crash. It is OK for the program to choose to die on unexpected input or other issues. However, that should be a decision you, as the programmer made, rather than something that just happens. Use good exception handling. (For instance, suppose on the command line you give the name of a file that does not exist.)
• The interactive component of the program should have a text interface akin to that above. You need not reproduce my format precisely. However, you must have all of the data shown.
• All code should be well-commented and follow the standard style guidelines
• Your linked list implementation must be completely generic. It should, without any code revision, be able to (for example) build a sorted list of Rabbits. (Note that the class(es) that use the linked list will certainly need a lot of code specific to handling the baby name problem. However, this should not affect your linked list code.)
• User interactions should be case insensitive
• You must have a graceful way for the user to quit the program.
• You must show the performance of your program in a "script" file that shows the output of your program on data for the years 1995-2008 (inclusive). The script file should show user interaction for the following names: Lily, Grace, DeVon, Brendan, devin. Be sure to use capitalization as it is here.

Thoughts

Suggested Steps

1. For your development purposes, rather than accepting command line arguments, use an array of strings defined within the main function. For instance, your code could look like:

   public static void main(String[] args) {
       String[] myArgs = {"/home/gtowell/Public/151/Hw9/NN1990.csv"};
   	if (args.length == 0)
   		args = myArgs;
       ...
   }
   

   This has been discussed previously. Doing something like this will make development far quicker (if only because it will allow the use of the run button in VSC). To test with actual command line input you need only provide input on the command line.
2. Initially just work with one input file
3. Write a toString method that prints out the the contents of the linked list. You will use this toString method a lot in the next step.
4. Set up your system so you can specify the number of lines to use (this number may be hard coded as you will use it only during development). Then while working on getting your linked list in sorted order use only the first 4 names. When your sorted linked list is correct for 4 names, use 6 names, then 8, ... This may seem painful but it is a time honored approach because it works. The idea is that by working with a really small data set you can easily spot (and repair) problems (presumably using the interactive debugger).
5. Once you have sorting working, expand your class that holds names to provide storage for usage counts and appearance frequency. Also allow for updates of these quantities
6. Work on the user interaction
7. Create a system for looking up names
8. Expand your system to work with multiple input files
9. Document your code and make the user interactions clear (hopefully better than my sample above).

What to Hand in

• All code, well, documented
• The script file containing the interaction as described in the requirements section
• Readme file with the standard contents
• DO NOT INCLUDE: baby name data files

Electronic Submissions

The following steps for submission assume that you created a project named AssignmentN in the directory /home/YOU/cs151/

1. For this assignment N=9
2. Put the README file into the project directory
3. Go to the directory /home/YOU/cs151
4. Enter /home/gtowell/bin/submit -c 151 -p N -d AssignmentN