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.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.book.sword.state |
File management of SWORD Books.
|
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.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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
org.jdom2.Element |
BookData.getOsis()
Accessor for the root OSIS element
|
private org.jdom2.Element |
BookData.getOsisContent(boolean allowGenTitles) |
org.jdom2.Element |
BookData.getOsisFragment()
Accessor for the requested data in OSIS format.
|
org.jdom2.Element |
BookData.getOsisFragment(boolean allowGenTitles)
Accessor for the root OSIS element
|
Iterator<org.jdom2.Content> |
Book.getOsisIterator(Key key,
boolean allowEmpty,
boolean allowGenTitles)
Return an iterator that returns each key's OSIS in turn.
|
String |
Book.getRawText(Key key)
Returns the raw text that getData(Key key) builds into OSIS.
|
SAXEventProvider |
BookData.getSAXEventProvider()
Output the current data as a SAX stream.
|
static Verse |
OSISUtil.getVerse(Versification v11n,
org.jdom2.Element ele)
Walk up the tree from the W to find out what verse we are in.
|
private BookData.BookVerseContent |
BookData.keyIteratorContentByVerse(Versification v11n,
Iterator<org.jdom2.Content> iter)
We iterate through the content, making sure we key together those bits that belong together.
|
void |
Books.registerDriver(BookDriver driver)
Register the driver, adding its books to the list.
|
void |
BookMetaData.reload()
If this BookMetaData is partially loaded, reload it fully.
|
void |
Books.removeBook(Book book)
Remove a Book from the current list of Books.
|
void |
Book.setAliasKey(Key alias,
Key source)
Store an alias of one key to another.
|
void |
BookMetaData.setLibrary(URI library)
Set the base URI for library of this module.
|
void |
Book.setRawText(Key key,
String rawData)
Store the raw text for the given key.
|
Modifier and Type | Method and Description |
---|---|
Book |
AbstractBookDriver.create(Book source) |
void |
AbstractBookDriver.delete(Book dead) |
Key |
AbstractBook.find(SearchRequest request) |
Key |
AbstractBook.find(String request) |
protected abstract List<org.jdom2.Content> |
AbstractBook.getOsis(Key key,
RawTextToXmlProcessor noOpRawTextProcessor) |
Iterator<org.jdom2.Content> |
AbstractPassageBook.getOsisIterator(Key key,
boolean allowEmpty,
boolean allowGenTitles) |
void |
AbstractBookMetaData.reload() |
void |
AbstractPassageBook.setDocument(Key key,
BookData bdata)
For when we want to add writing functionality.
|
void |
AbstractBookMetaData.setLibrary(URI library) |
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractSwordInstaller.loadCachedIndex()
Load the cached index file into memory
|
Modifier and Type | Method and Description |
---|---|
List<org.jdom2.Content> |
ReadingsBook.getOsis(Key key,
RawTextToXmlProcessor processor)
Returns an empty list
|
Iterator<org.jdom2.Content> |
ReadingsBook.getOsisIterator(Key key,
boolean allowEmpty,
boolean allowGenTitles) |
String |
ReadingsBook.getRawText(Key key)
Returns an empty string
(non-Javadoc)
|
void |
ReadingsBook.setAliasKey(Key alias,
Key source) |
void |
ReadingsBook.setRawText(Key key,
String rawData) |
Modifier and Type | Method and Description |
---|---|
private void |
SwordBookMetaData.adjustConfig() |
private void |
SwordBookMetaData.adjustLocation() |
void |
RawFileBackend.create() |
void |
NullBackend.create() |
void |
Backend.create()
Create the directory to hold the Book if it does not exist.
|
void |
AbstractBackend.create() |
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
|
private void |
RawFileBackend.createDataFiles() |
private File |
RawFileBackend.createDataTextFile(int index) |
private void |
RawFileBackend.createIncfile(RawFileBackendState state) |
private void |
RawFileBackend.createIndexFiles() |
void |
SwordBookDriver.delete(Book dead) |
protected abstract Backend |
BookType.getBackend(SwordBookMetaData sbmd)
Create a the appropriate backend for this type of book
|
private File |
RawFileBackend.getDataTextFile(RandomAccessFile txtRaf,
DataIndex dataIndex)
Gets the File having the verse text.
|
private String |
TreeKeyIndex.getExpandedDataPath() |
static URI |
SwordUtil.getExpandedDataPath(BookMetaData bookMetaData)
Returns where the book should be located
|
Key |
ZVerseBackend.getGlobalKeyList() |
Key |
RawBackend.getGlobalKeyList() |
Key |
NullBackend.getGlobalKeyList() |
Key |
Backend.getGlobalKeyList()
Gets the fast global key list, and if this operation is not supported, throws a
UnsupportedOperationException |
Key |
AbstractBackend.getGlobalKeyList() |
List<org.jdom2.Content> |
SwordGenBook.getOsis(Key key,
RawTextToXmlProcessor processor) |
List<org.jdom2.Content> |
SwordDictionary.getOsis(Key key,
RawTextToXmlProcessor processor) |
protected List<org.jdom2.Content> |
SwordBook.getOsis(Key key,
RawTextToXmlProcessor processor) |
Iterator<org.jdom2.Content> |
SwordGenBook.getOsisIterator(Key key,
boolean allowEmpty,
boolean allowGenTitle) |
Iterator<org.jdom2.Content> |
SwordDictionary.getOsisIterator(Key key,
boolean allowEmpty,
boolean allowGenTitles) |
String |
SwordGenBook.getRawText(Key key) |
String |
SwordDictionary.getRawText(Key key) |
String |
SwordBook.getRawText(Key key) |
String |
NullBackend.getRawText(Key key) |
String |
Backend.getRawText(Key key)
Get the text as it is found in the Book for the given key
|
String |
AbstractBackend.getRawText(Key key) |
ZVerseBackendState |
ZVerseBackend.initState() |
ZLDBackendState |
ZLDBackend.initState() |
T |
StatefulFileBackedBackend.initState()
Initialises the state required to read from files, specific to each
different backend
|
RawLDBackendState |
RawLDBackend.initState() |
RawFileBackendState |
RawFileBackend.initState() |
T |
RawBackend.initState() |
GenBookBackendState |
GenBookBackend.initState() |
private void |
AbstractBackend.readNormalOsis(Key key,
RawTextToXmlProcessor processor,
List<org.jdom2.Content> content,
T openFileState) |
private void |
AbstractBackend.readNormalOsisSingleKey(Key key,
RawTextToXmlProcessor processor,
List<org.jdom2.Content> content,
T openFileState)
Avoid using iterator for GenBook TreeKeys which would cause a GenBook nodes children to be appended to their parent
e.g.
|
private Verse |
AbstractBackend.readPassageOsis(Key key,
RawTextToXmlProcessor processor,
List<org.jdom2.Content> content,
T openFileState)
Reads a passage as OSIS
|
String |
GenBookBackend.readRawContent(GenBookBackendState state,
Key key) |
String |
StatefulFileBackedBackend.readRawContent(T state,
Key key) |
List |
NullBackend.readToOsis(Key key,
RawTextToXmlProcessor processor) |
List<org.jdom2.Content> |
Backend.readToOsis(Key key,
RawTextToXmlProcessor processor)
Get the text allotted for the given entry
|
List<org.jdom2.Content> |
AbstractBackend.readToOsis(Key key,
RawTextToXmlProcessor processor) |
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
|
void |
SwordBookMetaData.reload() |
void |
SwordBookMetaData.reload(Filter<String> keepers) |
void |
SwordGenBook.setAliasKey(Key alias,
Key source) |
void |
SwordDictionary.setAliasKey(Key alias,
Key source) |
void |
SwordBook.setAliasKey(Key alias,
Key source) |
void |
NullBackend.setAliasKey(Key alias,
Key source) |
void |
Backend.setAliasKey(Key alias,
Key source) |
void |
AbstractBackend.setAliasKey(Key alias,
Key source) |
static void |
SwordBookPath.setAugmentPath(File[] theNewDirs)
Establish additional locations that Sword may hold books.
|
void |
GenBookBackend.setRawText(GenBookBackendState rafBook,
Key key,
String text) |
void |
SwordGenBook.setRawText(Key key,
String rawData) |
void |
SwordDictionary.setRawText(Key key,
String rawData) |
void |
SwordBook.setRawText(Key key,
String rawData) |
void |
RawBackend.setRawText(RawBackendState state,
Key key,
String text) |
void |
RawFileBackend.setRawText(RawFileBackendState state,
Key key,
String text) |
void |
StatefulFileBackedBackend.setRawText(T state,
Key key,
String text)
Set the text allotted for the given verse
|
void |
AbstractKeyBackend.setRawText(T state,
Key key,
String text) |
void |
ZVerseBackend.setRawText(ZVerseBackendState rafBook,
Key key,
String text) |
private void |
AbstractBackend.throwFailedKeyException(Key masterKey,
Key currentKey,
IOException e)
If non-null, currentKey is used to throw the exception, other, masterKey
is used instead, which will be more general.
|
Constructor and Description |
---|
SwordBookMetaData(byte[] buffer,
String bookConf)
Loads a sword config from a buffer gotten from mods.d.tar.gz or mods.d.zip.
|
SwordBookMetaData(File file,
URI bookRootPath)
Loads a sword config from a given File.
|
Modifier and Type | Method and Description |
---|---|
private void |
OpenFileStateManager.ensureNotShuttingDown() |
GenBookBackendState |
OpenFileStateManager.getGenBookBackendState(BookMetaData metadata) |
RawBackendState |
OpenFileStateManager.getRawBackendState(BookMetaData metadata) |
RawFileBackendState |
OpenFileStateManager.getRawFileBackendState(BookMetaData metadata) |
RawLDBackendState |
OpenFileStateManager.getRawLDBackendState(BookMetaData metadata) |
ZLDBackendState |
OpenFileStateManager.getZLDBackendState(BookMetaData metadata) |
ZVerseBackendState |
OpenFileStateManager.getZVerseBackendState(BookMetaData metadata,
BlockType blockType) |
Constructor and Description |
---|
RawBackendState(BookMetaData bookMetaData)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
RawFileBackendState(BookMetaData bookMetaData)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
RawLDBackendState(BookMetaData bookMetaData)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
ZLDBackendState(BookMetaData bookMetaData)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
ZVerseBackendState(BookMetaData bookMetaData,
BlockType blockType)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
Modifier and Type | Method and Description |
---|---|
void |
BookIndexer.createIndex() |
void |
BookInstaller.deleteBook(Book book)
Uninstall a book.
|
void |
BookIndexer.deleteIndex() |
private SAXEventProvider |
DwrBridge.getOSISProvider(String bookInitials,
String reference,
int start,
int count)
Obtain a SAX event provider for the OSIS document representation of one
or more book entries.
|
String |
DwrBridge.getOSISString(String bookInitials,
String reference,
int start,
int count)
Obtain the OSIS representation from a book for a reference, pruning a
reference to a limited number of keys.
|
void |
BookInstaller.installBook(String repositoryName,
Book book)
Install a book, overwriting it if the book to be installed is newer.
|
String |
BookLookup.locate(Key key) |
void |
BookExporter.mod2imp() |
String |
DwrBridge.search(String bookInitials,
String searchRequest)
Get a reference list for a search result against a book.
|
Modifier and Type | Method and Description |
---|---|
private void |
Speed.dummyDisplay(Passage ref)
Dummy display routine.
|
void |
DictToOsis.dump(String name) |
void |
BibleToOsis.dump(String name,
String range) |
SAXEventProvider |
APIExamples.getOSIS(String bookInitials,
String reference,
int maxKeyCount)
Obtain a SAX event provider for the OSIS document representation of one
or more book entries.
|
String |
APIExamples.getPlainText(String bookInitials,
String reference)
Get just the canonical text of one or more book entries without any
markup.
|
static void |
DictToOsis.main(String[] args) |
static void |
APIExamples.main(String[] args)
Quick Demo
|
(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.
|
String |
APIExamples.readStyledText(String bookInitials,
String reference,
int maxKeyCount)
Obtain styled text (in this case HTML) for a book reference.
|
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.
|
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.
|
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,
URI tempDest)
We have downloaded a search index to a zip file.
|
Modifier and Type | Method and Description |
---|---|
void |
LuceneIndexManager.deleteIndex(Book book) |
Key |
LuceneIndex.find(String search) |
private void |
LuceneIndex.generateSearchIndexImpl(Progress job,
List<Key> errors,
org.apache.lucene.index.IndexWriter writer,
Key key,
int count,
IndexPolicy policy)
Dig down into a Key indexing as we go.
|
Index |
LuceneIndexManager.getIndex(Book book) |
void |
LuceneIndexManager.installDownloadedIndex(Book book,
URI tempDest) |
Key |
LuceneSearcher.search(Query query) |
Key |
LuceneSearcher.search(SearchRequest request) |
Key |
LuceneSearcher.search(String request) |
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 | Method and Description |
---|---|
Key |
RangeQuery.find(Index index) |
Key |
Query.find(Index index)
Find the keys that match the query in the index
|
Key |
OrQuery.find(Index index) |
Key |
NullQuery.find(Index index) |
Key |
BlurQuery.find(Index index) |
Key |
BaseQuery.find(Index index) |
Key |
AndQuery.find(Index index) |
Key |
AndNotQuery.find(Index index) |
Modifier and Type | Method and Description |
---|---|
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.
|
Modifier and Type | Method and Description |
---|---|
static void |
IndexDownloader.downloadIndex(Book book,
Installer installer)
Download and install a search index
|