tp

LeBook User Guide

Introduction

LeBook is a straightforward book management application that runs on the command line. With its clean interface and simple commands, LeBook helps librarians keep track of their catalogue of books as well as the shelves they are on. Some functionalities include adding a new book or borrowing a book.

Quick Start

Ensure you have Java 17 or later installed.
Download the latest LeBook.jar from the releases page.
Place the .jar file in an empty folder (it will create a data subfolder for storage).
Run the application using:
```
java -jar LeBook.jar
```

Features

Note:

Before continuing, you can refer to the format of book to understand what it is displaying (Book Format).
All command keywords are case-insensitive, e.g add and aDD, delete and deLete will still allow for proper functionality.
All command should be written in english, otherwise there might be unexpected behaviour.

1. Adding a Book

Add new books to your library with title, author, and genre information.

Refer to here for list of possible genres (case-insensitive).

Format:

add TITLE / AUTHOR / GENRE

Example:

add The Great Gatsby / F. Scott Fitzgerald / nonfiction

Example Output:

____________________________________________________________
I've added: "The Great Gatsby" (by F. Scott Fitzgerald) (Genre: nonfiction, ID: NF-0-0).
Total books in library: 9
Now you have 1 books on the Shelf: NF-0
____________________________________________________________

2. Deleting a Book

Remove books from your library. You can delete a book using 3 methods:

Delete by the book’s index
Delete by the book’s title and author
Delete by the book’s bookID

Format 1 (By Index):

Simply use the command list to see the BOOK_INDEX of the book that you want to delete.

delete num / BOOK_INDEX

Example:

delete num / 1

Format 2 (By Title/Author):

Note: Title and Author are case-sensitive

delete bk / TITLE / AUTHOR

Example:

delete bk / The Great Gatsby / F. Scott Fitzgerald

Format 3 (By bookID):

To better understand the format of the bookID, please refer to here.
Note: bookID is case-sensitive

delete id / BOOK_ID

Example:

delete id / R-0-0

Example Output:

____________________________________________________________
Book deleted:
  [ ] The Great Gatsby (by F. Scott Fitzgerald) (ID: NF-0-0)
Now you have 0 books in the library
____________________________________________________________

3. Listing Books

View all the books currently in your library, including their status, title, author, bookID and due date.

Format:

list

Example Output:

____________________________________________________________
Here are the books in your library:
1. [ ] To Kill a Mockingbird (by Harper Lee) (ID: AD-0-0)
2. [ ] 1984 (by George Orwell) (ID: SCIF-0-0)
3. [X] The Hobbit (by J.R.R. Tolkien) (ID: AD-0-1) | Due: Apr 04 2025
Total books: 3
____________________________________________________________

4. Listing Overdue Books

View all the overdue books currently in your library, including their title, author, borrower name and due date.

Note: Books are ‘overdue’ if they remain borrowed past their due date.

Format:

list overdue

Example Output:

____________________________________________________________
Overdue Books:
1. Harry Potter (by J.K. Rowling) (Borrowed by: deanson) | Due: Apr 05 2025

____________________________________________________________

5. Borrowing a Book

Mark a book as borrowed by a specific member.

Use the command list to see the INDEX of the book that you want to borrow.

Format:

borrow INDEX / MEMBER_NAME

Example:

borrow 2 / Bob

Example Output:

____________________________________________________________
Bob has borrowed: "1984" (Due: Apr 21 2025)
____________________________________________________________

6. Returning a Book

Mark a borrowed book as returned.

Use the command list to see the INDEX of the book that you want to return.

Format:

return INDEX

Example:

return 3

Example Output:

____________________________________________________________
Returned: "The Hobbit"
____________________________________________________________

7. Undoing Previous Command(s)

Undo the last registered command (Add, Delete, Return, Borrow). If no number is specified, the undo function defaults to undoing only the most recent single undoable command.

Format:

undo NUMBER_OF_COMMANDS_TO_UNDO

Example:

undo
undo 2

Confirmation Prompt Before undoing, the system prompts: Confirm undo 1 request? <y/n>: Only y, Y, n, N responses are accepted. Invalid responses will show: [ERROR] Please respond with 'y' or 'n'.

Error Cases

Input < 1: [ERROR] Invalid undo count. Must be at least 1.
Input > 2147483647: [ERROR] Undo count is too large. Maximum allowed is: 2147483647.
Input > number of undoable commands: [ERROR] You only have 0 undoable command(s).

Example Output:

____________________________________________________________
[SUCCESS] Successfully undone: Delete a book by its index
____________________________________________________________
____________________________________________________________
[SUCCESS] Successfully undone: Add Command
____________________________________________________________

8. Finding Books

Search for specific books in your library based on different criteria.

Format:

find CRITERIA SEARCH_TERM

Valid Criteria:

title: Finds books whose title contains the (search term - case-insensitive).
author: Finds books whose author contains the (search term - case-insensitive).
genre: Finds books matching the (specified genre - case-insensitive). Supported genres: romance, adventure, action, horror, mystery, nonfiction, scifi.
id: Finds the book with the exact unique Book ID (e.g., AD-0-1, case-insensitive).
About bookID

Examples:

find title hobbit
find author Tolkien
find genre adventure
find id AD-0-0

Example Output (Found):

____________________________________________________________
Found 1 book(s) with titles containing 'hobbit':
1. [X] The Hobbit by J.R.R. Tolkien (Genre: adventure, ID: AD-0-0) 
       Borrowed by: Alice (Due: ...)
____________________________________________________________

Example Output (Not Found):

____________________________________________________________
Sorry, no books found with titles containing 'rings'.
____________________________________________________________

9. Finding Quantity of a book

Search for number of copies of a specific book in your library.

Note: Title and Author are case-sensitive

Format:

quantity / BOOK_TITLE / BOOK_AUTHOR

Examples:

quantity / Harry Potter / J.K. Rowling

Example Output:

____________________________________________________________
There are 3 copies of the book: Harry Potter (by J.K. Rowling)
____________________________________________________________

10. Listing of a specific Shelf

Allows for the viewing of what books are on a specified shelf.

Refer to here to see the available GENRES.
Refer to the example to see how SHELF_INDEX works.
GENRE is case-insensitive

Format:

shelf / GENRE / SHELF_INDEX

Examples:

shelf / romance / 1

Example Output:

____________________________________________________________
Here is the list of the books on shelf romance 1:
1. [ ] Romeo and Juliet (by Shakespeare) (ID: R-1-0)
____________________________________________________________

11. Help

Brings up the help menu for the user to refer to.

Format:

help

Example Output:

-------------------------------  
 Available Commands:  
-------------------------------  
1. add TITLE / AUTHOR / GENRE      - Add a new book.  
2. borrow INDEX / MEMBER_NAME      - Borrow a book (using 1-based index).  
3. delete bk / TITLE / AUTHOR      - Remove book by title and author.  
4. delete num / INDEX              - Remove book by list index (1-based).  
5. delete id / ID                  - Remove book by book ID.  
6. find CRITERIA TERM              - Search books.  
   Criteria: title, author, genre, id  
7. help                            - Show this help menu.  
8. list                            - List all book titles.  
9. list borrowed                   - List borrowed books.  
10. list overdue                   - List overdue books.  
11. list overdue users             - List users who have overdue books.  
12. quantity / TITLE / AUTHOR      - Shows the quantity of the specified book.  
13. return INDEX                   - Return a borrowed book (using 1-based index).  
14. shelf GENRE / SHELF_NUMBER     - List books on a specific shelf (0-based number).  
15. statistics                     - View library statistics.  
16. undo                           - Undo the last command (add/delete/borrow/return).  
17. bye                            - Exit the program.  
-------------------------------  
Supported Genres:  
  > romance, adventure, action, horror, mystery, nonfiction, scifi  
-------------------------------  
Example Usage:  
  add The Lord of the Rings / J.R.R. Tolkien / adventure  
  quantity / Harry Potter / J.K. Rowling  
  list  
  borrow 1 / Alice  
  find title lord  
  find genre adventure  
  find id AD-0-0  
  return 1  
  delete num / 1  
  bye  

12. Listing Borrowed Books

View all the books in your library that are borrowed, including their title, author, borrower name and due date.

Format:

list borrowed

Example Output:

========================================
Borrowed Books:
1. Harry Potter (by J.K. Rowling) (Borrowed by: Bob) | Due: Apr 02 2025
2. Hunger Games (by Suzanne) (Borrowed by: Bob) | Due: Apr 05 2025

========================================

13. Listing Library Members with Overdue Books

View all the members who have overdue books, including the book title, book author and borrower name.

Format:

list overdue users

Example Output:

========================================
Members with overdue books:
1. Bob - Harry Potter (by J.K. Rowling), Hunger Games (by Suzanne)

========================================

14. Statistics

Provides an overview of the quantities of books in the library.

Format:

statistics

Example Output:

========== Library Statistics ==========
Total books copies: 0
Unique titles: 0
Total books borrowed: 0
Total books overdue: 0
List of unique titles: []

========================================

15. Exiting the Application

Close the application and save the current state of your library.

Format:

bye

Example Output:

____________________________________________________________
Goodbye! Hope to see you again soon!
____________________________________________________________

Book Status and Format

In the list and search results, books are displayed with their status and details:

[ ] indicates an available book.
[X] indicates a borrowed book.

Example format:

INDEX. [STATUS] TITLE (by AUTHOR) (ID: BOOK_ID) | Due: DUE_DATE

Examples:

1. [ ] Pride and Prejudice (by Jane Austen) (ID: R-1-2)
2. [X] The Lord of the Rings (by J.R.R. Tolkien) (ID: AD-0-1) | Due: Apr 21 2025

BookID

A variable tied to a Book and is unique to every new Book added.

BookID is case-sensitive

Format

[GENRE_CODE]-[SHELF_INDEX]-[SLOT-NUM] 
Example: R-0-1
- R refers to 'Romance'
- '0' refers to Shelf 0
- '1' refers to Book 2

Genre / Genre_Code

Genre	Genre_Code
`romance`	`R`
`action`	`AC`
`adventure`	`AD`
`horror`	`H`
`mystery`	`MY`
`nonfiction`	`NF`
`scifi`	`SCIF`

Shelves

Every genre has a collection of 5 shelves indexed by a SHELF_INDEX of 0 to 4

e.g.
1. R-0-0
- The 'R' refers to romance
- The 1st '0' refers to Shelf 0

2. AC-4-0
- The 'AC' refers to action
- The '4' refers to Shelf 4

Command Summary

Command	Format	Example
Add Book	`add TITLE / AUTHOR / GENRE`	`add Dune / Frank Herbert / scifi`
Delete by Index	`delete num / BOOK_INDEX`	`delete num / 1`
Delete by Book	`delete bk / TITLE / AUTHOR`	`delete bk / Dune / Frank Herbert`
Delete by BookID	`delete id / BOOK_ID`	`delete id / R-0-0`
List Books	`list`	`list`
List Overdue Books	`list overdue`	`list overdue`
List Borrowed Books	`list borrowed`	`list borrowed`
List Members with Overdue Books	`list overdue users`	`list overdue users`
List a Specific Shelf	`shelf / GENRE / SHELF_INDEX`	`shelf / romance / 1`
Find Quantity of a Book	`quantity / BOOK_TITLE / BOOK_AUTHOR`	`quantity / Harry Potter / J.K. Rowling`
Borrow Book	`borrow BOOK_NUMBER / MEMBER`	`borrow 2 / Eve`
Return Book	`return BOOK_NUMBER`	`return 3`
Undo Command	`undo NUMBER_OF_COMMANDS_TO_UNDO`	`undo 3`
Find Book	`find CRITERIA TERM`	`find title dune`
Exit	`bye`	`bye`
Help	`help`	`help`
Statistics	`statistics`	`statistics`