## Uses of Class
org.crosswire.jsword.versification.Versification

- Packages that use Versification
  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.sword | An implementation of the Book interfaces that reads from SWORD project books (modules).
  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.
  org.crosswire.jsword.versification.system | The System package defines each of the known Versifications.

- - ### Uses of Versification in org.crosswire.jsword.book

    Methods in org.crosswire.jsword.book that return Versification
    Modifier and Type | Method and Description
    --- | ---
    `private Versification` | BookData.`getVersification(int i)`

    Methods in org.crosswire.jsword.book with parameters of type Versification
    Modifier and Type | Method and Description
    --- | ---
    `static String` | OSISUtil.`getReferences(Book book, Key key, Versification v11n, org.jdom2.Element root)` A space separate string containing osisID from the reference element.
    `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.

  - ### Uses of Versification in org.crosswire.jsword.book.basic

    Fields in org.crosswire.jsword.book.basic declared as Versification
    Modifier and Type | Field and Description
    --- | ---
    `private Versification` | AbstractPassageBook.`versificationSystem` Versification system, created lazily, so use getter

    Methods in org.crosswire.jsword.book.basic that return Versification
    Modifier and Type | Method and Description
    --- | ---
    `Versification` | AbstractPassageBook.`getVersification()`

  - ### Uses of Versification in org.crosswire.jsword.book.sword

    Methods in org.crosswire.jsword.book.sword with parameters of type Versification
    Modifier and Type | Method and Description
    --- | ---
    `void` | ZVerseBackend.`dumpIdxRaf(Versification v11n, int ordinalStart, RandomAccessFile raf)` Experimental code.

  - ### Uses of Versification in org.crosswire.jsword.index.lucene

    Fields in org.crosswire.jsword.index.lucene declared as Versification
    Modifier and Type | Field and Description
    --- | ---
    `private Versification` | VerseCollector.`v11n`

    Constructors in org.crosswire.jsword.index.lucene with parameters of type Versification
    Constructor and Description
    `VerseCollector(Versification v11n, org.apache.lucene.search.Searcher searcher, Key results)` Create a collector for the searcher that populates results.

  - ### Uses of Versification in org.crosswire.jsword.passage

    Fields in org.crosswire.jsword.passage declared as Versification
    Modifier and Type | Field and Description
    --- | ---
    `private Versification` | PassageTally.OrderedVerseIterator.`referenceSystem` The Versification is needed to decode board positions.
    `private Versification` | VerseRange.`v11n` The Versification with which this range is defined.
    `private Versification` | VerseRange.VerseIterator.`v11n`
    `private Versification` | Verse.`v11n` The versification for this verse.
    `private Versification` | AbstractPassage.`v11n` The Versification to which this passage belongs.
    `private Versification` | AbstractPassage.VerseRangeIterator.`v11n` The Versification to which these verses belong.

    Methods in org.crosswire.jsword.passage that return Versification
    Modifier and Type | Method and Description
    --- | ---
    `Versification` | VerseRange.`getVersification()`
    `Versification` | VerseKey.`getVersification()` Get the Versification that defines the Verses in this VerseKey.
    `Versification` | Verse.`getVersification()`
    `Versification` | SynchronizedPassage.`getVersification()`
    `Versification` | ReadOnlyPassage.`getVersification()`
    `Versification` | AbstractPassage.`getVersification()`
    `static Versification` | KeyUtil.`getVersification(Key key)` Get the versification for the key or the default versification.

    Methods in org.crosswire.jsword.passage with parameters of type Versification
    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.
    `Key` | PassageKeyFactory.`createEmptyKeyList(Versification v11n)` Create an empty list of keys for the v11n
    `abstract Passage` | PassageType.`createEmptyPassage(Versification v11n)` Create an empty, optimized passage
    `abstract Verse` | AccuracyType.`createEndVerse(Versification v11n, Verse verseBasis, String[] endParts)`
    `Passage` | PassageType.`createPassage(Versification v11n, String passage)`
    `abstract Passage` | PassageType.`createPassage(Versification v11n, String passage, Key basis)` Create an optimized passage
    `abstract Verse` | AccuracyType.`createStartVerse(Versification v11n, VerseRange verseRangeBasis, String[] parts)`
    `static VerseRange` | VerseRangeFactory.`fromString(Versification v11n, String orginal)` Construct a VerseRange from a human readable string.
    `static Verse` | VerseFactory.`fromString(Versification v11n, String original)` Construct a Verse from a String - something like "Gen 1:1".
    `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)` Determine how closely the string defines a verse.
    `static AccuracyType` | AccuracyType.`fromText(Versification v11n, String original, String[] parts, AccuracyType verseAccuracy)`
    `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 int` | AccuracyType.`getChapter(Versification v11n, BibleBook lbook, String chapter)` Interprets the chapter value, which is either a number or "ff" or "$" (meaning "what follows")
    `Key` | PassageKeyFactory.`getGlobalKeyList(Versification v11n)` Get a Passage containing all the Verses in this Versification.
    `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.
    `Key` | PassageKeyFactory.`getValidKey(Versification v11n, String passageReference)` Convert the passageReference into a Passage or an empty Passage, if there is an error.
    `Key` | PassageKeyFactory.`getValidKey(Versification v11n, String passageReference, Key basis)` Convert the passageReference into a Passage or an empty Passage, if there is an error.
    `static int` | AccuracyType.`getVerse(Versification v11n, BibleBook lbook, int lchapter, String verse)` Interprets the verse value, which is either a number or "ff" or "$" (meaning "what follows")
    `abstract boolean` | RestrictionType.`isSameScope(Versification v11n, Verse start, Verse end)` Are the two verses in the same scope.
    `private Verse` | OsisParser.`parseOsisID(Versification v11n, List<String> osisIDParts)`
    `Verse` | OsisParser.`parseOsisID(Versification v11n, String osisID)` Strict OSIS ID parsers, case-sensitive
    `VerseRange` | OsisParser.`parseOsisRef(Versification v11n, String osisRef)` String OSIS Ref parser, assumes a - separating two osis IDs
    `VerseRange` | VerseRange.`reversify(Versification newVersification)`
    `T` | VerseKey.`reversify(Versification newVersification)` Cast this VerseKey into another Versification.
    `Verse` | Verse.`reversify(Versification newVersification)`
    `Passage` | SynchronizedPassage.`reversify(Versification newVersification)`
    `Passage` | ReadOnlyPassage.`reversify(Versification newVersification)`
    `Passage` | AbstractPassage.`reversify(Versification newVersification)`
    `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.

    Constructors in org.crosswire.jsword.passage with parameters of type Versification
    Constructor and Description
    `AbstractPassage.VerseRangeIterator(Versification v11n, Iterator<Key> it, RestrictionType restrict)` iterate, amalgamating Verses into VerseRanges
    `AbstractPassage(Versification v11n)` Setup that leaves original name being null
    `AbstractPassage(Versification v11n, String passageName)` Setup the original name of this reference
    `BitwisePassage(Versification v11n)` Create an empty BitwisePassage.
    `BitwisePassage(Versification v11n, String refs)` Create a Verse from a human readable string.
    `BitwisePassage(Versification v11n, String refs, Key basis)` Create a Verse from a human readable string.
    `DistinctPassage(Versification v11n)` Create an empty DistinctPassage.
    `DistinctPassage(Versification v11n, String refs)`
    `DistinctPassage(Versification v11n, String refs, Key basis)` Create a Verse from a human readable string.
    `PassageTally.OrderedVerseIterator(Versification v11n, int[] board)` Find the first unused verse
    `PassageTally.OrderedVerseRangeIterator(Versification v11n, Iterator<Key> vit, int[] board)` Find the first unused verse
    `PassageTally(Versification v11n)` Create an empty PassageTally
    `PassageTally(Versification v11n, String refs)`
    `PassageTally(Versification v11n, String refs, Key basis)` Create a Verse from a human readable string.
    `RangedPassage.VerseIterator(Versification v11n, Iterator<VerseRange> it)` Create a basic iterator that is a proxy for the RangedPassage Passages iterator, with remove() overridden.
    `RangedPassage(Versification refSystem)` Create an empty RangedPassage.
    `RangedPassage(Versification v11n, String refs)`
    `RangedPassage(Versification v11n, String refs, Key basis)` Create a Verse from a human readable string.
    `RocketPassage(Versification v11n)` Create a new RocketPassage
    `RocketPassage(Versification v11n, String refs)` Create a Verse from a human readable string.
    `RocketPassage(Versification v11n, String refs, Key basis)` Create a Verse from a human readable string.
    `Verse(Versification v11n, BibleBook book, int chapter, int verse)` Create a Verse from book, chapter and verse numbers, throwing up if the specified Verse does not exist.
    `Verse(Versification v11n, BibleBook book, int chapter, int verse, boolean patchUp)` Create a Verse from book, chapter and verse numbers, patching up if the specified verse does not exist.
    `Verse(Versification v11n, BibleBook book, int chapter, int verse, String subIdentifier)` Create a Verse from book, chapter and verse numbers, throwing up if the specified Verse does not exist.
    `Verse(Versification v11n, int ordinal)` Set a Verse using a verse ordinal number - WARNING Do not use this method unless you really know the dangers of doing so.
    `VerseRange(Versification v11n)` The default VerseRange is a single verse - Genesis 1:1.
    `VerseRange(Versification v11n, Verse start)` Construct a VerseRange from a Verse.
    `VerseRange(Versification v11n, Verse start, Verse end)`

  - ### Uses of Versification in org.crosswire.jsword.versification

    Fields in org.crosswire.jsword.versification declared as Versification
    Modifier and Type | Field and Description
    --- | ---
    `private static Versification` | VersificationsMapper.`KJV`
    `private static Versification` | VersificationToKJVMapper.`KJV`
    `private Versification` | VersificationToKJVMapper.`nonKjv`

    Fields in org.crosswire.jsword.versification with type parameters of type Versification
    Modifier and Type | Field and Description
    --- | ---
    `private static Map<Versification,VersificationToKJVMapper>` | VersificationsMapper.`MAPPERS`

    Methods in org.crosswire.jsword.versification with parameters of type Versification
    Modifier and Type | Method and Description
    --- | ---
    `private Passage` | VersificationToKJVMapper.`createEmptyPassage(Versification versification)` Simplify creation of an empty passage object of the default type, with the required v11n.
    `private void` | VersificationsMapper.`ensure(Versification versification)` Reads the mapping from file if it does not exist
    `void` | VersificationsMapper.`ensureMappingDataLoaded(Versification versification)` Call this to ensure mapping data is loaded (maybe for newly installed books).
    `private QualifiedKey` | VersificationToKJVMapper.`getAbsentQualifiedKey(Versification versification, String versesKey)` Deals with absent markers, whether absent in the KJV or absent in the current versification.
    `private QualifiedKey` | VersificationToKJVMapper.`getExistingQualifiedKey(Versification versification, String versesKey)` Deals with real keys found in the versification.
    `private VerseKey` | VersificationsMapper.`getKeyFromQualifiedKeys(Versification versification, List<QualifiedKey> kjvVerses)`
    `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 VerseKey` | VersificationsMapper.`guessKeyFromKjvVerses(Versification targetVersification, List<QualifiedKey> kjvVerses)` This is a last attempt at trying to get something, on the basis that something is better than nothing.
    `Passage` | VersificationsMapper.`map(Passage key, Versification target)` Maps a whole passage, and does so verse by verse.
    `VerseKey` | VersificationsMapper.`mapVerse(Verse v, Versification targetVersification)`
    `QualifiedKey` | QualifiedKey.`reversify(Versification target)` Convert this QualifiedKey from one Versification to another.

    Constructors in org.crosswire.jsword.versification with parameters of type Versification
    Constructor and Description
    `FileVersificationMapping(Versification versification)`
    `VersificationToKJVMapper(Versification nonKjv, FileVersificationMapping mapping)`

  - ### Uses of Versification in org.crosswire.jsword.versification.system

    Subclasses of Versification in org.crosswire.jsword.versification.system
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SystemCalvin` Versification for French Olivétan and derivatives Bibles.
    `class` | `SystemCatholic`
    `class` | `SystemCatholic2` The Catholic2 Versification differs from Catholic in that Esther 10 has 13 verses rather than 3 and Esther has 16 chapters rather than 10.
    `class` | `SystemDarbyFR` This versification scheme is based on the French Darby translation.
    `class` | `SystemDefault` The SystemDefault versification (v11n) is that of the Protestant KJV.
    `class` | `SystemGerman`
    `class` | `SystemKJV` The KJV versification is the first implemented versification and is the default versification for JSword/SWORD.
    `class` | `SystemKJVA`
    `class` | `SystemLeningrad` The Leningrad Codex versification differs from the Masoretic Text (MT) versification only in the placement of 1 and 2 Chronicles.
    `class` | `SystemLuther`
    `class` | `SystemLXX` LXX a compromise versification system, intended to allow encoding of Bibles using a number of slightly varying LXX-based versification systems.
    `class` | `SystemMT` The Masoretic Text (MT) versification differs from the Leningrad Codex versification only in the placement of 1 and 2 Chronicles.
    `class` | `SystemNRSV` The NRSV Versification is nearly the same as the KJV versification.
    `class` | `SystemNRSVA`
    `class` | `SystemOrthodox` Orthodox is based on the LXX versification system.
    `class` | `SystemSegond` This versification for L Segond Bibles.
    `class` | `SystemSynodal` The Synodal versification data is based on the Synodal and Slavonic translations from rusbible dot ru (of early 2009) and the BFBS Synodal database, as supplied by Konstantin Maslyuk.
    `class` | `SystemSynodalProt` The SynodalP versification is essentially the KJV v11n, using its chapter counts, but with a modified NT book order similar to those of the Synodal v11n and merged with verse counts similar to those of the Synodal v11n
    `class` | `SystemVulg`

    Fields in org.crosswire.jsword.versification.system with type parameters of type Versification
    Modifier and Type | Field and Description
    --- | ---
    `private Map<String,Versification>` | Versifications.`fluffed` The map of instantiated Versifications, given by their names.

    Methods in org.crosswire.jsword.versification.system that return Versification
    Modifier and Type | Method and Description
    --- | ---
    `private Versification` | Versifications.`fluff(String name)`
    `Versification` | Versifications.`getDefaultVersification()` Deprecated. Use `Versifications.getVersification(String)` instead.
    `Versification` | Versifications.`getVersification(String name)` Get the Versification by its name.

    Methods in org.crosswire.jsword.versification.system with parameters of type Versification
    Modifier and Type | Method and Description
    --- | ---
    `void` | Versifications.`register(Versification rs)` Add a Versification that is not predefined by JSword.