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.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.passage |
The core responsibility of the passage package is to store and collate
information about the structure of the Bible - The most important classes are
Passage , PassageTally and Strongs . |
org.crosswire.jsword.versification |
The core responsibility of the versification package is to understand verse references.
|
Modifier and Type | Method and Description |
---|---|
Key |
Book.getKey(String name)
Someone has typed in a reference to find, but we need a Key to actually
look it up.
|
Modifier and Type | Method and Description |
---|---|
Key |
AbstractPassageBook.getKey(String text) |
Modifier and Type | Method and Description |
---|---|
Key |
ReadingsBook.getKey(String name) |
Modifier and Type | Method and Description |
---|---|
Key |
SwordGenBook.getKey(String text) |
Key |
SwordDictionary.getKey(String text) |
Modifier and Type | Method and Description |
---|---|
private BookData |
DwrBridge.getBookData(String bookInitials,
String reference,
int start,
int count)
Get BookData representing one or more Book entries, but capped to a
maximum number of entries.
|
int |
DwrBridge.getCardinality(String bookInitials,
String reference)
Determine the size of this reference.
|
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.
|
Modifier and Type | Method and Description |
---|---|
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 |
APIExamples.main(String[] args)
Quick Demo
|
String |
APIExamples.readStyledText(String bookInitials,
String reference,
int maxKeyCount)
Obtain styled text (in this case HTML) for a book reference.
|
Modifier and Type | Method and Description |
---|---|
Key |
Index.getKey(String name)
An index must be able to create KeyLists for users in a similar way to
the Book that it is indexing.
|
Modifier and Type | Method and Description |
---|---|
Key |
LuceneIndex.getKey(String name) |
Modifier and Type | Class and Description |
---|---|
class |
NoSuchVerseException
When something tries to use a verse that we don't understand.
|
Modifier and Type | Method and Description |
---|---|
(package private) static Passage |
PassageKeyFactory.fromBinaryRepresentation(byte[] buffer)
Write out the object to the given ObjectOutputStream
|
Key |
KeyFactory.getKey(String name)
Someone has typed in a reference to find, but we need a Key to actually
look it up.
|
Passage |
PassageKeyFactory.getKey(Versification v11n,
String passageReference)
Convert the passageReference into a Passage.
|
Passage |
PassageKeyFactory.getKey(Versification v11n,
String passageReference,
Key basis)
Convert the passageReference into a Passage.
|
static Passage |
PassageKeyFactory.readPassage(Reader in)
Read a passage from a given stream
|
Modifier and Type | Method and Description |
---|---|
private QualifiedKey |
VersificationToKJVMapper.getOffsetQualifiedKey(Versification versification,
String versesKey,
VerseKey offsetBasis)
Deals with offset markers, indicating a passage is +x or -x verses from this one.
|
private QualifiedKey |
VersificationToKJVMapper.getRange(Versification versification,
String versesKey,
VerseKey offsetBasis)
Expands a reference to all its verses
|
private void |
VersificationToKJVMapper.processEntry(KeyValuePair entry) |