org.sourceforge.vlibrary.user.logic

Class LibraryManager

java.lang.Object

org.sourceforge.vlibrary.user.logic.LibraryManager

public class LibraryManager
extends Object

Implementation of LibraryManagerFacade interface providing the business logic functions for the Virtual Library. Data access is mediated by DAO objects, which are instantiated using Spring dependency injection.

Constructor Summary

Constructors

Constructor and Description
LibraryManager()

Method Summary

Modifier and Type	Method and Description
ArrayList<Book>	authorSearch(String authorLastName) Returns a list including all {org.sourceforge.vlibrary.user.domain.Author}s with the the given last name.
boolean	bookExists(long book) Determines whether or not there is a book with the given id.
void	cancelRequest(long reader, long book) Cancels a pending request for a book and sends confirmation email to the reader canceling the request.
void	createAuthorIds(ArrayList<Author> authors) Walks input ArrayList, looking up and setting ID properties for each Author in the list.
Book	createBook(Book book, ArrayList<Subject> subjects, ArrayList<Author> authors) Creates a book in the database and associates the given lists of subjects and authors with the book.
void	createBookAuthors(Book book, ArrayList<Author> authors) Sets the authors for the given book.
void	createBookSubjects(Book book, ArrayList<Subject> subjects) Sets the subjects for the given book.
void	createSubjectIds(ArrayList<Subject> subjects) Walks the input ArrayList of Subject instances, looking up and setting ID properties for each Subject in the list.
boolean	deskPhoneExists(String deskPhone) Determines whether or not there is a reader with the given desk phone.
ArrayList<Book>	dump() Returns an ArrayList of Book instances consisting of all books in the library.
void	forgotPassword(String uid, String email) Validates that uid exists and has email as email address of record, then resets the associated password to a randomly generated string and sends the reader an email with the new password.
ArrayList<Author>	getAuthors(Book book) Returns an ArrayList of Author} instances including the authors of the given book.
ArrayList<Location>	getLocations() Returns an ArrayList including all currently defined locations.
long	getPossessor(long book) Queries the transaction table to determine the whereabouts of a book.
ReaderDAO	getReaderDAO()
long	getReaderID(String firstName, String lastName) Returns the ID of a reader with the given first and last name, if there is such a reader, throwing LibraryException if there is no reader with the given name.
ArrayList<Reader>	getReaders() Returns an ArrayList of Reader instances including all currently registered Virtual Library readers.
ArrayList<Subject>	getSubjects() Returns an ArrayList including all subjects currently defined in the Virtual Library.
ArrayList<Subject>	getSubjects(Book book) Returns an ArrayList including all subjects currently defined in the Virtual Library.
List<LibraryTransaction>	getTransactions(long book) Gets the entire transaction history for a book and returns an ArrayList of LibraryTransaction instances.
void	insertReader(Reader reader) Inserts a record corresponding to the given reader into the database.
boolean	isUserIDValid(long id) Determines whether or not the given ID corresponds to a reader.
boolean	isUserIDValid(String UID) Determines whether or not the given UID (user id) belongs to a reader.
boolean	isUserValidByPhone(String phoneNo) Determines whether or not the supplied desk phone number belongs to a reader.
Map	lookupBook(String isbn) Looks up the book indicated by the ISBN with SRU/SRW provider, returning a Map of key-value pairs expressing attributes of the book.
ArrayList<Book>	ownerSearch(long owner) Returns an ArrayList of Book instances consisting of all books that are owned by the reader with the given ID.
void	processCheckin(long reader, long book, long location) Processes book checkin transaction.
void	processCheckout(long reader, long book, long location) Processes book checkout transaction.
BookMoveTransaction	processExchange(long reader, long book, String transactionType, long location) Processes a book checkin or checkout transaction.
void	processRequest(long reader, long book, long location) Processes book request transaction.
boolean	readerExists(long id) Determines whether or not there is a reader with the given ID.
boolean	readerExists(String firstName, String lastName) Determines whether or not there is a reader with the given first and last name.
boolean	requestPending(long reader, long book) Determines whether or not a reader has a request pending for a book.
void	resetPassword(String user, String newPwd) Resets a user's password.
Book	retrieveBook(long bookID) Returns the book with the given ID, or null if there is no such book.
Reader	retrieveByUid(String uid) Retrieves a Reader by user id (UID).
long	retrieveIDByPhone(String phoneNo) Returns the ID of the reader who has the given desk phone.
Reader	retrieveReader(long id) Returns a fully populated Reader corresponding to the reader having the given ID.
LibraryTransaction	retrieveTransaction(long id) Returns the LibraryTransaction with the given transaction id.
void	setAuthorDAO(AuthorDAO authorDAO)
void	setBookDAO(BookDAO bookDAO)
void	setCrypto(Crypto crypto) Used for Spring Dependency Injection
void	setLibraryTransactionDAO(LibraryTransactionDAO libraryTransactionDAO)
void	setLocationDAO(LocationDAO locationDAO)
void	setMailWorker(MailWorker mailWorker)
void	setReaderDAO(ReaderDAO readerDAO)
void	setResourceBundleMessageSource(org.springframework.context.support.ResourceBundleMessageSource resourceBundleMessageSource) Used for Spring Dependency Injection
void	setSruSrwClientInterface(SruSrwClientInterface sruClient) Used for Spring Dependency Injection
void	setSubjectDAO(SubjectDAO subjectDAO)
ArrayList<Book>	subjectAndSearch(ArrayList subjects) Returns an ArrayList of Book instances consisting of all books that are associated with all of the Subjects in the input array.
ArrayList<Book>	subjectOrSearch(ArrayList<Subject> subjects) Returns an ArrayList of Book instances consisting of all books associated with one or more of the Subjects in the input array.
ArrayList<Book>	titleSearch(String title) Returns an ArrayList of Book instances consisting of all books having the given title.
void	updateBook(Book book) Updates the database record associated with book with the properties that the given instance has.
void	updateReader(Reader reader) Updates the database record associated with reader with the properties that the given instance has.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LibraryManager

public LibraryManager()

Method Detail

setResourceBundleMessageSource

public void setResourceBundleMessageSource(org.springframework.context.support.ResourceBundleMessageSource resourceBundleMessageSource)

Used for Spring Dependency Injection

setMailWorker

public void setMailWorker(MailWorker mailWorker)

Parameters:

mailWorker - The mailWorker to set.

setAuthorDAO

public void setAuthorDAO(AuthorDAO authorDAO)

Parameters:

authorDAO - The authorDAO to set.

setBookDAO

public void setBookDAO(BookDAO bookDAO)

Parameters:

bookDAO - The bookDAO to set.

setReaderDAO

public void setReaderDAO(ReaderDAO readerDAO)

Parameters:

readerDAO - The readerDAO to set.

getReaderDAO

public ReaderDAO getReaderDAO()

setSubjectDAO

public void setSubjectDAO(SubjectDAO subjectDAO)

Parameters:

subjectDAO - The subjectDAO to set.

setLibraryTransactionDAO

public void setLibraryTransactionDAO(LibraryTransactionDAO libraryTransactionDAO)

Parameters:

libraryTransactionDAO - The libraryTransactionDAO to set.

setCrypto

public void setCrypto(Crypto crypto)

Used for Spring Dependency Injection

setLocationDAO

public void setLocationDAO(LocationDAO locationDAO)

Parameters:

subjectDAO - The subjectDAO to set.

setSruSrwClientInterface

public void setSruSrwClientInterface(SruSrwClientInterface sruClient)

Used for Spring Dependency Injection

getSubjects

public ArrayList<Subject> getSubjects()
                               throws LibraryException

Returns an ArrayList including all subjects currently defined in the Virtual Library.

Returns:

list of currently defined subjects

Throws:

LibraryException - if an error occurs retrieving the list of subjects

createSubjectIds

public void createSubjectIds(ArrayList<Subject> subjects)
                      throws LibraryException

Walks the input ArrayList of Subject instances, looking up and setting ID properties for each Subject in the list. Lookup is based on the description property. If a Subject is not found, a new entry is inserted into the database and the ID of the newly created record is assigned to the instance.

Parameters:

subjects - ArrayList of Subjects

Throws:

LibraryException - if a data access error occurs

getLocations

public ArrayList<Location> getLocations()
                                 throws LibraryException

Returns an ArrayList including all currently defined locations.

Returns:

list of currently defined locations

Throws:

LibraryException - if an error occurs retrieving the list of subjects

isUserValidByPhone

public boolean isUserValidByPhone(String phoneNo)
                           throws LibraryException

Determines whether or not the supplied desk phone number belongs to a reader.

Parameters:

phoneNo - phone number to validate

Returns:

true if the phone mumber belongs to a Virtual Library reader

Throws:

LibraryException - if a data access error occurs validating the phone number

retrieveIDByPhone

public long retrieveIDByPhone(String phoneNo)
                       throws LibraryException

Returns the ID of the reader who has the given desk phone.

Returns 0 if there is no reader with the given desk phone.

Parameters:

phoneNo - the desk phone to look up

Returns:

the ID of the reader, or 0 if not found

Throws:

LibraryException - if a data access error occurs

isUserIDValid

public boolean isUserIDValid(long id)
                      throws LibraryException

Determines whether or not the given ID corresponds to a reader.

Parameters:

id - ID to validate

Returns:

true if the ID belongs to a reader; false otherwiase

Throws:

LibraryException - if a data access error occurs looking up the ID

isUserIDValid

public boolean isUserIDValid(String UID)
                      throws LibraryException

Determines whether or not the given UID (user id) belongs to a reader.

Parameters:

id - UID to validate

Returns:

true if the UID belongs to a reader; false otherwise

Throws:

LibraryException - if a data access error occurs looking up the UID

readerExists

public boolean readerExists(String firstName,
                            String lastName)
                     throws LibraryException

Determines whether or not there is a reader with the given first and last name.

Parameters:

firstName - first name

lastName - last name

Returns:

true if there is a reader with the given first and last name; false otherwise

Throws:

LibraryException - if a data access error occurs

readerExists

public boolean readerExists(long id)
                     throws LibraryException

Determines whether or not there is a reader with the given ID.

Parameters:

id - the ID to validate

Returns:

true if there is a reader with the given ID; false otherwise

Throws:

LibraryException - if a data access error occurs

deskPhoneExists

public boolean deskPhoneExists(String deskPhone)
                        throws LibraryException

Determines whether or not there is a reader with the given desk phone.

Parameters:

deskPhone - the phone number to validate

Returns:

true if there is a reader with the given desk phone; false otherwise

Throws:

LibraryException - if a data access error occurs

getReaders

public ArrayList<Reader> getReaders()
                             throws LibraryException

Returns an ArrayList of Reader instances including all currently registered Virtual Library readers.

Returns:

all readers in the database

Throws:

LibraryException - if a data access error occurs

retrieveTransaction

public LibraryTransaction retrieveTransaction(long id)
                                       throws LibraryException

Returns the LibraryTransaction with the given transaction id.

Parameters:

id - the ID of the transaction to retrieve

Throws:

LibraryException - if a data access error occurs retrieving the transaction

authorSearch

public ArrayList<Book> authorSearch(String authorLastName)
                             throws LibraryException

Returns a list including all {org.sourceforge.vlibrary.user.domain.Author}s with the the given last name.

Parameters:

authorLastName - the last name to look up

Returns:

list of author instances

Throws:

LibraryException - if a data access error occurs

subjectOrSearch

public ArrayList<Book> subjectOrSearch(ArrayList<Subject> subjects)
                                throws LibraryException

Returns an ArrayList of Book instances consisting of all books associated with one or more of the Subjects in the input array.

Parameters:

subjects - list of subjects

Returns:

list of associated books

Throws:

LibraryException - if a data access error occurs

subjectAndSearch

public ArrayList<Book> subjectAndSearch(ArrayList subjects)
                                 throws LibraryException

Returns an ArrayList of Book instances consisting of all books that are associated with all of the Subjects in the input array.

Parameters:

subjects - list of subjects

Returns:

list of associated books

Throws:

LibraryException - if a data access error occurs

ownerSearch

public ArrayList<Book> ownerSearch(long owner)
                            throws LibraryException

Returns an ArrayList of Book instances consisting of all books that are owned by the reader with the given ID.

Parameters:

owner - ID of owner

Returns:

list of books owned

Throws:

LibraryException - if a data access error occurs

titleSearch

public ArrayList<Book> titleSearch(String title)
                            throws LibraryException

Returns an ArrayList of Book instances consisting of all books having the given title.

Parameters:

title - title to look for

Returns:

list of books with the given title

Throws:

LibraryException - if a data access error occurs

dump

public ArrayList<Book> dump()
                     throws LibraryException

Returns an ArrayList of Book instances consisting of all books in the library.

Returns:

list of all books

Throws:

LibraryException - if a data access error occurs

retrieveByUid

public Reader retrieveByUid(String uid)
                     throws LibraryException

Retrieves a Reader by user id (UID).

Returns null if the supplied uid is not associated with a reader in the datablase.

Parameters:

uid - the UID of the reader to lookup

Returns:

the reader with the given uid; or null if there is no such reader

Throws:

LibraryException - if a data access error occurs

getAuthors

public ArrayList<Author> getAuthors(Book book)
                             throws LibraryException

Returns an ArrayList of Author} instances including the authors of the given book.

Parameters:

book - the book

Returns:

list of authors of the book

Throws:

LibraryException - if a data access error occurs

getSubjects

public ArrayList<Subject> getSubjects(Book book)
                               throws LibraryException

Returns an ArrayList including all subjects currently defined in the Virtual Library.

Returns:

list of currently defined subjects

Throws:

LibraryException - if an error occurs retrieving the list of subjects

processExchange

public BookMoveTransaction processExchange(long reader,
                                           long book,
                                           String transactionType,
                                           long location)
                                    throws LibraryException

Processes a book checkin or checkout transaction. Records the transaction in the transaction table and sends appropriate email notifications. Returns a BookMoveTransaction representing the transaction.

Delegates to one of #processCheckin(long, long) or #processCheckout(long, long), depending on the transactionType, which must be either Contants.CHECKIN or Contants.CHECKOUT.

Parameters:

reader - the id of the reader initiating the transaction

book - the id of the book being checked in or out

transactionType - transaction type - must be either Contants.CHECKIN or Contants.CHECKOUT

location - the location of the checkin or checkout

Returns:

the resulting transaction

Throws:

LibraryException - if an error occurs processing the transaction, or if the parameters are not valid

bookExists

public boolean bookExists(long book)
                   throws LibraryException

Determines whether or not there is a book with the given id.

Parameters:

book - id to check

Returns:

true if there is a book with the given id; false otherwise

Throws:

LibraryException

getReaderID

public long getReaderID(String firstName,
                        String lastName)
                 throws LibraryException

Returns the ID of a reader with the given first and last name, if there is such a reader, throwing LibraryException if there is no reader with the given name.

Does not check for uniqueness - i.e., if there is more than one reader with the given first and last name, no exception is generated.

Parameters:

firstName - the first name of the reader

lastName - the last name of the reader

Returns:

the ID of a reader with the given name

Throws:

LibraryException - if no such reader exists or a data access error occurs looking up the reader

createAuthorIds

public void createAuthorIds(ArrayList<Author> authors)
                     throws LibraryException

Walks input ArrayList, looking up and setting ID properties for each Author in the list. Lookup is based on first name + last name. If an Author is not found, a new entry is inserted into the database and the ID of the newly created record is assigned to the instance.

Parameters:

authors - = ArrayList of Authors

Throws:

LibraryException

retrieveBook

public Book retrieveBook(long bookID)
                  throws LibraryException

Returns the book with the given ID, or null if there is no such book.

Parameters:

bookID - the ID of the book

Returns:

the Book instance with the given ID

Throws:

LibraryException - if a data access error occurs

retrieveReader

public Reader retrieveReader(long id)
                      throws LibraryException

Returns a fully populated Reader corresponding to the reader having the given ID. Returns null if there is no such reader.

Parameters:

id - the ID to lookup

Returns:

fully populated Reader instance

Throws:

LibraryException - f a data access error occurs

createBookAuthors

public void createBookAuthors(Book book,
                              ArrayList<Author> authors)
                       throws LibraryException

Sets the authors for the given book. Creates author records in the database for any authors that do not exist and associates the given list of authors with the book. Updates IDs of authors in the list to match database entries for those that already exist in the database.

Parameters:

book - the book to attach authors to

authors - the authors of the book

Throws:

LibraryException - if an error occurs accessing the database or the ID of the given Book does not correspond to a book in the database

createBookSubjects

public void createBookSubjects(Book book,
                               ArrayList<Subject> subjects)
                        throws LibraryException

Sets the subjects for the given book. Creates subject records in the database for any authors that do not exist and associates the given list of authors with the book. Updates IDs of authors in the list to match database entries for those that already exist in the database.

Parameters:

book - the book to attach subjects to

subjects - the subjects of the book

Throws:

LibraryException - if an error occurs accessing the database or the ID of the given Book does not correspond to a book in the database

createBook

public Book createBook(Book book,
                       ArrayList<Subject> subjects,
                       ArrayList<Author> authors)
                throws LibraryException

Creates a book in the database and associates the given lists of subjects and authors with the book. Authors and subjects are created in the database if they do not already exist. Returns a new Book instance with the ID set to the database ID of the newly created book.

The supplied book must have minimally a title and isbn, otherwise a LibraryException is thrown.

Parameters:

book - the book to create

subjects - the subjects to associate with the book

authors - the authors of the book

Returns:

a Book instance with the ID of the newly created book

Throws:

LibraryException - if the supplied book does not have sufficient data or a database access error occurs

updateBook

public void updateBook(Book book)
                throws LibraryException

Updates the database record associated with book with the properties that the given instance has. Uses the ID property to locate the record to update. If the ID does not correspond to a book in the database, a LibraryException is thrown.

Parameters:

book - the book to update

Throws:

LibraryException - if the book does not exist, or a data access error occurs

insertReader

public void insertReader(Reader reader)
                  throws LibraryException

Inserts a record corresponding to the given reader into the database.

Ignores the ID field on input, but sets this field to the value of the database ID of the newly created reader.

Throws LibraryException if the reader is missing first name, last name, email or desk phone properties; or if the email or desk phone already exist in the database.

Parameters:

reader - the reader to add

Throws:

LibraryException - if the reader is a duplicate, is missing data, or a data access error occurs

updateReader

public void updateReader(Reader reader)
                  throws LibraryException

Updates the database record associated with reader with the properties that the given instance has. Uses the ID property to locate the record to update. If the ID does not correspond to a reader in the database, a LibraryException is thrown.

Parameters:

reader - the reader to update

Throws:

LibraryException - if the reader does not exist, or a data access error occurs

processCheckin

public void processCheckin(long reader,
                           long book,
                           long location)
                    throws LibraryException

Processes book checkin transaction.

Records the checkin in the transaction table and sends email notifications to current requesters.

Allows redundant checkins - i.e., a book that is already checked in can be checked in again.

Parameters:

book - the id of the book being checked in

reader - the id of the reader checking in the book

location - the id of the location of the transaction

Throws:

LibraryException - if an error occurs recording the checkin or sending notifications

processCheckout

public void processCheckout(long reader,
                            long book,
                            long location)
                     throws LibraryException

Processes book checkout transaction.

Records the checkout in the transaction table and sends email notifications to current requesters.

Parameters:

book - the id of the book being checked out

reader - the id of the reader checking out the book

location - the id of the location of the transaction

Throws:

LibraryException - if an error occurs recording the checkout or sending notifications

getPossessor

public long getPossessor(long book)
                  throws LibraryException

Queries the transaction table to determine the whereabouts of a book. Returns the id of the reader who is currently holding the book. If the book is "checked in", returns CHECKED_IN.

If there are no transactions associated with the book, then the book's owner is assumed to have the book, so the owner's ID is returned in this case.

Parameters:

book - the id of the book being sought

Throws:

LibraryException - will be thrown if the book does not exist or a data access error occurs

processRequest

public void processRequest(long reader,
                           long book,
                           long location)
                    throws Exception

Processes book request transaction. Records request(s) in transaction table, sends email notification to possessors and confirmation email to requester.

The algorithm works as follows: First, we get a list of all copies of the given book whose last known location is the given location. If there are no such copies, BookNotFoundAtLocationException is thrown. If the reader has a pending request for one of these copies, DuplicateRequestException is thrown. If any are checked in, BookAwaitingPickupException is thrown. Otherwise, a request is created for each of the copies and the current possessor of each is notified.

Parameters:

book - the id of the book being requested

reader - the id of the reader making the request

location - the location where the book is being requested

Throws:

LibraryException - if an error occurs processing the transaction

DuplicateRequestException - if the requester already has a request pending for the book

ReaderNotFoundException - if the reader is not found

Exception

requestPending

public boolean requestPending(long reader,
                              long book)
                       throws LibraryException

Determines whether or not a reader has a request pending for a book.

Parameters:

reader - the ID of the reader

book - the ID of the book

Returns:

true if the reader with ID reader has a request pending for the book with ID book; false otherwise

Throws:

LibraryException - if a data access error occurs

cancelRequest

public void cancelRequest(long reader,
                          long book)
                   throws LibraryException

Cancels a pending request for a book and sends confirmation email to the reader canceling the request.

Parameters:

reader - the ID of the reader canceling the request

book - the ID of the book

Throws:

LibraryException - if the reader or book does not exist, or if there is an error canceling the request

getTransactions

public List<LibraryTransaction> getTransactions(long book)
                                         throws LibraryException

Gets the entire transaction history for a book and returns an ArrayList of LibraryTransaction instances.

Parameters:

book - id of the book to retrieve transactions for

Throws:

LibraryException - if a data access error occurs

resetPassword

public void resetPassword(String user,
                          String newPwd)
                   throws LibraryException

Resets a user's password.

Fails silently if the user does not exist.

Parameters:

user - UID of the user

newPwd - new password

Throws:

LibraryException - if an error occurs resetting the password

forgotPassword

public void forgotPassword(String uid,
                           String email)
                    throws LibraryException

Validates that uid exists and has email as email address of record, then resets the associated password to a randomly generated string and sends the reader an email with the new password.

Parameters:

uid - UID to reset password for

email - = email address - for confirmation and message target

Throws:

LibraryException - if the uid is not found or if an error occurs resetting the password or sending the notification

lookupBook

public Map lookupBook(String isbn)
               throws LibraryException

Looks up the book indicated by the ISBN with SRU/SRW provider, returning a Map of key-value pairs expressing attributes of the book. The map has the following keys:

         Constants.BOOKTITLE
         Constants.BOOKSUBJECTSLIST
         Constants.BOOKAUTHOR
         Constants.BOOKPUBLISHER
         Constants.BOOKDATE
 

All keys are mapped to String values, except Constants.BOOKSUBJECTSLIST which maps to a List of Strings.

Parameters:

isbn - ISBN of the book

Returns:

Map of key-value pairs describing the book

Throws:

LibraryException - if the isbn is not found or if an error occurs