|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
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.search | This package helps implementors of the various Book interfaces implement search. |
org.crosswire.jsword.book.search.basic | |
org.crosswire.jsword.book.search.lucene | An implemenation of SearchEngine using Lucene. |
org.crosswire.jsword.book.search.parse | The search package is responsible for taking a text string "God
& loves & world" and turning it into a series of calls to
Book and Passage to find the answer. |
org.crosswire.jsword.book.sword | An implementation of the Book interfaces that reads from SWORD project modules. |
org.crosswire.jsword.examples | Some examples of how to use the JSword API. |
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(String search)
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. |
Collection |
StudyTool.getTranslations(Book bible,
String word)
StudyTool: For a given word find a list words it is translated from |
Collection |
StudyTool.getTranslations(Book bible,
Strongs number)
StudyTool: For a given number find a list of ways it is translated |
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. |
private void |
Strongs.set(int type,
int number)
Create a Strongs number from a type and a number. |
void |
Books.unregisterDriver(BookDriver driver)
Remove from the list of drivers |
Constructors in org.crosswire.jsword.book that throw BookException | |
---|---|
Strongs(org.jdom.Element w)
Work out what the Strongs number is from the W element |
|
Strongs(int type,
int number)
Create a Strongs number from a type and a number |
|
Strongs(String desc)
Create a Strongs number from an OLB descriptive string. |
Uses of BookException in org.crosswire.jsword.book.basic |
---|
Methods in org.crosswire.jsword.book.basic that throw BookException | |
---|---|
void |
Verifier.checkPassage(PrintWriter out)
Read from the given source version to generate ourselves |
private void |
Verifier.checkSinglePassage(String word,
PrintWriter out)
Read from the given source version to generate ourselves |
Book |
AbstractBookDriver.create(Book source)
|
void |
AbstractBookDriver.delete(Book dead)
|
Key |
AbstractBook.find(String search)
|
BookData |
PassageAbstractBook.getData(Key key)
|
String |
PassageAbstractBook.getRawData(Key key)
|
protected abstract String |
PassageAbstractBook.getText(Key key)
Read the unfiltered data for a given key |
void |
PassageAbstractBook.setDocument(Verse verse,
BookData bdata)
For when we want to add writing functionality |
protected abstract void |
PassageAbstractBook.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.search |
---|
Methods in org.crosswire.jsword.book.search 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.findWord(String word)
For a given word find a list of references to it. |
Index |
IndexManager.getIndex(Book book)
Create a new Searcher. |
Collection |
Thesaurus.getSynonyms(String word)
Return an array of words that are used by this Bible that start with the given string. |
void |
IndexManager.installDownloadedIndex(Book book,
URL tempDest)
We have downloaded a search index to a zip file. |
Key |
Searcher.search(String search)
Take a search string and decipher it into a Passage. |
Uses of BookException in org.crosswire.jsword.book.search.basic |
---|
Methods in org.crosswire.jsword.book.search.basic that throw BookException | |
---|---|
Collection |
NullThesaurus.getSynonyms(String word)
|
Uses of BookException in org.crosswire.jsword.book.search.lucene |
---|
Methods in org.crosswire.jsword.book.search.lucene that throw BookException | |
---|---|
void |
LuceneIndexManager.deleteIndex(Book book)
|
Key |
LuceneIndex.findWord(String search)
|
private void |
LuceneIndex.generateSearchIndexImpl(Job job,
List errors,
org.apache.lucene.index.IndexWriter writer,
Key key)
Dig down into a Key indexing as we go. |
Index |
LuceneIndexManager.getIndex(Book book)
|
Collection |
LuceneThesarus.getSynonyms(String word)
|
void |
LuceneIndexManager.installDownloadedIndex(Book book,
URL tempDest)
|
Constructors in org.crosswire.jsword.book.search.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.book.search.parse |
---|
Methods in org.crosswire.jsword.book.search.parse that throw BookException | |
---|---|
Key |
PhraseParamWord.bestMatch(IndexSearcher engine,
String sought)
|
Key |
SubRightParamWord.getKeyList(IndexSearcher engine)
|
Key |
SubLeftParamWord.getKeyList(IndexSearcher engine)
|
Key |
StartsParamWord.getKeyList(IndexSearcher engine)
WARNING the return from this method is a PassageTally which is not a 100% match for the Passage interface. |
Key |
PhraseParamWord.getKeyList(IndexSearcher engine)
|
Key |
PassageRightParamWord.getKeyList(IndexSearcher engine)
|
Key |
PassageLeftParamWord.getKeyList(IndexSearcher engine)
|
Key |
ParamWord.getKeyList(IndexSearcher engine)
Get a Passage or throw-up if that is not appropriate for this Word. |
Key |
GrammarParamWord.getKeyList(IndexSearcher engine)
|
Key |
DefaultWord.getKeyList(IndexSearcher engine)
|
protected Key |
IndexSearcher.getPassage(String[] words)
A basic version of getPassage(String[]) simply calls getPassage(String) in a loop for each word, adding the Verses to an Passage that is returned |
String |
SubRightParamWord.getWord(IndexSearcher engine)
|
String |
SubLeftParamWord.getWord(IndexSearcher engine)
|
String |
StartsParamWord.getWord(IndexSearcher engine)
|
String |
PhraseParamWord.getWord(IndexSearcher engine)
|
String |
PassageRightParamWord.getWord(IndexSearcher engine)
|
String |
PassageLeftParamWord.getWord(IndexSearcher engine)
|
String |
ParamWord.getWord(IndexSearcher engine)
Get a word for something else to word on. |
String |
GrammarParamWord.getWord(IndexSearcher engine)
|
Key |
IndexSearcher.iteratePassage()
|
String |
IndexSearcher.iterateWord()
|
protected Key |
IndexSearcher.search(List matches)
Take a search string and decipher it into a Passage. |
Key |
IndexSearcher.search(String search)
|
static List |
CustomTokenizer.tokenize(String sought,
Map commands)
Convenience method to generate a Vector of SearchWords |
void |
RetainCommandWord.updatePassage(IndexSearcher engine,
Key key)
|
void |
RemoveCommandWord.updatePassage(IndexSearcher engine,
Key key)
|
void |
DefaultWord.updatePassage(IndexSearcher engine,
Key key)
|
void |
CommandWord.updatePassage(IndexSearcher engine,
Key ref)
Alter a Passage in whatever manner is appropriate for this command. |
void |
BlurCommandWord.updatePassage(IndexSearcher engine,
Key key)
|
void |
AddCommandWord.updatePassage(IndexSearcher engine,
Key key)
|
protected Key |
IndexSearcher.wordSearch(String sought)
Take a search string and decipher it into a Passage. |
Uses of BookException in org.crosswire.jsword.book.sword |
---|
Methods in org.crosswire.jsword.book.sword that throw BookException | |
---|---|
private Book |
SwordBookDriver.createBook(SwordBookMetaData sbmd,
File progdir)
Create a Book appropriate for the BookMetaData |
Book |
ModuleType.createBook(SwordBookMetaData sbmd,
File progdir)
Create a Book appropriate for the BookMetaData |
void |
SwordBookDriver.delete(Book dead)
|
protected abstract Backend |
ModuleType.getBackend(SwordBookMetaData sbmd,
File rootPath)
Create a the appropriate backend for this type of book |
(package private) abstract Backend |
CompressionType.getBackend(SwordBookMetaData sbmd,
File rootPath)
|
protected static Backend |
ModuleType.getCompressedBackend(SwordBookMetaData sbmd,
File rootPath)
|
BookData |
SwordDictionary.getData(Key key)
|
String |
SwordDictionary.getRawData(Key key)
|
String |
ZLDBackend.getRawText(Key key)
|
String |
RawLDBackend.getRawText(Key key)
|
String |
RawBackend.getRawText(Key key)
|
String |
LZSSBackend.getRawText(Key key)
|
String |
GZIPBackend.getRawText(Key key)
|
abstract String |
Backend.getRawText(Key key)
Get the bytes alotted for the given verse |
protected String |
SwordBook.getText(Key key)
Read the unfiltered data for a given key |
static void |
SwordBookDriver.registerNewBook(SwordBookMetaData sbmd,
File bookpath)
A helper class for the FtpSwordInstaller to tell us that it has copied a new Book into our install dorectory |
static void |
SwordBookDriver.setSwordPath(File[] newDirs)
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 GZIP compressed data |
Constructors in org.crosswire.jsword.book.sword that throw BookException | |
---|---|
GZIPBackend(SwordBookMetaData sbmd,
File rootPath,
BlockType blockType)
Simple ctor |
|
RawBackend(SwordBookMetaData sbmd,
File rootPath)
Simple ctor |
|
RawLDBackend(SwordBookMetaData sbmd,
File rootPath,
int datasize)
Simple ctor |
Uses of BookException in org.crosswire.jsword.examples |
---|
Methods in org.crosswire.jsword.examples that throw BookException | |
---|---|
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. |
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-2004 | |||||||||
PREV NEXT | FRAMES NO FRAMES |