| Package | Description |
|---|---|
| org.crosswire.jsword.book |
The Book package provides an interface to a real store of data.
|
| org.crosswire.jsword.book.sword |
An implementation of the Book interfaces that reads from SWORD project
books (modules).
|
| 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 |
|---|---|
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.
|
| Modifier and Type | Method and Description |
|---|---|
private Verse |
AbstractBackend.readPassageOsis(Key key,
RawTextToXmlProcessor processor,
List<org.jdom2.Content> content,
T openFileState)
Reads a passage as OSIS
|
| Modifier and Type | Field and Description |
|---|---|
static Verse |
Verse.DEFAULT
The default verse
|
private Verse |
VerseRange.end
The last verse.
|
private Verse |
PassageEvent.lower
The lowest numbered element to have changed
|
private Verse |
VerseRange.VerseIterator.nextVerse |
private Verse |
AbstractPassage.VerseRangeIterator.nextVerse
What is the next Verse to be considered
|
private Verse |
VerseRange.start
The start of the range
|
private Verse |
PassageEvent.upper
The highest numbered element to have changed
|
| Modifier and Type | Method and Description |
|---|---|
private Verse |
VerseRange.calcEnd()
Calculate the last verse in this range.
|
Verse |
Verse.clone() |
abstract Verse |
AccuracyType.createEndVerse(Versification v11n,
Verse verseBasis,
String[] endParts) |
abstract Verse |
AccuracyType.createStartVerse(Versification v11n,
VerseRange verseRangeBasis,
String[] parts) |
static Verse |
VerseFactory.fromString(Versification v11n,
String original)
Construct a Verse from a String - something like "Gen 1:1".
|
static Verse |
VerseFactory.fromString(Versification v11n,
String original,
VerseRange verseRangeBasis)
Construct a Verse from a String and a VerseRange.
|
Verse |
VerseRange.getEnd()
Fetch the last verse in this range.
|
Verse |
PassageEvent.getLowerIndex()
Returns the lower index of the range.
|
Verse |
VerseRange.getStart()
Fetch the first verse in this range.
|
Verse |
PassageEvent.getUpperIndex()
Returns the upper index of the range.
|
static Verse |
KeyUtil.getVerse(Key key)
Cast a Key to a Verse.
|
Verse |
SynchronizedPassage.getVerseAt(int offset) |
Verse |
RocketPassage.getVerseAt(int offset) |
Verse |
ReadOnlyPassage.getVerseAt(int offset) |
Verse |
Passage.getVerseAt(int offset)
Get a specific Verse from this collection
|
Verse |
AbstractPassage.getVerseAt(int offset) |
Verse |
Verse.getWhole() |
private Verse |
OsisParser.parseOsisID(Versification v11n,
List<String> osisIDParts) |
Verse |
OsisParser.parseOsisID(Versification v11n,
String osisID)
Strict OSIS ID parsers, case-sensitive
|
Verse |
Verse.reversify(Versification newVersification) |
Verse[] |
VerseRange.toVerseArray()
Create an array of Verses
|
Verse[] |
Verse.toVerseArray()
Create an array of Verses
|
| Modifier and Type | Method and Description |
|---|---|
abstract VerseRange |
RestrictionType.blur(Versification v11n,
Verse verse,
int blurDown,
int blurUp)
Blur a verse the specified amount.
|
boolean |
VerseRange.contains(Verse that)
Is the given verse entirely within our range.
|
abstract Verse |
AccuracyType.createEndVerse(Versification v11n,
Verse verseBasis,
String[] endParts) |
private String |
Verse.doGetName(Verse verseBase)
Compute the verse representation given the context.
|
protected void |
AbstractPassage.fireContentsChanged(Object source,
Verse start,
Verse end)
AbstractPassage subclasses must call this method before one or
more elements of the list are added.
|
protected void |
AbstractPassage.fireIntervalAdded(Object source,
Verse start,
Verse end)
AbstractPassage subclasses must call this method after one or more
elements of the list are added.
|
protected void |
AbstractPassage.fireIntervalRemoved(Object source,
Verse start,
Verse end)
AbstractPassage subclasses must call this method before one or
more elements of the list are added.
|
int |
PassageTally.getIndexOf(Verse verse)
What is the index of the give verse in the current ordering scheme
|
int |
PassageTally.getTallyOf(Verse verse)
The ranking given to a specific verse
|
abstract boolean |
RestrictionType.isSameScope(Versification v11n,
Verse start,
Verse end)
Are the two verses in the same scope.
|
abstract VerseRange |
RestrictionType.toRange(Versification v11n,
Verse verse,
int count)
Create a range from the verse having the specified number of verses.
|
| Constructor and Description |
|---|
PassageEvent(Object source,
PassageEvent.EventType versesChanged,
Verse lower,
Verse upper)
Constructs a PassageEvent object.
|
VerseRange(Versification v11n,
Verse start)
Construct a VerseRange from a Verse.
|
VerseRange(Versification v11n,
Verse start,
Verse end) |
| Modifier and Type | Method and Description |
|---|---|
Verse |
Versification.add(Verse verse,
int n)
Get the verse that is a few verses on from the one we've got.
|
Verse |
Versification.decodeOrdinal(int ordinal)
Where does this verse come in the Bible.
|
Verse |
QualifiedKey.getVerse() |
Verse |
Versification.max(Verse first,
Verse second)
Determine the later of the two verses.
|
Verse |
Versification.min(Verse first,
Verse second)
Determine the earlier of the two verses.
|
Verse |
Versification.next(Verse verse)
Get the verse that is a verses on from the one we've got.
|
Verse |
Versification.patch(BibleBook book,
int chapter,
int verse)
Fix up these verses so that they are as valid a possible.
|
Verse |
Versification.subtract(Verse verse,
int n)
Get the verse n down from here this Verse.
|
| Modifier and Type | Method and Description |
|---|---|
Verse |
Versification.add(Verse verse,
int n)
Get the verse that is a few verses on from the one we've got.
|
private void |
VersificationToKJVMapper.add1ToManyMappings(Verse leftHand,
QualifiedKey kjvHand)
A simple two way entry between 2 1-1 entries.
|
private void |
VersificationToKJVMapper.addForwardMappingFromSingleKeyToRange(Verse leftHand,
QualifiedKey kjvHand)
Adds a forward mappings from left to KJV.
|
private void |
VersificationToKJVMapper.addKJVToMapping(QualifiedKey kjvVerses,
Verse leftKey)
If leftKey is non-null (i.e.
|
private void |
VersificationToKJVMapper.addReverse1ToManyMappings(Verse leftHand,
QualifiedKey kjvHand)
Adds the data into the reverse mappings.
|
int |
Versification.distance(Verse start,
Verse end)
How many verses are there in between the 2 Verses.
|
int |
Versification.getBookCount(Verse start,
Verse end)
The number of books between two verses includes
the books of the two verses and everything in between.
|
int |
Versification.getChapterCount(Verse start,
Verse end)
The number of chapters between two verses includes
the chapters of the two verses and everything in between.
|
int |
Versification.getOrdinal(Verse verse)
Where does this verse come in the Bible.
|
boolean |
Versification.isAdjacentBook(Verse first,
Verse second)
Two verses are in adjacent books if one book
follows the other in this versification.
|
boolean |
Versification.isAdjacentChapter(Verse first,
Verse second)
Two verse are adjacent if one immediately follows the other,
even across book boundaries.
|
boolean |
Versification.isAdjacentVerse(Verse first,
Verse second)
Is this verse adjacent to another verse
|
boolean |
Versification.isBookIntro(Verse verse)
A book introduction is an introduction
that has a chapter of 0.
|
boolean |
Versification.isChapterIntro(Verse verse)
A chapter introduction is an introduction
that has a chapter other than 0
|
boolean |
Versification.isEndOfBook(Verse verse)
The end of the book is indicated by
the chapter number matching the last chapter
in the book and the verse number matching
the last verse in the chapter.
|
boolean |
Versification.isEndOfChapter(Verse verse)
The end of the chapter is indicated by
the verse number matching the last in the chapter.
|
boolean |
Versification.isIntro(Verse verse)
An introduction is a Verse that has a verse number of 0.
|
boolean |
Versification.isSameBook(Verse first,
Verse second)
Two verses are in the same book
when they have the same book.
|
boolean |
Versification.isSameChapter(Verse first,
Verse second)
Two verses are in the same chapter if both
the book and chapter agree.
|
boolean |
Versification.isStartOfBook(Verse verse)
The start of a book is indicated by
a chapter number of 0 or 1 and
a verse number of 0 or 1.
|
boolean |
Versification.isStartOfChapter(Verse verse)
The start of a chapter is indicated by
a verse number of 0 or 1
|
VerseKey |
VersificationsMapper.mapVerse(Verse v,
Versification targetVersification) |
Verse |
Versification.max(Verse first,
Verse second)
Determine the later of the two verses.
|
Verse |
Versification.min(Verse first,
Verse second)
Determine the earlier of the two verses.
|
Verse |
Versification.next(Verse verse)
Get the verse that is a verses on from the one we've got.
|
private void |
QualifiedKey.setKey(Verse key)
Allow override of the key, particular useful if we're constructing in 2 stages like the offset mechanism
|
Verse |
Versification.subtract(Verse verse,
int n)
Get the verse n down from here this Verse.
|
| Constructor and Description |
|---|
QualifiedKey(Verse key)
Construct a QualifiedKey from a Verse.
|