org.sourceforge.vlibrary.user.dao

Class BookDAO

java.lang.Object

org.sourceforge.vlibrary.user.dao.BookDAO

public class BookDAO
extends Object

Book DAO.

Version:

$Revision$ $Date$

Constructor Summary

Constructors

Constructor and Description
BookDAO() Create a BookDAO.

Method Summary

Modifier and Type	Method and Description
void	addAuthor(Book book, Author author) Adds author to the authors of book.
void	addSubject(Book book, Subject subject) Adds subject to the subjects associated with book.
ArrayList<Book>	authorSearch(String authorLastName) Returns a list of Book instances whose author lists contain an author with the given last name.
boolean	bookExists(long book) Determines whether or not the ID provided corresponds to a book in the library.
int	countCopies(String isbn) Counts the number of copies of the book, checked in or out, any location.
ArrayList	dump() Returns a list of all books in the library.
ArrayList<Author>	getAuthors(Book book) Returns an ArrayList consisting of the authors of the given book.
String	getIsbn(long bookID) Gets the ISBN of the book with the given ID if there is such a book, null otherwise.
ArrayList<Subject>	getSubjects(Book book) Returns an ArrayList consisting of the subject classifications associated with the the given book.
Book	insert(Book book) Inserts a book into the database and returns the result of retrieving the inserted book.
ArrayList	ownerSearch(long owner) Returns a list of books owned by the reader with the given ID.
Book	retrieve(long bookID) Retrieves the book with the given ID, if there is such a book; otherwise Null.
Book	retrieve(String bookID) Retrieves the book having the ID represented by the input string, if there is such a book; otherwise Null.
Book	retrieveByGenericCriteria(String sqlString, Object[] criteria) Retrieve Book by unique criteria from the database.
Book	retrieveByIsbn(String isbn) Retrieves the book having the given ISBN, there is such a book; otherwise Null.
void	setAuthorDAO(AuthorDAO authorDAO) Used for Spring Dependency Injection
void	setAuthors(Book book, ArrayList<Author> authors) Sets the list of authors associated with the given book.
void	setCountCopiesSQL(String countCopiesSQL) Used for Spring Dependency Injection
void	setInsertBookAuthorSQL(String insertBookAuthorSQL) Used for Spring Dependency Injection
void	setInsertBookSQL(String insertBookSQL) Used for Spring Dependency Injection
void	setInsertSubjectBookSQL(String insertSubjectBookSQL) Used for Spring Dependency Injection
void	setJdbcTemplate(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate) Used for Spring Dependency Injection
void	setResourceBundleMessageSource(org.springframework.context.support.ResourceBundleMessageSource resourceBundleMessageSource) Used for Spring Dependency Injection
void	setSelectAllBooksSQL(String selectAllBooksSQL) Used for Spring Dependency Injection
void	setSelectAuthorsByBookIdSQL(String selectAuthorsByBookIdSQL) Used for Spring Dependency Injection
void	setSelectBookAuthorByBookIdAuthoridSQL(String selectBookAuthorByBookIdAuthoridSQL) Used for Spring Dependency Injection
void	setSelectBookByAuthorSQL(String selectBookByAuthorSQL) Used for Spring Dependency Injection
void	setSelectBookByIdSQL(String selectBookByIdSQL) Used for Spring Dependency Injection
void	setSelectBookByISBNSQL(String selectBookByISBNSQL) Used for Spring Dependency Injection
void	setSelectBookByOwnerSQL(String selectBookByOwnerSQL) Used for Spring Dependency Injection
void	setSelectBookByTitleSQL(String selectBookByTitleSQL) Used for Spring Dependency Injection
void	setSelectSubjectAndSearchOrderBySQL(String selectSubjectAndSearchOrderBySQL) Used for Spring Dependency Injection
void	setSelectSubjectAndSearchSelectSQL(String selectSubjectAndSearchSelectSQL) Used for Spring Dependency Injection
void	setSelectSubjectAndSearchWhereSQL(String selectSubjectAndSearchWhereSQL) Used for Spring Dependency Injection
void	setSelectSubjectBySubjectIdBookIdSQL(String selectSubjectBySubjectIdBookIdSQL) Used for Spring Dependency Injection
void	setSelectSubjectOrSearchMainSQL(String selectSubjectOrSearchMainSQL) Used for Spring Dependency Injection
void	setSelectSubjectOrSearchOrderBySQL(String selectSubjectOrSearchOrderBySQL) Used for Spring Dependency Injection
void	setSelectSubjectsByBookIdSQL(String selectSubjectsByBookIdSQL) Used for Spring Dependency Injection
void	setSubjectDAO(SubjectDAO subjectDAO) Used for Spring Dependency Injection
void	setSubjects(Book book, ArrayList<Subject> subjects) Sets the list of subjects associated with the given book.
void	setUpdateBookSQL(String updateBookSQL) Used for Spring Dependency Injection
ArrayList<Book>	subjectAndSearch(ArrayList subjects) Returns a list of Book instances association with all of the subjects in the input subjects array.
ArrayList<Book>	subjectOrSearch(ArrayList<Subject> subjects) Returns a list of Book instances association with all of the subjects in the input subjects array.
ArrayList	titleSearch(String title) Returns a list of books with the given title.
void	update(Book book) Updates book in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

BookDAO

public BookDAO()

Create a BookDAO.

Method Detail

setJdbcTemplate

public void setJdbcTemplate(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate)

Used for Spring Dependency Injection

Parameters:

jdbcTemplate - The jdbcTemplate to set.

setResourceBundleMessageSource

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

Used for Spring Dependency Injection

setSelectSubjectAndSearchSelectSQL

public void setSelectSubjectAndSearchSelectSQL(String selectSubjectAndSearchSelectSQL)

Used for Spring Dependency Injection

setSelectSubjectAndSearchWhereSQL

public void setSelectSubjectAndSearchWhereSQL(String selectSubjectAndSearchWhereSQL)

Used for Spring Dependency Injection

setSelectSubjectAndSearchOrderBySQL

public void setSelectSubjectAndSearchOrderBySQL(String selectSubjectAndSearchOrderBySQL)

Used for Spring Dependency Injection

setInsertBookSQL

public void setInsertBookSQL(String insertBookSQL)

Used for Spring Dependency Injection

setSelectSubjectOrSearchMainSQL

public void setSelectSubjectOrSearchMainSQL(String selectSubjectOrSearchMainSQL)

Used for Spring Dependency Injection

setSelectSubjectOrSearchOrderBySQL

public void setSelectSubjectOrSearchOrderBySQL(String selectSubjectOrSearchOrderBySQL)

Used for Spring Dependency Injection

setSelectBookByISBNSQL

public void setSelectBookByISBNSQL(String selectBookByISBNSQL)

Used for Spring Dependency Injection

setCountCopiesSQL

public void setCountCopiesSQL(String countCopiesSQL)

Used for Spring Dependency Injection

setSelectBookByIdSQL

public void setSelectBookByIdSQL(String selectBookByIdSQL)

Used for Spring Dependency Injection

setUpdateBookSQL

public void setUpdateBookSQL(String updateBookSQL)

Used for Spring Dependency Injection

setSelectBookAuthorByBookIdAuthoridSQL

public void setSelectBookAuthorByBookIdAuthoridSQL(String selectBookAuthorByBookIdAuthoridSQL)

Used for Spring Dependency Injection

setInsertBookAuthorSQL

public void setInsertBookAuthorSQL(String insertBookAuthorSQL)

Used for Spring Dependency Injection

setSelectAuthorsByBookIdSQL

public void setSelectAuthorsByBookIdSQL(String selectAuthorsByBookIdSQL)

Used for Spring Dependency Injection

setSelectSubjectBySubjectIdBookIdSQL

public void setSelectSubjectBySubjectIdBookIdSQL(String selectSubjectBySubjectIdBookIdSQL)

Used for Spring Dependency Injection

setInsertSubjectBookSQL

public void setInsertSubjectBookSQL(String insertSubjectBookSQL)

Used for Spring Dependency Injection

setSelectSubjectsByBookIdSQL

public void setSelectSubjectsByBookIdSQL(String selectSubjectsByBookIdSQL)

Used for Spring Dependency Injection

setSelectAllBooksSQL

public void setSelectAllBooksSQL(String selectAllBooksSQL)

Used for Spring Dependency Injection

setSelectBookByTitleSQL

public void setSelectBookByTitleSQL(String selectBookByTitleSQL)

Used for Spring Dependency Injection

setSelectBookByOwnerSQL

public void setSelectBookByOwnerSQL(String selectBookByOwnerSQL)

Used for Spring Dependency Injection

setSelectBookByAuthorSQL

public void setSelectBookByAuthorSQL(String selectBookByAuthorSQL)

Used for Spring Dependency Injection

setAuthorDAO

public void setAuthorDAO(AuthorDAO authorDAO)

Used for Spring Dependency Injection

setSubjectDAO

public void setSubjectDAO(SubjectDAO subjectDAO)

Used for Spring Dependency Injection

insert

public Book insert(Book book)
            throws LibraryException

Inserts a book into the database and returns the result of retrieving the inserted book. The returned book instance therefore has the ID of the newly generated record in the database. The ID field in the book passed in as actual parameter is ignored.

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

NB: this method does NOT set subjects or authors

Throws:

LibraryException - if an error occurs

update

public void update(Book book)
            throws LibraryException

Updates book in the database. Assumes that all required fields are set, including id, which is used to locate the record to update.

NB: this method does NOT set subjects or authors.

Throws:

LibraryException

retrieveByGenericCriteria

public Book retrieveByGenericCriteria(String sqlString,
                                      Object[] criteria)
                               throws LibraryException

Retrieve Book by unique criteria from the database. If there is more than one book satisfying the query, the first record in the resultset is used to populate the book record.

Parameters:

sqlString - SQL String to be used for the specific criteria Object

criteria - Unique criteria to search the reader from, such as id, isbn

Returns:

Book Fully populated Book object, or NULL if a record matching criteria could not be located in the DB

Throws:

LibraryException

getIsbn

public String getIsbn(long bookID)
               throws LibraryException

Gets the ISBN of the book with the given ID if there is such a book, null otherwise.

Parameters:

bookID - ID of book

Returns:

ISBN of the book with the given ID

Throws:

LibraryException - if an error occurs searching for the book

retrieve

public Book retrieve(long bookID)
              throws LibraryException

Retrieves the book with the given ID, if there is such a book; otherwise Null.

Parameters:

bookID - ID to lookup

Returns:

book with the given ID

Throws:

LibraryException

retrieve

public Book retrieve(String bookID)
              throws LibraryException

Retrieves the book having the ID represented by the input string, if there is such a book; otherwise Null.

Parameters:

bookID - string ID

Returns:

book with the given ID

Throws:

LibraryException

retrieveByIsbn

public Book retrieveByIsbn(String isbn)
                    throws LibraryException

Retrieves the book having the given ISBN, there is such a book; otherwise Null.

Parameters:

bookID - string ID

Returns:

book with the given ID

Throws:

LibraryException

countCopies

public int countCopies(String isbn)
                throws LibraryException

Counts the number of copies of the book, checked in or out, any location.

Parameters:

isbn - ISBN of the book

Returns:

the total number of copies that have been added of the given book.

Throws:

LibraryException

addAuthor

public void addAuthor(Book book,
                      Author author)
               throws LibraryException

Adds author to the authors of book. Will create a record for author if no author with the given name exists yet. Requires that book exist already in the database and that the book ID is set.

Parameters:

author - Author to add

book - book to associate author with

Throws:

LibraryException

getAuthors

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

Returns an ArrayList consisting of the authors of the given book. Assumes that book.id is set. Returns an empty list if there are no authors associated with the given book.

Throws:

LibraryException

addSubject

public void addSubject(Book book,
                       Subject subject)
                throws LibraryException

Adds subject to the subjects associated with book. Will create a record for subject if no subject with the given description exists yet. Requires that book exist already in the database and that the book ID is set.

Parameters:

subject - Subject to add

book - book to associate subject with

Throws:

LibraryException

getSubjects

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

Returns an ArrayList consisting of the subject classifications associated with the the given book. Assumes that book.id is set. Returns an empty list if there are no subjects associated with the given book.

Throws:

LibraryException

setAuthors

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

Sets the list of authors associated with the given book. The book must exist in the database, but authors will be created if necessary. This method is equivalent to repeated application of addAuthor(Book, Author) for each Author instance in the authors list.

Parameters:

authors - Author instances to associate with the book

book - book to set authors for

Throws:

LibraryException

setSubjects

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

Sets the list of subjects associated with the given book. The book must exist in the database, but subjects will be created if necessary. This method is equivalent to repeated application of addSubject(Book, Subject) for each Subject instance in the subjects list.

Parameters:

subjects - Subject instances to associate with the book

book - book to set subjects for

Throws:

LibraryException

dump

public ArrayList dump()
               throws LibraryException

Returns a list of all books in the library.

Returns:

list of all books

Throws:

LibraryException

titleSearch

public ArrayList titleSearch(String title)
                      throws LibraryException

Returns a list of books with the given title. Returns an empty list if there are no books with the given title.

Parameters:

title - title to search

Returns:

list of books with the given title

Throws:

LibraryException

ownerSearch

public ArrayList ownerSearch(long owner)
                      throws LibraryException

Returns a list of books owned by the reader with the given ID. Returns an empty list if the ID belongs to a reader who does not own any books, or is not a valid ID.

Parameters:

owner - ID of owner

Returns:

list of books owned

Throws:

LibraryException

subjectAndSearch

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

Returns a list of Book instances association with all of the subjects in the input subjects array. The list returned is the intersection of the books associated with each of the individual subjects. A book must be associated with every subject in the list to be included in the returned list.

Parameters:

subjects - list of subjects to seach on

Returns:

list of books associated with each of the subjects in the list

Throws:

LibraryException

subjectOrSearch

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

Returns a list of Book instances association with all of the subjects in the input subjects array. The list returned is the intersection of the books associated with each of the individual subjects. A book must be associated with every subject in the list to be included in the returned list.

Parameters:

subjects - list of subjects to seach on

Returns:

list of books associated with each of the subjects in the list

Throws:

LibraryException

authorSearch

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

Returns a list of Book instances whose author lists contain an author with the given last name. Returns an empty list if there are no such books.

Parameters:

authorLastName - last name of author to search

Returns:

list of books written by authors with the given last name

Throws:

LibraryException

bookExists

public boolean bookExists(long book)
                   throws LibraryException

Determines whether or not the ID provided corresponds to a book in the library.

Parameters:

book - ID to validate

Returns:

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

Throws:

LibraryException