path: root/src/com/joshwalters/bookcatalog/isbnlookup/ISBNLookup.java

/*
 *      Book Catalog - Catalog your book collection.
 *      
 *      Copyright (C) 2009 Joshua Walters
 *      URL: http://joshwalters.com
 *      
 *      This file is part of Book Catalog.
 *      
 *      Book Catalog is free software: you can redistribute it and/or modify
 *      it under the terms of the GNU General Public License as published by
 *      the Free Software Foundation, either version 3 of the License, or
 *      (at your option) any later version.
 *      
 *      Book Catalog is distributed in the hope that it will be useful,
 *      but WITHOUT ANY WARRANTY; without even the implied warranty of
 *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *      GNU General Public License for more details.
 *      
 *      You should have received a copy of the GNU General Public License
 *      along with Book Catalog.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.joshwalters.bookcatalog.isbnlookup;

import java.util.regex.Pattern;

/**
 * Abstract class for performing an ISBN lookup for a book.
 * 
 * @author Josh Walters
 */
public abstract class ISBNLookup {

	/**
	 * The title of the book.
	 */
	protected String title;
	/**
	 * The author of the book.
	 */
	protected String author;
	/**
	 * The publisher of the book.
	 */
	protected String publisher;
	/**
	 * The date the book was published.
	 */
	protected String date;
	/**
	 * The description of the book.
	 */
	protected String description;
	/**
	 * The subject of the book.
	 */
	protected String subject;
	/**
	 * The books ISBN number.
	 */
	protected String ISBN;
	/**
	 * The price of the book.
	 */
	protected String price;

	/**
	 * Purifies the input barcode to make it suitable for use in lookup. Also
	 * grabs the price from the barcode if it is present.
	 * 
	 * @param barcode
	 * @return A purified barcode.
	 * @throws InvalidSearchTerms
	 */
	protected String purifyBarcode(String barcode) throws InvalidSearchTerms {
		// Remove the extra characters that some scanners include
		barcode = removeCharInString(barcode, ' ');
		barcode = removeCharInString(barcode, '-');
		// Check to see if the barcode is made up of numbers.
		if (!Pattern.matches("^\\d*$", barcode)) {
			throw new InvalidSearchTerms();
		}
		// Check to see that the barcode is at least 4 digits long.
		if (barcode.length() < 4) {
			throw new InvalidSearchTerms();
		}
		// ISBN-13
		if (barcode.substring(0, 3).compareTo("978") == 0
				|| barcode.substring(0, 3).compareTo("979") == 0) {
			if (barcode.length() == 15) {
				barcode = barcode.substring(0, 13);
			}
			if (barcode.length() == 18) {
				price = barcode.substring(13);
				barcode = barcode.substring(0, 13);
			}
		}
		// ISBN-10
		else {
			if (barcode.length() == 12) {
				barcode = barcode.substring(0, 10);
			}
			if (barcode.length() == 15) {
				price = barcode.substring(10);
				barcode = barcode.substring(0, 10);
			}
		}
		if (price != null) {
			// Format price information
			if (price.charAt(1) == '0') {
				price = price.substring(2);
				price = "$" + price.substring(0, 1) + "." + price.substring(1);
			} else {
				price = price.substring(1);
				price = "$" + price.substring(0, 2) + "." + price.substring(2);
			}
		}
		// Check to make sure that this is the proper length for an ISBN number.
		if (barcode.length() != 10 & barcode.length() != 13) {
			throw new InvalidSearchTerms();
		}
		return barcode;
	}

	/**
	 * Clear out all the data fields.
	 */
	protected void emptyDataFields() {
		title = null;
		author = null;
		publisher = null;
		date = null;
		description = null;
		subject = null;
		ISBN = null;
		price = null;
		return;
	}

	/**
	 * Removes character from string.
	 * 
	 * @param s
	 * @param c
	 * @return The new string.
	 */
	private String removeCharInString(String s, char c) {
		String result = "";
		for (int i = 0; i < s.length(); i++) {
			if (s.charAt(i) != c) {
				result += s.charAt(i);
			}
		}
		return result;
	}

	/**
	 * Searches for a book.
	 * 
	 * @param barcode
	 * @throws NoBookFound
	 * @throws InvalidSearchTerms
	 */
	public abstract void searchBooks(String barcode) throws NoBookFound,
			InvalidSearchTerms;

	/**
	 * @return the title
	 */
	public String getTitle() {
		return title;
	}

	/**
	 * @param title
	 *            the title to set
	 */
	public void setTitle(String title) {
		this.title = title;
	}

	/**
	 * @return the author
	 */
	public String getAuthor() {
		return author;
	}

	/**
	 * @param author
	 *            the author to set
	 */
	public void setAuthor(String author) {
		this.author = author;
	}

	/**
	 * @return the publisher
	 */
	public String getPublisher() {
		return publisher;
	}

	/**
	 * @param publisher
	 *            the publisher to set
	 */
	public void setPublisher(String publisher) {
		this.publisher = publisher;
	}

	/**
	 * @return the date
	 */
	public String getDate() {
		return date;
	}

	/**
	 * @param date
	 *            the date to set
	 */
	public void setDate(String date) {
		this.date = date;
	}

	/**
	 * @return the description
	 */
	public String getDescription() {
		return description;
	}

	/**
	 * @param description
	 *            the description to set
	 */
	public void setDescription(String description) {
		this.description = description;
	}

	/**
	 * @return the subject
	 */
	public String getSubject() {
		return subject;
	}

	/**
	 * @param subject
	 *            the subject to set
	 */
	public void setSubject(String subject) {
		this.subject = subject;
	}

	/**
	 * @return the ISBN
	 */
	public String getISBN() {
		return ISBN;
	}

	/**
	 * @param ISBN
	 *            the ISBN to set
	 */
	public void setISBN(String ISBN) {
		this.ISBN = ISBN;
	}

	/**
	 * @return the price
	 */
	public String getPrice() {
		return price;
	}

	/**
	 * @param price
	 *            the price to set
	 */
	public void setPrice(String price) {
		this.price = price;
	}
}