CPSC 170 Lab 1: More Arrays

Collecting Tunes

1. Note that CDCollection is not documented in JavaDoc style. Rework this and generate a JavaDoc Page for the CDCollection class. Remember you can have Eclipse help with this... Make sure that you replace the "Skeleton" comments with real ones. You should also observe that the javadoc makes use of certain markers. Notably:
   • @param - used to specify the intent of input parameters. the name of the parameter immediatly follows @param and then is followed by a description.
   • @returns - used to clarify the semantics of the return value
   Generate the JavaDoc to a subdirectory in the Labs project. Open the HTML and verify that your javadoc looks reasonable. Notice that javadoc does not create an entry for the "IncreaseSize" method. Why not?
2. Compile and run Tunes.java. You should see a list of 6 CDs with a total value of $97.69 and an average cost of $16.28 followed by a menu that lets you add, search for, or remove a CD. Only the add part has been implemented, so add a few CDs to see what happens. When you add the 11th CD (total), you should get a message that says "Increasing size of array" (you may have to scroll back to see it), which comes from the increaseSize() method. This was added this just to help you follow the program's execution.

3. Now you'll add the search functionality:
   1. First you need to be able to tell when two CDs are "the same." You could compare titles and/or artists, but it's cleanest to add an equals method to your CD class and use that. Add method public boolean equals(CD otherCD) to the CD class, and have it require that both the title and the artist be the same for two CDs to be equal.

   2. Add the findCD method from the prelab to the CDCollection class. Don't look through the array any longer than you have to, and don't forget the documentation.

   3. Now run Tunes again and choose the search option. Look for some CDs that are in the collection, some that some not, and at least one that you added to the original collection.

   4. As written, the search option in Tunes asks for the title, artist, price, and tracks because the CD constructor requires all four pieces of information. There's no need to make the user enter the price and tracks when only the title and artist are relevant to the search. You could pass dummy values to the constructor for the price and tracks, but better yet, you could overload the constructor to the CD class that takes just the title and artist. Now modify the Tunes class so that it prompts for just the title and artist on the search function, then creates a new CD object (using the new two-parameter constructor) and passes it to findCD.

   Test your search option thoroughly!

4. Now you'll add the remove functionality. A skeleton for a method public void removeCD(CD cd) is already in the CDCollection class. Your job is to complete it so that it removes the given CD from the collection if it is in there; if not, the collection should remain unchanged. Proceed as follows:
   • When you remove a CD, you'll need to update the collection's total cost. To find the cost of the CD you are removing you will need to add a getCost method to the CD class. Add this method.

   • To remove a CD, you first need to find it. You already have a findCD method but it just returns a boolean, not the location of the CD. Write a new method private int findCDIndex(CD cd) that takes a CD and returns the index of its location in the array, or -1 if it is not in the array. Now modify findCD so that it just calls findCDIndex and returns false if the result is -1, true otherwise. The body of findCD should now be just one line! And you can use the findCDIndex in removeCD as well.

   • Now you can start writing code for removeCD. First, find the index of the CD in the array. If it is there (index != -1) you will need to "take it out,". Remember, you can't leave an empty slot in the middle of the array -- if there are n CDs in the collection they should be in array locations 0..n-1, not 0..n with a hole in the middle.

   • Don't forget to decrement the count.

   You'll also need to add code in Tunes to get information from the user and call removeCD when they choose the remove option.

   Test the remove functionality. Be sure to try removing more than one CD, removing a CD that is not in the collection, and mixing removes with searches and adds.

   NOTE: You have added some extra methods to the CDCollection class. This means that your javadoc file is out of date. If you have coded things properly, you should be able to remedy this by simply recreating your javadoc. (If you didn't add your comments along the way like you are supposed to! you will need to go do some editing first...

   Magic Squares

   One interesting application of two dimensional arrays is magic squares. A magic square is a square matrix in which the sum of every row, every column, and both diagonals is the same. Magic squares have been studied for many years, and there are some particularly famous magic squares. In this exercise you will write code to determine whether a square is magic.

   File Square.java contains the shell for a class that represents a square matrix. It contains headers for a constructor that takes the size of the square and a scanner to read from, plus headers for methods to read values into the square, print the square, find the sum of a given row, find the sum of a given column, find the sum of the main (or other) diagonal, and determine whether the square is magic.

   File SquareTest.java contains the shell for a program that reads input for squares and tells whether each is a magic square. Following the comments fill in the remaining code, but take it a piece at a time as follows:

   • First fill in code for the constructor and the printSquare method in the Square class. Then add code to SquareTest just to read and print each square. (Note that the other methods in the Square class have dummy return values so it will compile.) Compile and run your program with the file magicData to be sure you're reading all 7 squares correctly.

   • Now add code to compute and print the sums of the rows and run your program again to make sure this is working correctly.

   • Now add code to compute and print the sums of the columns and the sums of the diagonals, testing as you go.

   • Finally write the magic method and indicate whether each square is magic. You should find that the first, second, and third squares in the input are magic, and that the rest (fourth through seventh) are not. Note that the -1 at the bottom tells the test program to stop reading.

HAND IN:

• Printouts of your programs - make sure that your name is included in the header comments (not just written on)
• Tar the files in your lab1 directory with the command

   
  tar czf lab1.tgz .