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
3. The number of times in which the 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 (if they are used in both the first and second data column) so the number of times the name appears can be greater than the number of years.
4. Alphabetical rank for all names seen in all years.

UNIX> java Main  /home/gtowell/Public/151/A08/names2000.csv /home/gtowell/Public/151/A08/names2001.csv

Name:   (q to quit) aaron

Usage
Aaron
Total Babies       :19088
Times in top 1000  :2
Percentage         : 0.30284856619735295
Alphabetic Position: 2

Name:   (q to quit) sydney

Usage
Sydney
Total Babies       :19879
Times in top 1000  :2
Percentage         : 0.31539850416162923
Alphabetic Position: 1849

Name:   (q to quit) sidney

Usage
Sidney
Total Babies       :2922
Times in top 1000  :4
Percentage         : 0.04636020067208012
Alphabetic Position: 1807

Name:   (q to quit) Marlen

Usage
Marlen
Total Babies       :212
Times in top 1000  :1
Percentage         : 0.003363573765393903
Alphabetic Position: 1415

Name: q

Input Files

	/home/gtowell/Public/151/A08/namesYEAR.csv

rowNumber,name1,number1,name2,number2

1. ignore this column
2. name1: a name; to be complete, name1 is a name used for an assigned gender at birth, male
3. number1: the number of times name1 was used
4. name2: a name; to be complete, name2 is a name used for an assigned gender at birth, female
5. number2: the number of times name2 was used.

1,Jacob,30568,Emily,24463
2,Michael,28246,Madison,21773
3,Joshua,25986,Hannah,18819
4,Matthew,25151,Emma,16538
5,Ethan,22108,Alexis,15636
6,Andrew,22017,Ashley,15342
7,Joseph,21891,Abigail,15297
8,Christopher,21681,Sarah,14758
9,Nicholas,21389,Samantha,14662
10,Daniel,21315,Olivia,14630
...
996,Ean,157,Johana,221
997,Jovanni,157,Juana,221
998,Alton,156,Juanita,221
999,Gerard,156,Katerina,221
1000,Keandre,156,Amiya,220

Requirements

• 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. (You should be able to use code you wrote in Lab.)
• 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.
• The files to be read must be given on the command line as shown in the example 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 data format precisely.
• 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: ARI, Quinn, Renatta, AminA, Micah, dylan (A subset of the names of your classmates). Be sure to use capitalization as it is here.
• Answer the following question: What is the advantage of making the class that contains the baby name information implement its own compareTo method rather than just doing something that directly uses the compareTo method of the name string. (I can think of at least 3 reasons; one is that you need to do this to have a generic solution -- you should defintiely say why this is the case.) If you can't think of any other, speculate wildly. I am looking for a short paragraph.

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/A08/names1990.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. Then while working on getting your linked list in sorted order use only the first 2 lines (4 names). When your sorted linked list is correct for 4 names, do 3 lines (6 names), then 4, ... This may seem painful but it is a time honored approach. 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. 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
• Answer to the question posed in the requirements section. This may be included in your readme. If not in a readme, then the only acceptable formats are text file or PDF.
• 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=8
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