Uses of Interface
org.crosswire.jsword.book.Book

Packages that use Book
org.crosswire.bibledesktop.book This package contains Swing MVC models to help implementing a Swing GUI using JSword classes. 
org.crosswire.bibledesktop.book.install An Install Manager for Books: Bibles, Commentaries and Dictionaries. 
org.crosswire.bibledesktop.desktop The swing section is in charge of turning the XML from the source section into a screen view. 
org.crosswire.bibledesktop.display This package contains the BookDataDisplay interface which is designed to allow GUI components to choose between the methods they use to display BookData objects. 
org.crosswire.bibledesktop.display.proxy This package contains an implementation of BookDataDisplay that proxies to another BookDataDisplay to make implementing nested BookDataDisplays easier. 
org.crosswire.bibledesktop.display.splitlist This package contains an implementation of BookDataDisplay that adds a side panel to a child implementation of BookDataDisplay. 
org.crosswire.bibledesktop.display.tab This package contains an implementation of BookDataDisplay (based on ProxyBookDataDisplay for simplicity) that adds scrollbars to a child implementation of BookDataDisplay. 
org.crosswire.bibledesktop.display.textpane This package contains an implementation of BookDataDisplay that displays the OSIS after transforming it to HTML (using XSL) in a Swing JTextPane. 
org.crosswire.bibledesktop.passage This package contains Swing MVC models to help implementing a Swing GUI using JSword classes. 
org.crosswire.jsword.book The Book package provides an interface to a real store of data. 
org.crosswire.jsword.book.basic The Basic package contains default and abstract implementations of the main Book classes. 
org.crosswire.jsword.book.filter This data package manages the filtering of book data returned by the various books. 
org.crosswire.jsword.book.filter.gbf A Filter that converts from GBF format data to OSIS format data. 
org.crosswire.jsword.book.filter.osis A Filter that loads OSIS format data into JDOM. 
org.crosswire.jsword.book.filter.plaintext A Filter that converts from plain text format data to OSIS format data. 
org.crosswire.jsword.book.filter.thml A Filter that converts from THML format data to OSIS format data. 
org.crosswire.jsword.book.install An abstraction of an installer. 
org.crosswire.jsword.book.install.sword An implementaiion of an installer that can handle Sword Books (Modules). 
org.crosswire.jsword.book.readings An implementation of BookDriver and Dictionary that read provide access to readings planners. 
org.crosswire.jsword.book.sword An implementation of the Book interfaces that reads from SWORD project books (modules). 
org.crosswire.jsword.examples Some examples of how to use the JSword API. 
org.crosswire.jsword.index Abstraction of an Index. 
org.crosswire.jsword.index.lucene An implemenation of SearchEngine using Lucene. 
org.crosswire.jsword.index.search This package helps implementors of the various Book interfaces implement search. 
org.crosswire.jsword.util This package contains general Project specific utilities. 
 

Uses of Book in org.crosswire.bibledesktop.book
 

Fields in org.crosswire.bibledesktop.book declared as Book
private  Book DisplaySelectEvent.book
          The new Book
private  Book MultiBookPane.book
           
protected  Book BooksComboBoxModel.current
          The currently selected version
private  Book DisplaySelectPane.selected
           
 

Methods in org.crosswire.bibledesktop.book that return Book
 Book DisplaySelectEvent.getBook()
          Get the type of command
 Book DisplaySelectPane.getBook()
          What is the currently selected Book?
 Book MultiBookPane.getBook()
           
 Book BooksComboBoxModel.getSelectedBook()
          Get the selected Bible
 

Methods in org.crosswire.bibledesktop.book with parameters of type Book
 void MultiBookPane.selectBook(Book selectedBook)
           
 void MultiBookPane.setBookData(Book book, Key key)
           
private  void BooksComboBoxModel.tryInitialSelection(Book book)
           
 

Constructors in org.crosswire.bibledesktop.book with parameters of type Book
DisplaySelectEvent(Object source, Key key, Book book)
          For when a command has been made
 

Uses of Book in org.crosswire.bibledesktop.book.install
 

Methods in org.crosswire.bibledesktop.book.install that return Book
private  Book SitePane.getBook(Object anObj)
           
 

Methods in org.crosswire.bibledesktop.book.install with parameters of type Book
static Icon BookIcon.getIcon(Book book)
           
static void IndexResolver.scheduleIndex(Book book, Component parent)
           
 void TextPaneBookMetaDataDisplay.setBook(Book book)
           
 

Uses of Book in org.crosswire.bibledesktop.desktop
 

Methods in org.crosswire.bibledesktop.desktop with parameters of type Book
private  void Desktop.jump(Book book, String data)
          Open the requested book and go to the requested key.
 

Constructors in org.crosswire.bibledesktop.desktop with parameters of type Book
ViewSourcePane(Book book, Key key)
           
 

Uses of Book in org.crosswire.bibledesktop.display
 

Methods in org.crosswire.bibledesktop.display that return Book
 Book BookDataDisplay.getBook()
          Accessor for the Book used in the current display, or null if we are not displaying anything.
 

Methods in org.crosswire.bibledesktop.display with parameters of type Book
 void BookDataDisplay.setBookData(Book book, Key key)
          Set the BookData to be displayed.
 

Uses of Book in org.crosswire.bibledesktop.display.proxy
 

Methods in org.crosswire.bibledesktop.display.proxy that return Book
 Book ProxyBookDataDisplay.getBook()
           
 

Methods in org.crosswire.bibledesktop.display.proxy with parameters of type Book
 void ProxyBookDataDisplay.setBookData(Book book, Key key)
           
 

Uses of Book in org.crosswire.bibledesktop.display.splitlist
 

Fields in org.crosswire.bibledesktop.display.splitlist declared as Book
private  Book SplitBookDataDisplay.book
          What book are we currently viewing?
 

Methods in org.crosswire.bibledesktop.display.splitlist that return Book
 Book SplitBookDataDisplay.getBook()
           
 

Methods in org.crosswire.bibledesktop.display.splitlist with parameters of type Book
 void SplitBookDataDisplay.setBookData(Book book, Key key)
           
 

Uses of Book in org.crosswire.bibledesktop.display.tab
 

Fields in org.crosswire.bibledesktop.display.tab declared as Book
private  Book TabbedBookDataDisplay.book
          The version used for display
 

Methods in org.crosswire.bibledesktop.display.tab that return Book
 Book TabbedBookDataDisplay.getBook()
           
 

Methods in org.crosswire.bibledesktop.display.tab with parameters of type Book
 void TabbedBookDataDisplay.setBookData(Book book, Key newkey)
           
 

Uses of Book in org.crosswire.bibledesktop.display.textpane
 

Fields in org.crosswire.bibledesktop.display.textpane declared as Book
private  Book TextPaneBookDataDisplay.book
          The current book
 

Methods in org.crosswire.bibledesktop.display.textpane that return Book
 Book TextPaneBookDataDisplay.getBook()
           
 

Methods in org.crosswire.bibledesktop.display.textpane with parameters of type Book
 void TextPaneBookDataDisplay.setBookData(Book book, Key key)
           
 

Uses of Book in org.crosswire.bibledesktop.passage
 

Fields in org.crosswire.bibledesktop.passage declared as Book
private  Book KeySidebar.book
          The book who's keys we are looking at
 

Constructors in org.crosswire.bibledesktop.passage with parameters of type Book
KeySidebar(Book book)
          Initialize the SplitBookDataDisplay
 

Uses of Book in org.crosswire.jsword.book
 

Fields in org.crosswire.jsword.book declared as Book
private  Book BookData.book
          Who created this data
private  Book BooksEvent.book
          The name of the changed Bible
private  Book DefaultBook.book
          The default book
private  Book BookFilterIterator.next
          The stored next value
 

Methods in org.crosswire.jsword.book that return Book
 Book BookDriver.create(Book source)
          Create a new Book based on a source.
private  Book BookFilterIterator.findNext()
          Find the next (if there is one)
static Book Defaults.getBible()
           
 Book BookData.getBook()
          Who created this data.
 Book BooksEvent.getBook()
          Get the name of the changed Book
 Book Books.getBook(String name)
           
 Book[] BookDriver.getBooks()
          This method should only be used by Bibles at startup to register the Bibles known at start time.
static Book Defaults.getCommentary()
           
static Book Defaults.getDailyDevotional()
           
 Book DefaultBook.getDefault()
          Get the current default book or null if there is none.
static Book Defaults.getDictionary()
           
static Book Defaults.getGreekDefinitions()
           
static Book Defaults.getGreekParse()
           
static Book Defaults.getHebrewDefinitions()
           
static Book Defaults.getHebrewParse()
           
 

Methods in org.crosswire.jsword.book with parameters of type Book
 void Books.addBook(Book book)
          Add a Bible to the current list of Books.
protected static void Defaults.checkPreferable(Book book)
          Determine whether this Book become the default.
 Book BookDriver.create(Book source)
          Create a new Book based on a source.
 void BookDriver.delete(Book dead)
          Delete this Book from the system.
protected  void Books.fireBooksChanged(Object source, Book book, boolean added)
          Kick of an event sequence
 boolean BookDriver.isDeletable(Book dead)
          Is this book able to be deleted.
 void Books.removeBook(Book book)
          Remove a Bible from the current list of Books.
static void Defaults.setBible(Book book)
           
static void Defaults.setCommentary(Book book)
           
static void Defaults.setCurrentBook(Book book)
          If the user has chosen to remember the book (by type) then set the current book for that type.
static void Defaults.setDailyDevotional(Book book)
           
 void DefaultBook.setDefault(Book newBook)
          Set the default Book.
 void DefaultBook.setDefaultConditionally(Book newBook)
          Set the default Book conditionally.
static void Defaults.setDictionary(Book book)
           
static void Defaults.setGreekDefinitions(Book book)
           
static void Defaults.setGreekParse(Book book)
           
static void Defaults.setHebrewDefinitions(Book book)
           
static void Defaults.setHebrewParse(Book book)
           
 boolean BookFilter.test(Book book)
          Does this given book pass the tests implemented by this filter
 boolean BookFilters.AllBookFilter.test(Book book)
           
 boolean BookFilters.BookCategoryFilter.test(Book book)
           
 boolean BookFilters.NotBookCategoryFilter.test(Book book)
           
 boolean BookFilters.BookFeatureFilter.test(Book book)
           
 boolean BookFilters.CustomBookFilter.test(Book book)
           
protected  void DefaultBook.unsetDefaultConditionally(Book oldBook)
          Unset the current default book, if it matches the argument and attempt to appoint another.
 

Constructors in org.crosswire.jsword.book with parameters of type Book
BookData(org.jdom.Element osis, Book book, Key key)
          Ctor
BookData(SAXEventProvider provider, Book book, Key key)
          Create a BibleData from a SAXEventProvider
BooksEvent(Object source, Book book, boolean added)
          Basic constructor
 

Uses of Book in org.crosswire.jsword.book.basic
 

Classes in org.crosswire.jsword.book.basic that implement Book
 class AbstractBook
          AbstractBook implements a few of the more generic methods of Book.
 class AbstractPassageBook
          An abstract implementation of Book that lets implementors just concentrate on reading book data.
 

Methods in org.crosswire.jsword.book.basic that return Book
 Book AbstractBookDriver.create(Book source)
           
 Book AbstractBook.getBook()
           
 

Methods in org.crosswire.jsword.book.basic with parameters of type Book
 Book AbstractBookDriver.create(Book source)
           
 void AbstractBookDriver.delete(Book dead)
           
protected static void AbstractBookList.fireBooksChanged(Object source, Book book, boolean added)
          Kick of an event sequence
 boolean AbstractBookDriver.isDeletable(Book dead)
           
 

Constructors in org.crosswire.jsword.book.basic with parameters of type Book
DefaultBookMetaData(BookDriver driver, Book book, Map prop)
          Ctor with a properties from which to get values.
 

Uses of Book in org.crosswire.jsword.book.filter
 

Methods in org.crosswire.jsword.book.filter with parameters of type Book
 List Filter.toOSIS(Book book, Key key, String plain)
          Converter from plain (encoded) text to OSIS data
 

Uses of Book in org.crosswire.jsword.book.filter.gbf
 

Methods in org.crosswire.jsword.book.filter.gbf with parameters of type Book
static Tag GBFTagBuilders.getTag(Book book, Key key, String name)
           
private  List GBFFilter.parseTags(Book book, Key key, String aRemains)
          Turn the string into a list of tags in the order that they appear in the original string.
 List GBFFilter.toOSIS(Book book, Key key, String plain)
           
 

Uses of Book in org.crosswire.jsword.book.filter.osis
 

Methods in org.crosswire.jsword.book.filter.osis with parameters of type Book
private  org.jdom.Element OSISFilter.cleanTags(Book book, Key key, String plain)
           
 List OSISFilter.toOSIS(Book book, Key key, String plain)
           
 

Uses of Book in org.crosswire.jsword.book.filter.plaintext
 

Methods in org.crosswire.jsword.book.filter.plaintext with parameters of type Book
 List PlainTextFilter.toOSIS(Book book, Key key, String plain)
           
 

Uses of Book in org.crosswire.jsword.book.filter.thml
 

Fields in org.crosswire.jsword.book.filter.thml declared as Book
private  Book CustomHandler.book
          The book containing the data.
 

Methods in org.crosswire.jsword.book.filter.thml with parameters of type Book
private  org.jdom.Element THMLFilter.cleanParse(Book book, Key key, String plain)
           
private  org.jdom.Element THMLFilter.cleanTags(Book book, Key key, String plain)
           
private  org.jdom.Element THMLFilter.cleanText(Book book, Key key, String plain)
           
private  org.jdom.Element THMLFilter.parse(Book book, Key key, String plain, String failMessage)
           
 List THMLFilter.toOSIS(Book book, Key key, String plain)
           
 

Constructors in org.crosswire.jsword.book.filter.thml with parameters of type Book
CustomHandler(Book book, Key key)
          Simple ctor
 

Uses of Book in org.crosswire.jsword.book.install
 

Methods in org.crosswire.jsword.book.install with parameters of type Book
 void Installer.downloadSearchIndex(Book book, URL tempDest)
          Download a search index for the given Book.
 int Installer.getSize(Book book)
          Return true if the book is not installed or there is a newer version to install.
 void Installer.install(Book book)
          Download and install a book locally.
 boolean Installer.isNewer(Book book)
          Return true if the book is not installed or there is a newer version to install.
 URL Installer.toRemoteURL(Book book)
           
 

Uses of Book in org.crosswire.jsword.book.install.sword
 

Methods in org.crosswire.jsword.book.install.sword with parameters of type Book
 void AbstractSwordInstaller.downloadSearchIndex(Book book, URL localDest)
           
 int HttpSwordInstaller.getSize(Book book)
           
 void AbstractSwordInstaller.install(Book book)
           
 boolean AbstractSwordInstaller.isNewer(Book book)
           
 URL HttpSwordInstaller.toRemoteURL(Book book)
           
 

Uses of Book in org.crosswire.jsword.book.readings
 

Classes in org.crosswire.jsword.book.readings that implement Book
 class ReadingsBook
          A Dictionary that displays daily Readings.
 

Fields in org.crosswire.jsword.book.readings declared as Book
private  Book[] ReadingsBookDriver.books
          The meta data array
 

Methods in org.crosswire.jsword.book.readings that return Book
 Book[] ReadingsBookDriver.getBooks()
           
 

Uses of Book in org.crosswire.jsword.book.sword
 

Classes in org.crosswire.jsword.book.sword that implement Book
 class SwordBook
          SwordBook is a base class for all sword type books.
 class SwordDailyDevotion
          A book that has a preferred key of today's date.
 class SwordDictionary
          A Sword version of Dictionary.
 class SwordGenBook
          A Sword version of Dictionary.
 

Methods in org.crosswire.jsword.book.sword that return Book
 Book BookType.createBook(SwordBookMetaData sbmd)
          Create a Book appropriate for the BookMetaData
private  Book SwordBookDriver.createBook(SwordBookMetaData sbmd)
          Create a Book appropriate for the BookMetaData
protected abstract  Book BookType.getBook(SwordBookMetaData sbmd, AbstractBackend backend)
          Create a Book with the given backend
 Book[] SwordBookDriver.getBooks()
           
 

Methods in org.crosswire.jsword.book.sword with parameters of type Book
 void SwordBookDriver.delete(Book dead)
           
 boolean SwordBookDriver.isDeletable(Book dead)
           
 

Uses of Book in org.crosswire.jsword.examples
 

Methods in org.crosswire.jsword.examples with parameters of type Book
 boolean APIExamples.MyBookFilter.test(Book bk)
           
 

Uses of Book in org.crosswire.jsword.index
 

Methods in org.crosswire.jsword.index with parameters of type Book
 void IndexManager.deleteIndex(Book book)
          Tidy up after yourself and remove all the files that make up any indexes you created.
 Index IndexManager.getIndex(Book book)
          Create a new Searcher.
 void IndexManager.installDownloadedIndex(Book book, URL tempDest)
          We have downloaded a search index to a zip file.
 boolean IndexManager.isIndexed(Book book)
          Detects if index data has been stored for this Bible already
 void IndexManager.scheduleIndexCreation(Book book)
          Read from the given source version to generate ourselves.
 

Uses of Book in org.crosswire.jsword.index.lucene
 

Fields in org.crosswire.jsword.index.lucene declared as Book
protected  Book LuceneIndex.book
          The Book that we are indexing
 

Methods in org.crosswire.jsword.index.lucene with parameters of type Book
 void LuceneIndexManager.deleteIndex(Book book)
           
 Index LuceneIndexManager.getIndex(Book book)
           
protected  URL LuceneIndexManager.getStorageArea(Book book)
          Determine where an index should be stored
 void LuceneIndexManager.installDownloadedIndex(Book book, URL tempDest)
           
 boolean LuceneIndexManager.isIndexed(Book book)
           
 void LuceneIndexManager.scheduleIndexCreation(Book book)
           
 

Constructors in org.crosswire.jsword.index.lucene with parameters of type Book
LuceneIndex(Book book, URL storage)
          Read an existing index and use it.
LuceneIndex(Book book, URL storage, boolean create)
          Generate an index to use, telling the job about progress as you go.
 

Uses of Book in org.crosswire.jsword.index.search
 

Methods in org.crosswire.jsword.index.search with parameters of type Book
static Searcher SearcherFactory.createSearcher(Book book)
          Create a new Searcher.
 

Uses of Book in org.crosswire.jsword.util
 

Methods in org.crosswire.jsword.util with parameters of type Book
static void IndexDownloader.downloadIndex(Book book, Installer installer)
          Download and install a search index
 


Copyright ยจ 2003-2006