org.crosswire.jsword.versification
Class BibleNames

java.lang.Object
  org.crosswire.jsword.versification.BibleNames

final class BibleNames
extends Object

BibleNames deals with locale sensitive BibleBook name lookup conversions.

Author:

Joe Walker [joe at eireneh dot com], DM Smith [dmsmith555 at yahoo dot com]

See Also:

for license details.
The copyright to this program is held by it's authors.

Field Summary

private static String	ALT_KEY
private Map<String,BookName>	altBooksMap Alternative shortened names for the book of the Bible, normalized, generated at runtime
private BookName[]	books
private static String	FULL_KEY
private Map<String,BookName>	fullBooksMap The full names of the book of the Bible, normalized, generated at runtime
private Locale	locale The locale for the Bible Names
private static String	SHORT_KEY
private Map<String,BookName>	shortBooksMap Standard shortened names for the book of the Bible, normalized, generated at runtime.

Constructor Summary

BibleNames(Locale locale)
Create BibleNames for the given locale

Method Summary

(package private) BibleBook	getBook(String find) Get number of a book from its name.
(package private) BookName	getBookName(BibleBook book)
(package private) String	getLongName(BibleBook book) Get the full name of a book (e.g.
(package private) String	getPreferredName(BibleBook book) Get the preferred name of a book.
(package private) String	getShortName(BibleBook book) Get the short name of a book (e.g.
private String	getString(ResourceBundle resources, String key)
private void	initialize() Load up the resources for Bible book and section names, and cache the upper and lower versions of them.
(package private) boolean	isBookName(String find) Is the given string a valid book name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FULL_KEY

private static final String FULL_KEY

See Also:

Constant Field Values

SHORT_KEY

private static final String SHORT_KEY

See Also:

Constant Field Values

ALT_KEY

private static final String ALT_KEY

See Also:

Constant Field Values

books

private BookName[] books

locale

private Locale locale

The locale for the Bible Names

fullBooksMap

private Map<String,BookName> fullBooksMap

The full names of the book of the Bible, normalized, generated at runtime

shortBooksMap

private Map<String,BookName> shortBooksMap

Standard shortened names for the book of the Bible, normalized, generated at runtime.

altBooksMap

private Map<String,BookName> altBooksMap

Alternative shortened names for the book of the Bible, normalized, generated at runtime

Constructor Detail

BibleNames

BibleNames(Locale locale)

Create BibleNames for the given locale

Method Detail

getBookName

BookName getBookName(BibleBook book)

getPreferredName

String getPreferredName(BibleBook book)

Get the preferred name of a book. Altered by the case setting (see setBookCase() and isFullBookName())

Parameters:

book - The book of the Bible

Returns:

The full name of the book

getLongName

String getLongName(BibleBook book)

Get the full name of a book (e.g. "Genesis"). Altered by the case setting (see setBookCase())

Parameters:

book - The book of the Bible

Returns:

The full name of the book

getShortName

String getShortName(BibleBook book)

Get the short name of a book (e.g. "Gen"). Altered by the case setting (see setBookCase())

Parameters:

book - The book of the Bible

Returns:

The short name of the book

getBook

BibleBook getBook(String find)

Get number of a book from its name.

Parameters:

find - The string to identify

Returns:

The BibleBook, On error null

isBookName

boolean isBookName(String find)

Is the given string a valid book name. If this method returns true then getBook() will return a BibleBook and not null.

Parameters:

find - The string to identify

Returns:

true if the book name is known

initialize

private void initialize()

Load up the resources for Bible book and section names, and cache the upper and lower versions of them.

getString

private String getString(ResourceBundle resources,
                         String key)