To Documents

IT 313 -- Project 6a

1. Goal: Implement classes that represent items in a library: books and music CDs. For Project 6b, these items will be placed in a collection class named LibraryManager.
2. Deliverables:
   

   LibraryItem.java  Book.java  MusicCD.java  Test2.java
   

3. Details:
   
   1. Implement the classes LibraryItem, Book, and MusicCD instance variables and methods defined by this UML diagram.
   2. LibraryItem is the base class for the derived classes Book and MusicCD.
   3. All instance variables except checkedOut have standard getters but no setters.
   4. The getter for checkedOut is isCheckedOut.
   5. The method checkOut sets the value of checkedOut to true.
   6. The method checkIn sets the value of checkedOut to false.
   7. The method compareTo, required by the Comparable interface, returns 1 if this.title > other.title, returns -1 if this.title < other.title, and returns 0 if this.title == other.title.
   8. Create a unit test class Test2 that tests all the public methods of these three classes.
   9. You will probably want to create a traditional test class Test1 first, before creating Test2.
   10. Test incrementally: start by writing with the constructor and toString methods in the LibraryItem class, then testing them.
   11. Keep adding and testing one instance method at a time until you have written and tested all the methods.
   12. Add JavaDoc comments to your LibraryItem, Book, and MusicCD classes so that you can use the JavaDoc software to obtain documentation.

Grading Breakdown

• LibraryItem Class: 25%; Book Class: 15%; MusicCD Class: 15%; Test2 Class: 25%; Comments: 10%; Indentation: 5%; Submission: 5%.

Project 6b

• Goal: Write LibraryManager collection class that contains LibraryItem objects and derived class items (Book and CD). Use this LibraryManager UML diagram as a reference.
• Deliverables:
  

  LibraryItem.java  Book.java  MusicCD.java  Test1.java  LibraryManager.java
  

  Deliverables for extra credit:
  

  Test2.java  CommandShell.java
  

• Details:
  
  1. Write a LibraryManager collection class that has a HashMap instance variable col that can contain LibraryItem objects.
  2. Write a constuctor for the LibraryManager class that instantiates the HashMap collection to an initial capacity of 500 items and load factor 0.6f.
  3. The LibraryManager collection should also have these instance methods:
     
     • public void addItem(LibraryItem theBook)
       Add a book to the hashmap collection using the catalogNum as the key.
     • public ArrayList<LibraryItem> getAll( )
       Return a sorted array list of all the objects in the hash map.
     • public LibraryItem getByCatalogNum(int catalogNum)
       Return the object from the hashmap with the given catalog number.
     • public ArrayList<LibraryItem> getByYear(int year)
       Return a sorted array list of objects from the hashmap that have the given year.
     • public ArrayList<LibraryItem> getCheckedOut( )
       Return a sorted array list of objects from the hashmap that are checked out.
     • public int getCount( )
       Return the count of all the items in the hashmap.
     • public Iterable<LibraryItem> iterator( ) {
           return col.values( ).iterator( );
       }
       Required method of the Iterable interface.
     • public void load( )
       Deserialize the objects from the disk file library-items.ser.
     • public void save( )
       Serialize the objects in the collection to the disk file library-items.ser.
  4. Test your LibraryManager collection with the traditional test file Test3.java.
  5. Possible addons for extra credit (10 points):
     
     1. Add JavaDoc comments to your classes.
     2. Write a unit test file Test4.java to test your collection.
     3. Write a console shell that interactively runs your LibraryManager class.  In a while loop, repeatedly read commands such as these:
        
        

        Command	Method Called
        addbook	addItem
        addcd	addItem
        getall	agetAll
        getbycatnum	getByCatalogNum
        getbyyear	getByYear
        getcheckedout	getCheckedOut
        count	getCount
        load	load
        save	save

     4. Add JavaDoc comments and generate JavaDoc documentation for your classes.

Grading Breakdown

• LibraryManager Class: 40%; Test3 Class: 40%; Comments: 10%; Indentation: 5%; Submission: 5%. Extra credit up to 10%.