In this homework, you will apply the concepts you learned in class to reinforce your understanding of:
This is an indiviual homework assignment. Please review Academic Integrity section of the class syllabus for rules on individual homework assignments.
Project Overview
In this homework, you will implement a few classes that you will need for a larger project, which will be assigned in homework 3. To help you understand the big picture, the larger project is described in this section, while Homework 2 Description section provides the specifics of homework 2.
We want to design and implement a program that keeps track of phone number records. Suppose we have a CSV file with a list of people and their phone numbers. Given this CSV file, we want to be able to answer the following questions:
- Whose phone number is X (where X is some phone number)? A phone number X may or may not contain dashes. Your program should be able to correctly look up the phone number, regardles of the dashes. For example: "314-999-9999" and "3149999999" are considered to be the same phone number.
- What are the names and phone numbers of all the people with a last name of Y (where Y is some last name)? Your program should be able to correctly look up last name, regardless of capitalization used in the query. For example: "Holdener", "holdener", and "hoLDEner" are considered to be the same last name.
- What are the last names and phone numbers of all the people with the first name of Z (where Z is some first name)? Your program should be able to correctly look up first name, regardless of capitalization used in the query. For example: "Kate", "kate", and "KATE" are considered to be the same first name.
To implement this project, we'll need to do some preliminary design: a set of classes that we'll use to represent and manipulate the data. Let's consider some questions:
- How will I represent a single phone number record?
- What information should I store in a single phone number record?
- What behaviors should a single phone number record support?
- How will I represent a collection of phone number records?
- What behaviors should a collection of phone number records support?
- How will I read the phone number records from a CSV file?
Homework 2 Description
Our first step toward designing this project is to create a mechanism for reading phone number records from a CSV file. Since reading phone recrods from a CSV file (or any other type of file or database) is a concern that is completely separate from searching through the records, we'll have a dedicated class, PhoneRecordReaderCSV, for doing the reading from CSV file. This class is responsible for reading all the phone records from the file, whose name is provided in the constructor. If it cannot read from the provided file, it should print "Could not read from <FILE_NAME>" followed by the error message provided in the exception. This class should not throw any exceptions. I provided a skeleton PhoneRecordReaderCSV.java for you to start with. Implement the methods outlined in this skeleton. Do not change the names, return types, or parameters of the methods provided. Feel free to add anything you need to this class.
The PhoneRecordReaderCSV class uses a PhoneRecord class, which encapsulates the data in each line of the csv file. Specifically, it encapsulates the first name, last name, and phone number of each record. I provided a skeleton PhoneRecord.java code for you to start with. Implement the methods outlined in this skeleton. Do not change the names, return types, or parameters of the methods provided. Feel free to add anything you need to this class. Note, that the comments of this class skeleton provide more specific instructions about what is expected of each method. Make sure to read these comments and follow those instructions.
Write a Driver class that contains the main method, which should:
- accept one command line argument - the name of the CSV file
- Create an instance of the PhoneRecordReaderCSV object, using the file name provided at command line.
- Get an ArrayList of phone records from the PhoneRecordReaderCSV object and print them to the terminal (one per line). What's a convenient way to print a human readable version of an object?
An example usage of your Driver clas is shown below:
javac Driver.java
java Driver phoneNumbers.csv
An example csv file can be found
here. You should test your application with this sample file. In addition to this, you should do more testing to ensure that:
- Your application gracefully handles the case of a bad file name
- Your application properly formats the phone numbers (removes all dashes when printing phone numbers)
- Your application properly handles files of different size (a file with one record, for example)
Submitting your solution
Submit your solution to this homework to hw2 directory of your CSCI 2300 git repo.
Grading
All submitted code must compile. Code that does not compile will receive a grade of zero. I will be compiling your submissions on hopper.slu.edu with the following command:
javac Driver.java
To grade your programs, I will use the list of questions below. Each question can score you from 0 to 2 points: No - 0, Somewhat - 1, Yes - 2. The sum of these points will be your grade for this homework.
- Does your Driver utilize the command line argument containing input file name?
- Does your Driver gracefully handle the case when no command line argument is provided?
- Does your application gracefully handle non-existing input files?
- Does your PhoneRecordFromCSV class properly retrieve all records defined in the input file?
- Does getPhoneNumber() of the PhoneRecord class return a properly formatted phone number?
- Does getLastName() of the PhoneRecord class return a properly formatted last name?
- Does your application gracefully (without crashing) handle bad input (consider a csv file that does not have all three required fields for a phone number record)?
- Did you follow good programming practices (code indentation, variable names, etc)?