| Package | Description |
|---|---|
| org.crosswire.jsword.book.sword.processing |
Interface and default implementation for the transformation of raw text into XML.
|
| 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 |
|---|---|
void |
RawTextToXmlProcessor.preRange(VerseRange range,
List<org.jdom2.Content> partialDom)
Executes before a range is read from the raw data.
|
void |
NoOpRawTextProcessor.preRange(VerseRange range,
List<org.jdom2.Content> partialDom) |
| Modifier and Type | Field and Description |
|---|---|
private VerseRange |
RangedPassage.VerseRangeIterator.next
What are we going to reply with next?
|
private VerseRange |
AbstractPassage.VerseRangeIterator.nextRange
What is the next VerseRange to be considered
|
protected VerseRange |
PassageTally.TalliedVerseRange.range
The verse range
|
| Modifier and Type | Field and Description |
|---|---|
private Iterator<VerseRange> |
RangedPassage.VerseRangeIterator.real
Where we read our base ranges from
|
private Set<VerseRange> |
RangedPassage.store
The place the real data is stored
|
| Modifier and Type | Method and Description |
|---|---|
abstract VerseRange |
RestrictionType.blur(Versification v11n,
Verse verse,
int blurDown,
int blurUp)
Blur a verse the specified amount.
|
abstract VerseRange |
RestrictionType.blur(Versification v11n,
VerseRange range,
int blurDown,
int blurUp)
Blur a verse range the specified amount.
|
VerseRange |
VerseRange.clone() |
static VerseRange |
VerseRangeFactory.fromString(Versification v11n,
String orginal)
Construct a VerseRange from a human readable string.
|
static VerseRange |
VerseRangeFactory.fromString(Versification v11n,
String original,
VerseRange basis)
Construct a VerseRange from a String and a VerseRange.
|
private static VerseRange |
VerseRangeFactory.fromText(Versification v11n,
String original,
String startVerseDesc,
String endVerseDesc,
VerseRange basis)
The internal mechanism by which we construct a VerseRange
|
VerseRange |
SynchronizedPassage.getRangeAt(int offset,
RestrictionType restrict) |
VerseRange |
RocketPassage.getRangeAt(int offset,
RestrictionType restrict) |
VerseRange |
ReadOnlyPassage.getRangeAt(int offset,
RestrictionType restrict) |
VerseRange |
Passage.getRangeAt(int offset,
RestrictionType restrict)
Get a specific VerseRange from this collection
|
VerseRange |
AbstractPassage.getRangeAt(int offset,
RestrictionType restrict) |
VerseRange |
VerseRange.getWhole() |
static VerseRange |
VerseRange.intersection(VerseRange a,
VerseRange b)
Create a VerseRange that is the stuff in VerseRange a that is also
in VerseRange b.
|
VerseRange |
RangedPassage.VerseRangeIterator.next() |
VerseRange |
PassageTally.OrderedVerseRangeIterator.next() |
VerseRange |
AbstractPassage.VerseRangeIterator.next() |
VerseRange |
OsisParser.parseOsisRef(Versification v11n,
String osisRef)
String OSIS Ref parser, assumes a - separating two osis IDs
|
static VerseRange[] |
VerseRange.remainder(VerseRange a,
VerseRange b)
Create a VerseRange that is the stuff left of VerseRange a when you
remove the stuff in VerseRange b.
|
private VerseRange |
RangedPassage.VerseRangeIterator.replyNext()
The next object is correct, use that one
|
VerseRange |
VerseRange.reversify(Versification newVersification) |
private VerseRange |
RangedPassage.VerseRangeIterator.splitNext()
The next object is too big, so cut it up
|
abstract VerseRange |
RestrictionType.toRange(Versification v11n,
Verse verse,
int count)
Create a range from the verse having the specified number of verses.
|
protected static VerseRange |
AbstractPassage.toVerseRange(Versification v11n,
Object base)
Convert the Object to a VerseRange.
|
| Modifier and Type | Method and Description |
|---|---|
Iterator<VerseRange> |
VerseRange.rangeIterator(RestrictionType restrict)
Enumerate the subranges in this range
|
Iterator<VerseRange> |
SynchronizedPassage.rangeIterator(RestrictionType restrict) |
Iterator<VerseRange> |
RocketPassage.rangeIterator(RestrictionType restrict) |
Iterator<VerseRange> |
ReadOnlyPassage.rangeIterator(RestrictionType restrict) |
Iterator<VerseRange> |
RangedPassage.rangeIterator(RestrictionType restrict) |
Iterator<VerseRange> |
PassageTally.rangeIterator(RestrictionType restrict) |
Iterator<VerseRange> |
Passage.rangeIterator(RestrictionType restrict)
Like iterator() that iterates over VerseRanges instead of Verses.
|
Iterator<VerseRange> |
AbstractPassage.rangeIterator(RestrictionType restrict) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
VerseRange.adjacentTo(VerseRange that)
Are the 2 VerseRanges in question contiguous.
|
abstract VerseRange |
RestrictionType.blur(Versification v11n,
VerseRange range,
int blurDown,
int blurUp)
Blur a verse range the specified amount.
|
boolean |
VerseRange.contains(VerseRange that)
Is the given range within our range.
|
abstract Verse |
AccuracyType.createStartVerse(Versification v11n,
VerseRange verseRangeBasis,
String[] parts) |
static VerseRange |
VerseRangeFactory.fromString(Versification v11n,
String original,
VerseRange basis)
Construct a VerseRange from a String and a VerseRange.
|
static Verse |
VerseFactory.fromString(Versification v11n,
String original,
VerseRange verseRangeBasis)
Construct a Verse from a String and a VerseRange.
|
static AccuracyType |
AccuracyType.fromText(Versification v11n,
String original,
String[] parts,
AccuracyType verseAccuracy,
VerseRange basis)
Does this string exactly define a Verse.
|
static AccuracyType |
AccuracyType.fromText(Versification v11n,
String original,
String[] parts,
VerseRange basis) |
private static VerseRange |
VerseRangeFactory.fromText(Versification v11n,
String original,
String startVerseDesc,
String endVerseDesc,
VerseRange basis)
The internal mechanism by which we construct a VerseRange
|
static VerseRange |
VerseRange.intersection(VerseRange a,
VerseRange b)
Create a VerseRange that is the stuff in VerseRange a that is also
in VerseRange b.
|
boolean |
VerseRange.overlaps(VerseRange that)
Do the 2 VerseRanges in question actually overlap.
|
static VerseRange[] |
VerseRange.remainder(VerseRange a,
VerseRange b)
Create a VerseRange that is the stuff left of VerseRange a when you
remove the stuff in VerseRange b.
|
| Constructor and Description |
|---|
PassageTally.TalliedVerseRange(VerseRange range,
int tally)
Convenience ctor to set the public variables
|
VerseRange.VerseIterator(VerseRange range)
Ctor
|
VerseRange(VerseRange a,
VerseRange b)
Merge 2 VerseRanges together.
|
| Constructor and Description |
|---|
RangedPassage.VerseIterator(Versification v11n,
Iterator<VerseRange> it)
Create a basic iterator that is a proxy for the RangedPassage
Passages iterator, with remove() overridden.
|
RangedPassage.VerseRangeIterator(Iterator<VerseRange> it,
RestrictionType restrict)
Simple ctor
|
| Modifier and Type | Method and Description |
|---|---|
VerseRange |
Versification.getAllVerses()
Get a VerseRange encompassing this Versification.
|
| Modifier and Type | Method and Description |
|---|---|
private void |
QualifiedKey.setKey(VerseRange key)
Allow override of the key, particular useful if we're constructing in 2 stages like the offset mechanism
|
| Constructor and Description |
|---|
QualifiedKey(VerseRange key)
Construct a QualifiedKey from a Verse.
|