| Package | Description |
|---|---|
| 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 implementation 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.bridge |
Command line programs to do useful things.
|
| 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 implementation of an Index using Lucene.
|
| org.crosswire.jsword.index.lucene.analysis |
Implementation of various Lucene analyzers, providing language dependent customizations.
|
| 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.
|
| Modifier and Type | Field and Description |
|---|---|
private Book |
DefaultBook.book
The default book
|
private Book |
BooksEvent.book
The name of the changed Bible
|
private Book[] |
BookData.books
The books to which the key should be applied.
|
private static Book |
Defaults.currentBible
The current bible being tracked.
|
private Book |
BookFilterIterator.next
The stored next value
|
| Modifier and Type | Field and Description |
|---|---|
private Set<Book> |
Books.books
The collection of Books
|
private Map<String,Book> |
Books.initials
The map of book initials
|
private Iterator<Book> |
BookFilterIterator.it |
private Map<String,Book> |
Books.names
The map of book names
|
| Modifier and Type | Method and Description |
|---|---|
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 |
BooksEvent.getBook()
Get the name of the changed Book
|
Book |
Books.getBook(String name)
Search for the book by initials and name.
|
Book[] |
BookProvider.getBooks()
Provide books.
|
Book[] |
BookData.getBooks()
Who created this data.
|
static Book |
Defaults.getCommentary() |
static Book |
Defaults.getCurrentBible()
Get the current Bible, if set, else the default Bible.
|
static Book |
Defaults.getDailyDevotional() |
Book |
DefaultBook.getDefault()
Get the current default book or null if there is none.
|
static Book |
Defaults.getDictionary() |
Book |
BookProvider.getFirstBook()
Provide the first book.
|
Book |
BookData.getFirstBook()
Get the first book.
|
static Book |
Defaults.getGreekDefinitions() |
static Book |
Defaults.getGreekParse() |
static Book |
Defaults.getHebrewDefinitions() |
static Book |
Defaults.getHebrewParse() |
Book |
BookFilterIterator.next() |
Book |
BookSet.set(int index,
Book element) |
| Modifier and Type | Method and Description |
|---|---|
private static Map<Book,String> |
Defaults.getBookMap(BookFilter filter)
Convert a filter into an array of names of Books that pass the filter.
|
List<Book> |
Books.getBooks() |
List<Book> |
Bookmark.getBooks()
Return the ordered set of books.
|
List<Book> |
BookList.getBooks()
Get a list of all the Books of all types.
|
List<Book> |
Books.getBooks(BookFilter filter) |
List<Book> |
BookList.getBooks(BookFilter filter)
Get a filtered list of all the Books.
|
List<Book> |
AbstractBookList.getBooks(BookFilter filter) |
static Comparator<Book> |
BookComparators.getDefault()
Order by default Book ordering
|
static Comparator<Book> |
BookComparators.getInitialComparator()
Order by Initials.
|
Iterator<Book> |
BookFilterIterator.iterator() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
BookSet.add(Book book) |
void |
BookSet.add(int index,
Book element) |
void |
Books.addBook(Book book)
Add a Book to the current list of Books.
|
void |
Bookmark.addBook(Book book)
Add a Book to this Bookmark.
|
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 |
AbstractBookList.fireBooksChanged(Object source,
Book book,
boolean added)
Kick of an event sequence
|
static String |
OSISUtil.getReferences(Book book,
Key key,
Versification v11n,
org.jdom2.Element root)
A space separate string containing osisID from the reference element.
|
boolean |
BookDriver.isDeletable(Book dead)
Is this book able to be deleted.
|
void |
Books.removeBook(Book book)
Remove a Book from the current list of Books.
|
static void |
DataPolice.report(Book book,
Key key,
String message)
Report a message against the current book and key.
|
Book |
BookSet.set(int index,
Book element) |
static void |
Defaults.setBible(Book book)
Set the default Bible.
|
static void |
Defaults.setCommentary(Book book)
Set the default commentary.
|
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)
Set the default daily devotional.
|
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)
Set the default dictionary.
|
static void |
Defaults.setGreekDefinitions(Book book)
Set the default Greek Strong's Numbers dictionary.
|
static void |
Defaults.setGreekParse(Book book)
Set the default Greek morphology dictionary.
|
static void |
Defaults.setHebrewDefinitions(Book book)
Set the default Hebrew Strong's Numbers dictionary.
|
static void |
Defaults.setHebrewParse(Book book)
Set the default Hebrew morphology dictionary by name.
|
boolean |
BookSet.GroupFilter.test(Book book) |
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) |
boolean |
BookFilter.test(Book book)
Does this given book pass the tests implemented by this filter
|
protected void |
DefaultBook.unsetDefaultConditionally(Book oldBook)
Unset the current default book, if it matches the argument and attempt to
appoint another.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
BookSet.addAll(Collection<? extends Book> c) |
boolean |
BookSet.addAll(int index,
Collection<? extends Book> c) |
BookSet |
BookSet.filter(Filter<Book> filter)
Get a set of books that satisfy the condition imposed by the filter.
|
| Constructor and Description |
|---|
BookData(Book[] books,
Key key,
boolean compare)
Create BookData for multiple books.
|
BookData(Book book,
Key key)
Create a BookData.
|
BooksEvent(Object source,
Book book,
boolean added)
Basic constructor
|
| Constructor and Description |
|---|
BookFilterIterator(Iterable<Book> books,
BookFilter filter)
Simple ctor
|
BookSet(Collection<Book> books) |
| Modifier and Type | Class and Description |
|---|---|
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.
|
| Modifier and Type | Field and Description |
|---|---|
private List<Book> |
DefaultBookmark.books
The list of books.
|
| Modifier and Type | Method and Description |
|---|---|
Book |
AbstractBookDriver.create(Book source) |
Book |
AbstractBook.getBook()
Get this book.
|
Book |
AbstractBookDriver.getFirstBook() |
| Modifier and Type | Method and Description |
|---|---|
List<Book> |
DefaultBookmark.getBooks() |
| Modifier and Type | Method and Description |
|---|---|
void |
DefaultBookmark.addBook(Book book) |
int |
AbstractBook.compareTo(Book obj) |
Book |
AbstractBookDriver.create(Book source) |
void |
AbstractBookDriver.delete(Book dead) |
boolean |
AbstractBookDriver.isDeletable(Book dead) |
| Modifier and Type | Method and Description |
|---|---|
List<org.jdom2.Content> |
SourceFilter.toOSIS(Book book,
Key key,
String plain)
Converter from plain (encoded) text to OSIS data
|
| Modifier and Type | Method and Description |
|---|---|
static Tag |
GBFTagBuilders.getTag(Book book,
Key key,
String name) |
private List<Tag> |
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<org.jdom2.Content> |
GBFFilter.toOSIS(Book book,
Key key,
String plain) |
void |
Tag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> osisStack)
Sub-classes should implement this method to generate OSIS Object
|
void |
GBFTags.DefaultEndTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.BoldStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.BookTitleStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.CrossRefStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.EOLTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.FootnoteStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.FootnoteEndTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.HeaderStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.IgnoredTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.ItalicStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.JustifyRightTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.JustifyLeftTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.OTQuoteStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.ParagraphTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.PoetryStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.PsalmStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.RedLetterStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.StrongsMorphTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.StrongsWordTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.TextFootnoteTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.TextTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.TitleStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
void |
GBFTags.UnderlineStartTag.updateOsisStack(Book book,
Key key,
LinkedList<org.jdom2.Content> stack) |
| Modifier and Type | Method and Description |
|---|---|
private org.jdom2.Element |
OSISFilter.cleanTags(Book book,
Key key,
String plain) |
List<org.jdom2.Content> |
OSISFilter.toOSIS(Book book,
Key key,
String plain) |
| Modifier and Type | Method and Description |
|---|---|
List<org.jdom2.Content> |
PlainTextFilter.toOSIS(Book book,
Key key,
String plain) |
| Modifier and Type | Field and Description |
|---|---|
private Book |
CustomHandler.book
The book being parsed.
|
| Modifier and Type | Method and Description |
|---|---|
private org.jdom2.Element |
THMLFilter.cleanParse(Book book,
Key key,
String plain) |
private org.jdom2.Element |
THMLFilter.cleanTags(Book book,
Key key,
String plain) |
private org.jdom2.Element |
THMLFilter.cleanText(Book book,
Key key,
String plain) |
private org.jdom2.Element |
THMLFilter.parse(Book book,
Key key,
String plain,
String failMessage) |
void |
Tag.processContent(Book book,
Key key,
org.jdom2.Element ele)
Do additional processing of the tag after the element has been created.
|
void |
SkipTag.processContent(Book book,
Key key,
org.jdom2.Element ele) |
void |
ScripRefTag.processContent(Book book,
Key key,
org.jdom2.Element ele) |
void |
IgnoreTag.processContent(Book book,
Key key,
org.jdom2.Element ele) |
void |
AbstractTag.processContent(Book book,
Key key,
org.jdom2.Element ele) |
org.jdom2.Element |
VerseTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
UlTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
UTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
TtTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
TrTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
ThTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
TermTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
TdTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
Tag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs)
Make changes to the specified OSIS element given the attributes passed in
the source document.
|
org.jdom2.Element |
TableTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
SyncTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
SupTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
SubTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
SmallTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
ScriptureTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
ScripRefTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
STag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
RootTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
QTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
PTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
OlTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
NoteTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
NameTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
LiTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
LTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
ImgTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
ITag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
HTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
ForeignTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
FontTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
DivTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
CitationTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
CenterTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
BrTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
BlockquoteTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
BigTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
BTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
AnonymousTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
AliasTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
AbstractTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
AbbrTag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
org.jdom2.Element |
ATag.processTag(Book book,
Key key,
org.jdom2.Element ele,
Attributes attrs) |
List<org.jdom2.Content> |
THMLFilter.toOSIS(Book book,
Key key,
String plain) |
| Constructor and Description |
|---|
CustomHandler(Book book,
Key key)
Simple ctor
|
| Modifier and Type | Method and Description |
|---|---|
Book |
Installer.getBook(String book)
Get a Book matching the name from the local cache.
|
| Modifier and Type | Method and Description |
|---|---|
List<Book> |
Installer.getBooks()
Get a list of BookMetaData objects that represent downloadable books.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Installer.downloadSearchIndex(Book book,
URI 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.
|
URI |
Installer.toRemoteURI(Book book) |
| Modifier and Type | Field and Description |
|---|---|
protected Map<String,Book> |
AbstractSwordInstaller.entries
A map of the books in this download area
|
| Modifier and Type | Method and Description |
|---|---|
Book |
AbstractSwordInstaller.getBook(String name) |
| Modifier and Type | Method and Description |
|---|---|
List<Book> |
AbstractSwordInstaller.getBooks() |
List<Book> |
AbstractSwordInstaller.getBooks(BookFilter filter) |
| Modifier and Type | Method and Description |
|---|---|
void |
AbstractSwordInstaller.downloadSearchIndex(Book book,
URI localDest) |
int |
HttpSwordInstaller.getSize(Book book) |
void |
AbstractSwordInstaller.install(Book book) |
boolean |
AbstractSwordInstaller.isNewer(Book book) |
URI |
HttpSwordInstaller.toRemoteURI(Book book) |
| Modifier and Type | Class and Description |
|---|---|
class |
ReadingsBook
A Dictionary that displays daily Readings.
|
| Modifier and Type | Field and Description |
|---|---|
private Book[] |
ReadingsBookDriver.books
The meta data array
|
| Modifier and Type | Method and Description |
|---|---|
Book[] |
ReadingsBookDriver.getBooks() |
| Modifier and Type | Class and Description |
|---|---|
class |
SwordBook
SwordBook is a base class for all verse based 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 a generic book.
|
| Modifier and Type | Method and Description |
|---|---|
private Book |
SwordBookDriver.createBook(SwordBookMetaData sbmd)
Create a Book appropriate for the BookMetaData
|
Book |
BookType.createBook(SwordBookMetaData sbmd)
Create a Book appropriate for the BookMetaData
|
protected abstract Book |
BookType.getBook(SwordBookMetaData sbmd,
Backend backend)
Create a Book with the given backend
|
Book[] |
SwordBookDriver.getBooks() |
| Modifier and Type | Method and Description |
|---|---|
void |
SwordBookDriver.delete(Book dead) |
boolean |
SwordBookDriver.isDeletable(Book dead) |
| Modifier and Type | Method and Description |
|---|---|
private void |
SwordBookDriver.getBooks(Set<Book> valid,
File bookDir) |
| Modifier and Type | Field and Description |
|---|---|
private Book |
BookLookup.book |
protected Book |
BookIndexer.book |
private Book |
BookExporter.book |
private Book |
BibleScope.book |
| Modifier and Type | Method and Description |
|---|---|
Book |
BookInstaller.getBook(String repositoryName,
String bookName)
Get a Book from the repository.
|
static Book |
BookInstaller.getInstalledBook(String bookInitials)
Get a particular installed book by initials.
|
Book |
BookInstaller.getRepositoryBook(String repositoryName,
String bookInitials)
Get a particular installed book by initials.
|
| Modifier and Type | Method and Description |
|---|---|
static List<Book> |
BookInstaller.getInstalledBooks()
Get a list of all installed books.
|
static List<Book> |
BookInstaller.getInstalledBooks(BookFilter filter)
Get a list of installed books by BookFilter.
|
static List<Book> |
BookInstaller.getInstalledBooks(String filterSpec)
Get a list of books by CustomFilter specification
|
List<Book> |
BookInstaller.getRepositoryBooks(String repositoryName)
Get a list of all known books for an installer.
|
List<Book> |
BookInstaller.getRepositoryBooks(String repositoryName,
BookFilter filter)
Get a list of books in a repository by BookFilter.
|
List<Book> |
BookInstaller.getRepositoryBooks(String repositoryName,
String filterSpec)
Get a list of books in a repository by CustomFilter specification
|
| Modifier and Type | Method and Description |
|---|---|
void |
BookInstaller.deleteBook(Book book)
Uninstall a book.
|
void |
BookInstaller.installBook(String repositoryName,
Book book)
Install a book, overwriting it if the book to be installed is newer.
|
boolean |
DwrBridge.isBookIndexed(Book book)
Determine whether the book can be searched, that is, whether the book is
indexed.
|
static void |
BibleScope.report(Book b) |
| Constructor and Description |
|---|
BibleScope(Book book) |
BookExporter(Book book) |
BookIndexer(Book book) |
BookLookup(Book book) |
| Modifier and Type | Field and Description |
|---|---|
private Book |
Speed.book
The version to test
|
| Modifier and Type | Method and Description |
|---|---|
Book |
Speed.getBook()
Accessor for the version that we are testing
|
Book |
APIExamples.getBook(String bookInitials)
Get a particular installed book by initials.
|
| Modifier and Type | Method and Description |
|---|---|
private static List<Book> |
ReadEverything.getBooks(BookFilter filter) |
| Modifier and Type | Method and Description |
|---|---|
void |
StrongsAnalysis.analyze(StrongsMapSet sms,
Book book,
List<Key> errors,
Key wholeBible) |
private static void |
GatherAllReferences.readBook(Book book,
Key set)
Perform a test read on an iterator over a set of keys
|
private static void |
GatherAllReferences.readKey(Book book,
Key key,
int[] stats)
Perform a test read on a single key
|
void |
Speed.setBook(Book book)
Accessor for the version that we are testing
|
boolean |
APIExamples.MyBookFilter.test(Book bk) |
private static void |
ReadEverything.testReadMultiple(Book book,
Key set)
Perform a test read on an iterator over a set of keys
|
private static void |
ReadEverything.testReadSingle(Book book,
Key key,
int entry)
Perform a test read on a single key
|
| Constructor and Description |
|---|
Speed(Book book)
Basic constructor
|
| Modifier and Type | Method and Description |
|---|---|
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,
URI tempDest)
We have downloaded a search index to a zip file.
|
boolean |
IndexManager.isIndexed(Book book)
Detects if index data has been stored and is valid for this Bible.
|
boolean |
IndexManager.needsReindexing(Book book)
Detect or checking whether this book needs reindexing.
|
void |
IndexManager.scheduleIndexCreation(Book book)
Read from the given source version to generate ourselves.
|
| Modifier and Type | Field and Description |
|---|---|
private Book |
LuceneIndex.book
The Book that we are indexing
|
| Modifier and Type | Field and Description |
|---|---|
protected static Map<Book,Index> |
LuceneIndexManager.INDEXES
The created indexes
|
| Modifier and Type | Method and Description |
|---|---|
void |
LuceneIndexManager.deleteIndex(Book book) |
Index |
LuceneIndexManager.getIndex(Book book) |
float |
InstalledIndex.getInstalledIndexVersion(Book b) |
float |
IndexMetadata.getLatestIndexVersion(Book b) |
protected URI |
LuceneIndexManager.getStorageArea(Book book)
Determine where an index should be stored
|
void |
LuceneIndexManager.installDownloadedIndex(Book book,
URI tempDest) |
boolean |
LuceneIndexManager.isIndexed(Book book) |
boolean |
LuceneIndexManager.needsReindexing(Book book)
Clients can use this to determine if book's index is stale and needs to re-indexed or downloaded.
|
void |
InstalledIndex.removeFromInstalledIndexMetadata(Book b) |
void |
LuceneIndexManager.scheduleIndexCreation(Book book) |
void |
InstalledIndex.storeInstalledIndexMetadata(Book b,
String installedIndexVersionToStore) |
void |
InstalledIndex.storeLatestVersionAsInstalledIndexMetadata(Book b) |
| Constructor and Description |
|---|
LuceneIndex(Book book,
URI storage)
Read an existing index and use it.
|
LuceneIndex(Book book,
URI storage,
IndexPolicy policy)
Generate an index to use, telling the job about progress as you go.
|
| Modifier and Type | Field and Description |
|---|---|
private Book |
AbstractBookTokenFilter.book |
protected Book |
AbstractBookAnalyzer.book
The book against which analysis is performed.
|
| Modifier and Type | Method and Description |
|---|---|
Book |
AbstractBookTokenFilter.getBook() |
Book |
AbstractBookAnalyzer.getBook() |
| Modifier and Type | Method and Description |
|---|---|
AbstractBookAnalyzer |
AnalyzerFactory.createAnalyzer(Book book) |
void |
ConfigurableSnowballAnalyzer.setBook(Book newBook) |
void |
AbstractBookTokenFilter.setBook(Book book) |
void |
AbstractBookAnalyzer.setBook(Book newBook)
The book for which analysis is being performed.
|
| Constructor and Description |
|---|
AbstractBookAnalyzer(Book book) |
AbstractBookTokenFilter(Book book,
org.apache.lucene.analysis.TokenStream input)
Create a TokenFilter tied to a Book.
|
KeyAnalyzer(Book book)
Construct an KeyAnalyzer tied to a book.
|
KeyFilter(Book book,
org.apache.lucene.analysis.TokenStream in)
Construct a KeyFilter tied to a Book.
|
LuceneAnalyzer(Book book) |
StrongsNumberAnalyzer(Book book)
Construct an StrongsNumberAnalyzer tied to a book.
|
StrongsNumberFilter(Book book,
org.apache.lucene.analysis.TokenStream in)
Construct filtering in.
|
XRefAnalyzer(Book book)
Construct an XRefAnalyzer tied to a book.
|
XRefFilter(Book book,
org.apache.lucene.analysis.TokenStream in)
Construct an XRefFilter tied to a Book.
|
| Modifier and Type | Method and Description |
|---|---|
static Searcher |
SearcherFactory.createSearcher(Book book)
Create a new Searcher.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
IndexDownloader.downloadIndex(Book book,
Installer installer)
Download and install a search index
|