IT 220 Library Assignment
Overview
For this assignment, you will be creating a library system that allows users to search for books or CDs, check out items, and display a list of the items they have checked out. This system is designed for a single user, but could be expanded to accommodate multiple users.
Learning outcomes: Inheritance and polymorphism, interfaces, file I/O, console I/O.
The Library Hierarchy
The classes in the inheritance hierarchy for the Library system are shown below. Note that Loanable and Comparable are interfaces, and Item is an abstract class. The Comparable interface already exists. You will not be creating it.
The Item Class
The abstract Item class represents an item in the library. Each item has a numeric item number, a title, and a check out date. The Item class has the following methods:
- Item - constructs an Item with an item number and title
- setCheckOutDate - takes a date and assigns it to an item
- dueDate - Calculates and returns an item's due date based on its check out date and loan period
- Hint: See LocalDate.plusDays()
- getTitle - returns an item's title
- getItemNum - returns an item's number
- getCheckOutDate - returns an item's check out date
- compareTo - compares items based on type (i.e. class name), and then title within type. In other words, books will be sorted before cd's.
- isOverdue - returns a boolean indicating whether an item's due date has passed
- Hint: You can use LocalDate.now() to get the current date.
- toString - returns a String representation of an item, which includes item number, class name, and title
The Book and CD Classes
The Book and CD classes override loanPeriod(), which is inherited from Loanable. The loan period for a book is 30 days, and the loan period for a CD is 14 days. The loanPeriod() methods will simply return a value. However, you can imagine an implementation where the loan period is calculated based on the type of library patron, the number of items checked out or on hold, or some other criteria.
The Files
There are two files for this assignment, library.txt and checked-out.txt. The library.txt file stores all of the items currently in the library. There are 112 items currently in the file, but you are welcome to add your own! The items the user currently has checked out are stored in checked-out.txt. Note that the checked out file contains the checked out date, while the library file does not. When the user exits the program, the checked-out.txt file will be overwritten with the users currently checked out items.
Make sure that your files are stored in a files directory.
Here are snippets from the files:
library.txt
1004^cd^Adele^25 1005^cd^Sam Hunt^Montevallo 1006^cd^Drake^Views 1007^book^Ballard^One Shot at Forever^True story about a high school baseball team in Illinois... 1008^book^Bascomb^Nazi Hunters^A Bluegrass award book that is non-fiction and is about the capture... 1009^book^Bemis^Nine pound hammer^Ray and his little sister are orphans and are on a train bound for...
checked-out.txt
998^cd^Alabama Shakes^Sound & Color^2016-05-03 999^cd^Walk the Moon^Talking is Hard^2016-04-28 1007^book^Ballard^One Shot at Forever^True story about a high school baseball team in Illinois-...^2016-04-10 1008^book^Bascomb^Nazi Hunters^A Bluegrass award book that is non-fiction and is about the capture...^2016-05-11
The Library Class
A Library class will define your application logic.
The Library class data includes the following:
- items - an array of items in the library
- checkedOut - an array of the items that are currently checked out
- itemsOut - the number of items that are currently checked out; a user may have at most 10 items checked out
- in - a Scanner that reads from the Console
- NUM_ITEMS - a constant representing the total number of items in the library, which is currently 112.
- MAX_ITEMS - a constant representing the maximum number of items that can be checked out at one time, i.e. 10
Library class methods are described as follows:
- Library - initializes an array of items in the library, and an array of checked out items. The library items are stored in library.txt. The checked out items are stored in checked-out.txt. (Note: You can imagine that in a future iteration of this project, checked out items might be read from a database.) The constructor calls readCheckedOut and readLibrary.
- readCheckedOut - reads the contents of checked-out.txt into the checkedOut[] array.
- readLibrary - reads the contents of library.txt into the items[] array.
- menu - displays a menu of options and returns the users selection. Input should be case-insensitive. If the user enters an invalid menu option, display an appropriate message. The menu options correspond with the following Library methods:
- [S]earch the library: search()
- [C]heck out an item: checkOut()
- [P]rint my items: printList()
- e[X]it: saveAll(), and then exit the program
- search - prompts the user for a search term, and then searches the library items for the term. All items that have the search term anywhere in their title or artist/author should be included in the search results. Searches are case-insensitive. If there are no matches, display an appropriate message.
- checkOut - prompts the user for an item number, then sets the checked out date for the item and adds it to the checkedOut array. If the user is at their checkout limit, they are not allowed to check out any more items. A user may not check out the same item twice. If the selected item number is not in the library, display an appropriate message.
- printList - displays a list of all items that are currently checked out, including their due date. If an item is overdue, that should be indicated in the list. Items should be printed in order first by type, and then in alphabetical order, by title. (See sample output, below.) Note: The logic for sorting should be handled in your compareTo() method.
- saveAll - saves all items in the checkedOut list to checked-out.txt.
- inArray - helper method that returns true if the search item is in the array, and false otherwise. For example, you might use this to see if an item is already checked out.
The Driver Class
Create a driver class that instantiates a Library object. Then, display the menu and respond to the user's selection until the user chooses to Exit.
Javadoc
Generate Javadoc documentation for all of your classes. Include the "doc" folder as part of your zipped Eclipse project.
Sample Run
Sample output for the library application is shown below.
MAIN MENU --------- [S]earch the library [C]heck out an item [P]rint my items e[X]it Your selection: p Your items: 1008 - Book: Nazi Hunters, Bascomb. Date due: 2016-06-10 1007 - Book: One Shot at Forever, Ballard. Date due: 2016-05-10 OVERDUE 998 - CD: Sound & Color, Alabama Shakes. Date due: 2016-05-17 999 - CD: Talking is Hard, Walk the Moon. Date due: 2016-05-12 OVERDUE MAIN MENU --------- [S]earch the library [C]heck out an item [P]rint my items e[X]it Your selection: m Invalid selection. Your selection: s Enter search term: queen Search results: 1001 - CD: Greatest Hits, Queen 1025 - Book: The Queen, Cass MAIN MENU --------- [S]earch the library [C]heck out an item [P]rint my items e[X]it Your selection: c Item Number to check out: 1001 You have successfully checked out 1001 - CD: Greatest Hits, Queen. Date due: 2016-05-25 MAIN MENU --------- [S]earch the library [C]heck out an item [P]rint my items e[X]it Your selection: C Item Number to check out: 1001 You already have that item checked out. MAIN MENU --------- [S]earch the library [C]heck out an item [P]rint my items e[X]it Your selection: c Item Number to check out: 2000 Item 2000 was not found. MAIN MENU --------- [S]earch the library [C]heck out an item [P]rint my items e[X]it Your selection: P Your items: 1008 - Book: Nazi Hunters, Bascomb. Date due: 2016-06-10 1007 - Book: One Shot at Forever, Ballard. Date due: 2016-05-10 OVERDUE 1001 - CD: Greatest Hits, Queen. Date due: 2016-05-25 998 - CD: Sound & Color, Alabama Shakes. Date due: 2016-05-17 999 - CD: Talking is Hard, Walk the Moon. Date due: 2016-05-12 OVERDUE MAIN MENU --------- [S]earch the library [C]heck out an item [P]rint my items e[X]it Your selection: x Goodbye!