[jsword-svn] r1698 - trunk/jsword/src/main/java/org/crosswire/jsword/book

[dmsmith at www.crosswire.org]

Author: dmsmith
Date: 2007-10-09 12:06:36 -0700 (Tue, 09 Oct 2007)
New Revision: 1698

Added:
   trunk/jsword/src/main/java/org/crosswire/jsword/book/Bookmark.java
Log:
Start of implementation of Bookmarks.

Added: trunk/jsword/src/main/java/org/crosswire/jsword/book/Bookmark.java
===================================================================
--- trunk/jsword/src/main/java/org/crosswire/jsword/book/Bookmark.java	                        (rev 0)
+++ trunk/jsword/src/main/java/org/crosswire/jsword/book/Bookmark.java	2007-10-09 19:06:36 UTC (rev 1698)
@@ -0,0 +1,91 @@
+/**
+ * Distribution License:
+ * JSword is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License, version 2.1 as published by
+ * the Free Software Foundation. This program 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 Lesser General Public License for more details.
+ *
+ * The License is available on the internet at:
+ *       http://www.gnu.org/copyleft/lgpl.html
+ * or by writing to:
+ *      Free Software Foundation, Inc.
+ *      59 Temple Place - Suite 330
+ *      Boston, MA 02111-1307, USA
+ *
+ * Copyright: 2007
+ *     The copyright to this program is held by it's authors.
+ *
+ * ID: $Id: Bookmark.java 1605 2007-08-03 21:34:46Z dmsmith $
+ */
+package org.crosswire.jsword.book;
+
+import java.io.Serializable;
+import java.util.List;
+
+import org.crosswire.jsword.index.search.SearchRequest;
+
+/**
+ * A Bookmark remembers a particular view of one or more Books.
+ * What is viewed regarding a book set is either a SearchRequest
+ * or a key lookup request.
+ *
+ * @see gnu.gpl.License for license details.
+ *      The copyright to this program is held by it's authors.
+ * @author DM Smith [dmsmith555 at yahoo dot com]
+ */
+public interface Bookmark extends Serializable
+{
+    /**
+     * Add a Book to this Bookmark.
+     * The books are maintained in the order they are added as a set.
+     * 
+     * @param book the Book to add.
+     */
+    void addBook(Book book);
+
+    /**
+     * Return the ordered set of books.
+     * @return
+     */
+    List getBooks();
+
+    /**
+     * Set the SearchRequest for this Bookmark. A copy of the SearchRequest will be stored.
+     * Note, setting this will clear the lookup request, if any.
+     * 
+     * @param request the SearchRequest
+     */
+    void setSearchRequest(SearchRequest request);
+
+    /**
+     * Get the SearchRequest for this Bookmark.
+     * 
+     * @return a copy of the SearchRequest, or null.
+     */
+    SearchRequest getSearchRequest();
+
+    /**
+     * Set the lookup request for this Bookmark.
+     * Note, setting this will clear the SearchRequest, if any.
+     * 
+     * @param request the lookup request.
+     */
+    void setLookupRequest(String request);
+
+    /**
+     * Get the lookup request.
+     * 
+     * @return the lookup request or null.
+     */
+    String getLookupRequest();
+
+    /**
+     * Convert this Bookmark into a BookData by converting the SearchReqeust or lookup request
+     * into a key list.
+     * 
+     * @return the resulting BookData
+     */
+    BookData getBookData();
+}