Uses of Class
org.crosswire.jsword.book.BookException

Packages that use BookException
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.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.query The Query package provides JSword with the ability to construct a search request against an Index. 
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 BookException in org.crosswire.jsword.book
 

Methods in org.crosswire.jsword.book that throw BookException
 Book BookDriver.create(Book source)
          Create a new Book based on a source.
 void BookDriver.delete(Book dead)
          Delete this Book from the system.
 Key Book.find(SearchRequest request)
          Retrieval: For a given search spec find a list of references to it.
 Key Book.find(String request)
          Retrieval: For a given search spec find a list of references to it.
 BookData Book.getData(Key key)
          Retrieval: Add to the given document some mark-up for the specified Verses.
 String Book.getRawData(Key key)
          Returns the raw text that getData(Key key) builds into OSIS.
static Verse OSISUtil.getVerse(org.jdom.Element ele)
          Walk up the tree from the W to find out what verse we are in.
 void Books.registerDriver(BookDriver driver)
          Register the driver, adding its books to the list.
 void Books.removeBook(Book book)
          Remove a Bible from the current list of Books.
 void Books.unregisterDriver(BookDriver driver)
          Remove from the list of drivers
 

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

Methods in org.crosswire.jsword.book.basic that throw BookException
 Book AbstractBookDriver.create(Book source)
           
 void AbstractBookDriver.delete(Book dead)
           
 Key AbstractBook.find(SearchRequest request)
           
 Key AbstractBook.find(String request)
           
 BookData AbstractPassageBook.getData(Key key)
           
 String AbstractPassageBook.getRawData(Key key)
           
protected abstract  String AbstractPassageBook.getText(Key key)
          Read the unfiltered data for a given key
 void AbstractPassageBook.setDocument(Verse verse, BookData bdata)
          For when we want to add writing functionality
protected abstract  void AbstractPassageBook.setText(Verse verse, String text)
          Set the unparsed text for a verse to permanent storage.
 

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

Methods in org.crosswire.jsword.book.readings that throw BookException
 BookData ReadingsBook.getData(Key key)
           
 String ReadingsBook.getRawData(Key key)
           
 

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

Methods in org.crosswire.jsword.book.sword that throw BookException
 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
 void SwordBookDriver.delete(Book dead)
           
protected abstract  AbstractBackend BookType.getBackend(SwordBookMetaData sbmd)
          Create a the appropriate backend for this type of book
(package private) abstract  AbstractBackend CompressionType.getBackend(SwordBookMetaData sbmd)
           
protected static AbstractBackend BookType.getCompressedBackend(SwordBookMetaData sbmd)
           
 BookData SwordDictionary.getData(Key key)
           
 BookData SwordGenBook.getData(Key key)
           
 String AbstractBackend.getExpandedDataPath()
           
private  String TreeKeyIndex.getExpandedDataPath()
           
 String SwordDictionary.getRawData(Key key)
           
 String SwordGenBook.getRawData(Key key)
           
abstract  String AbstractBackend.getRawText(Key key)
          Get the bytes alotted for the given verse
 String GZIPBackend.getRawText(Key key)
           
 String GenBookBackend.getRawText(Key key)
           
 String LZSSBackend.getRawText(Key key)
           
 String RawBackend.getRawText(Key key)
           
 String RawLDBackend.getRawText(Key key)
           
 String ZLDBackend.getRawText(Key key)
           
protected  String SwordBook.getText(Key key)
          Read the unfiltered data for a given key
static void SwordBookDriver.registerNewBook(SwordBookMetaData sbmd)
          A helper class for the SwordInstaller to tell us that it has copied a new Book into our install directory
static void SwordBookPath.setAugmentPath(File[] theNewDirs)
          Accessor for the Sword directory
protected  void SwordBook.setText(Verse verse, String text)
           
static byte[] SwordUtil.uncompress(byte[] compressed, int endsize)
          Uncompress a block of (G)ZIP compressed data
 

Constructors in org.crosswire.jsword.book.sword that throw BookException
GenBookBackend(SwordBookMetaData sbmd)
          Simple ctor
GZIPBackend(SwordBookMetaData sbmd, BlockType blockType)
          Simple ctor
RawBackend(SwordBookMetaData sbmd)
          Simple ctor
RawLDBackend(SwordBookMetaData sbmd, int datasize)
          Simple ctor
TreeKeyIndex(SwordBookMetaData sbmd)
          Simple ctor
ZLDBackend(SwordBookMetaData sbmd)
          Simple ctor
 

Uses of BookException in org.crosswire.jsword.examples
 

Methods in org.crosswire.jsword.examples that throw BookException
 void DictToOsis.dump(String name)
           
 void BibleToOsis.dump(String name, String range)
           
 void APIExamples.export()
          An example of how to get the text of a book for export.
static void APIExamples.main(String[] args)
          Quick Demo
static void DictToOsis.main(String[] args)
           
(package private)  void APIExamples.rankedSearch()
          An example of how to perform a ranked search.
 void APIExamples.readDictionary()
          While Bible and Commentary are very similar, a Dictionary is read in a slightly different way.
 void APIExamples.readPlainText()
          The source to this method is an example of how to read the plain text of a verse, and print it to stdout.
 void APIExamples.readStyledText()
          This method demonstrates how to get styled text (in this case HTML) from a verse, and print it to stdout.
 void APIExamples.search()
          An example of how to search for various bits of data.
(package private)  void APIExamples.searchAndShow()
          An example of how to do a search and then get text for each range of verses.
 

Uses of BookException in org.crosswire.jsword.index
 

Methods in org.crosswire.jsword.index that throw BookException
 void IndexManager.deleteIndex(Book book)
          Tidy up after yourself and remove all the files that make up any indexes you created.
 Key Index.find(String query)
          Find the set of references that satisfy the query.
 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.
 

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

Methods in org.crosswire.jsword.index.lucene that throw BookException
 void LuceneIndexManager.deleteIndex(Book book)
           
 Key LuceneIndex.find(String search)
           
private  void LuceneIndex.generateSearchIndexImpl(Progress job, List errors, org.apache.lucene.index.IndexWriter writer, Key key, int count)
          Dig down into a Key indexing as we go.
 Index LuceneIndexManager.getIndex(Book book)
           
 void LuceneIndexManager.installDownloadedIndex(Book book, URL tempDest)
           
 Key LuceneSearcher.search(Query query)
           
 Key LuceneSearcher.search(SearchRequest request)
           
 Key LuceneSearcher.search(String request)
           
 

Constructors in org.crosswire.jsword.index.lucene that throw BookException
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 BookException in org.crosswire.jsword.index.query
 

Methods in org.crosswire.jsword.index.query that throw BookException
 Key AndNotQuery.find(Index index)
           
 Key AndQuery.find(Index index)
           
 Key BaseQuery.find(Index index)
           
 Key BlurQuery.find(Index index)
           
 Key NullQuery.find(Index index)
           
 Key OrQuery.find(Index index)
           
 Key Query.find(Index index)
           
 Key RangeQuery.find(Index index)
           
 

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

Methods in org.crosswire.jsword.index.search that throw BookException
 Key Searcher.search(Query request)
          Take a search request and decipher it into a Passage.
 Key Searcher.search(SearchRequest request)
          Take a search request and decipher it into a Passage.
 

Uses of BookException in org.crosswire.jsword.util
 

Methods in org.crosswire.jsword.util that throw BookException
static void IndexDownloader.downloadIndex(Book book, Installer installer)
          Download and install a search index
 


Copyright ยจ 2003-2006