A B C D E F G H I J K L M N O P Q R S T U V W X Z

R

raiseEventSuppresion() - Method in class org.crosswire.jsword.passage.AbstractPassage

If things want to prevent event firing because they are doing a set of changes that should be notified in one go, this is what to call.

raiseNormalizeProtection() - Method in class org.crosswire.jsword.passage.AbstractPassage

If things want to prevent normalization because they are doing a set of changes that should be normalized in one go, this is what to call.

range - Variable in class org.crosswire.jsword.passage.PassageTally.TalliedVerseRange

The verse range

RANGE_OSIS_DELIM - Static variable in class org.crosswire.jsword.passage.VerseRange

What characters can we use to separate the 2 parts to a VerseRanges

RANGE_PATTERN - Static variable in class org.crosswire.jsword.index.lucene.LuceneQueryBuilder

The pattern of a range.

RANGE_PREF_DELIM - Static variable in class org.crosswire.jsword.passage.VerseRange

What characters should we use to separate VerseRange parts on output

RANGED - Static variable in class org.crosswire.jsword.passage.AbstractPassage

Serialization type constant for a Ranged layout

ranged - Variable in class org.crosswire.jsword.passage.RocketPassage

The contained RangedPassage

RangedPassage - Class in org.crosswire.jsword.passage

A Passage that is implemented using a TreeSet of VerseRanges.

RangedPassage(Versification) - Constructor for class org.crosswire.jsword.passage.RangedPassage

Create an empty RangedPassage.

RangedPassage(Versification, String, Key) - Constructor for class org.crosswire.jsword.passage.RangedPassage

Create a Verse from a human readable string.

RangedPassage(Versification, String) - Constructor for class org.crosswire.jsword.passage.RangedPassage

RangedPassage.VerseIterator - Class in org.crosswire.jsword.passage

This class is here to prevent users of RangedPassage.iterator() from altering the underlying store and getting us out of sync.

RangedPassage.VerseIterator(Versification, Iterator<VerseRange>) - Constructor for class org.crosswire.jsword.passage.RangedPassage.VerseIterator

Create a basic iterator that is a proxy for the RangedPassage Passages iterator, with remove() overridden.

RangedPassage.VerseRangeIterator - Class in org.crosswire.jsword.passage

Loop over the VerseRanges and check that they do not require digging into

RangedPassage.VerseRangeIterator(Iterator<VerseRange>, RestrictionType) - Constructor for class org.crosswire.jsword.passage.RangedPassage.VerseRangeIterator

Simple ctor

rangeIterator(RestrictionType) - Method in class org.crosswire.jsword.passage.AbstractPassage

rangeIterator(RestrictionType) - Method in interface org.crosswire.jsword.passage.Passage

Like iterator() that iterates over VerseRanges instead of Verses.

rangeIterator(RestrictionType) - Method in class org.crosswire.jsword.passage.PassageTally

rangeIterator(RestrictionType) - Method in class org.crosswire.jsword.passage.RangedPassage

rangeIterator(RestrictionType) - Method in class org.crosswire.jsword.passage.ReadOnlyPassage

rangeIterator(RestrictionType) - Method in class org.crosswire.jsword.passage.RocketPassage

rangeIterator(RestrictionType) - Method in class org.crosswire.jsword.passage.SynchronizedPassage

rangeIterator(RestrictionType) - Method in class org.crosswire.jsword.passage.VerseRange

Enumerate the subranges in this range

RangeQuery - Class in org.crosswire.jsword.index.query

A range query specifies how a range should be included in the search.

RangeQuery(String) - Constructor for class org.crosswire.jsword.index.query.RangeQuery

Construct a query from the range specification.

ranked - Variable in class org.crosswire.jsword.index.search.DefaultSearchModifier

The indicator of whether the request should be ranked.

rankedSearch() - Method in class org.crosswire.jsword.examples.APIExamples

An example of how to perform a ranked search.

ratchet - Variable in class org.crosswire.common.crypt.Sapphire

RawBackend<T extends RawBackendState> - Class in org.crosswire.jsword.book.sword

Both Books and Commentaries seem to use the same format so this class abstracts out the similarities.

RawBackend(SwordBookMetaData, int) - Constructor for class org.crosswire.jsword.book.sword.RawBackend

Simple ctor

RawBackendState - Class in org.crosswire.jsword.book.sword.state

Stores the random access files required for processing the passage request The caller is required to close to correctly free resources and avoid File pointer leaks

RawBackendState(SwordBookMetaData) - Constructor for class org.crosswire.jsword.book.sword.state.RawBackendState

This is default package access for forcing the use of the OpenFileStateManager to manage the creation.

RawFileBackend - Class in org.crosswire.jsword.book.sword

A Raw File format that allows for each verse to have it's own storage.

RawFileBackend(SwordBookMetaData, int) - Constructor for class org.crosswire.jsword.book.sword.RawFileBackend

RawFileBackendState - Class in org.crosswire.jsword.book.sword.state

Stores the random access files required for processing the passage request The caller is required to close to correctly free resources and avoid File pointer leaks

RawFileBackendState(SwordBookMetaData) - Constructor for class org.crosswire.jsword.book.sword.state.RawFileBackendState

This is default package access for forcing the use of the OpenFileStateManager to manage the creation.

RawLDBackend<T extends RawLDBackendState> - Class in org.crosswire.jsword.book.sword

An implementation AbstractKeyBackend to read RAW format files.

RawLDBackend(SwordBookMetaData, int) - Constructor for class org.crosswire.jsword.book.sword.RawLDBackend

Simple ctor

RawLDBackendState - Class in org.crosswire.jsword.book.sword.state

State for RawLDBackend

RawLDBackendState(SwordBookMetaData) - Constructor for class org.crosswire.jsword.book.sword.state.RawLDBackendState

This is default package access for forcing the use of the OpenFileStateManager to manage the creation.

RawTextToXmlProcessor - Interface in org.crosswire.jsword.book.sword.processing

This interface declares operations to be carried out after Raw Text has been read from a backend, before it is returned as OSIS to the caller.

read(Reader) - Static method in class org.crosswire.common.util.StringUtil

This method reads an InputStream In its entirety, and passes The text back as a string.

readDescription(Reader) - Method in class org.crosswire.jsword.passage.AbstractPassage

readDescription(Reader) - Method in interface org.crosswire.jsword.passage.Passage

To be compatible with humans we read/write ourselves to a file that a human can read and even edit.

readDescription(Reader) - Method in class org.crosswire.jsword.passage.ReadOnlyPassage

readDescription(Reader) - Method in class org.crosswire.jsword.passage.SynchronizedPassage

readDictionary() - Method in class org.crosswire.jsword.examples.APIExamples

While Bible and Commentary are very similar, a Dictionary is read in a slightly different way.

reader - Variable in class org.crosswire.common.xml.StringSAXEventProvider

The SAX parser

readHome - Variable in class org.crosswire.common.util.CWProject

The readable home for this application, specified by the system property jsword.home.

readIncfile() - Method in class org.crosswire.jsword.book.sword.state.RawFileBackendState

readIndex() - Method in class org.crosswire.jsword.book.sword.AbstractBackend

readIndex() - Method in interface org.crosswire.jsword.book.sword.Backend

Deprecated. no replacement

readIndex() - Method in class org.crosswire.jsword.book.sword.GenBookBackend

readIndex() - Method in class org.crosswire.jsword.book.sword.NullBackend

ReadingsBook - Class in org.crosswire.jsword.book.readings

A Dictionary that displays daily Readings.

ReadingsBook(ReadingsBookDriver, String, BookCategory) - Constructor for class org.crosswire.jsword.book.readings.ReadingsBook

Constructor for ReadingsBook.

ReadingsBookDriver - Class in org.crosswire.jsword.book.readings

A driver for the readings dictionary.

ReadingsBookDriver() - Constructor for class org.crosswire.jsword.book.readings.ReadingsBookDriver

Setup the array of BookMetaDatas

ReadingsBookDriver.ReadingsFilter - Class in org.crosswire.jsword.book.readings

Get all files mentioned by readings.txt

ReadingsBookDriver.ReadingsFilter() - Constructor for class org.crosswire.jsword.book.readings.ReadingsBookDriver.ReadingsFilter

ReadingsKey - Class in org.crosswire.jsword.book.readings

For a readings dictionary the keys are dates.

ReadingsKey(String, String, Key) - Constructor for class org.crosswire.jsword.book.readings.ReadingsKey

Simple Constructor.

ReadingsKey(Date) - Constructor for class org.crosswire.jsword.book.readings.ReadingsKey

Simple Constructor.

readNextRAF(RandomAccessFile, int) - Static method in class org.crosswire.jsword.book.sword.SwordUtil

Read a RandomAccessFile from the current location in the file.

readNormalOsis(Key, RawTextToXmlProcessor, List<Content>, T) - Method in class org.crosswire.jsword.book.sword.AbstractBackend

readNormalOsisSingleKey(Key, RawTextToXmlProcessor, List<Content>, T) - Method in class org.crosswire.jsword.book.sword.AbstractBackend

Avoid using iterator for GenBook TreeKeys which would cause a GenBook nodes children to be appended to their parent e.g.

readObject(ObjectInputStream) - Method in class org.crosswire.common.config.ConfigEvent

Serialization support.

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.book.BooksEvent

Serialization support.

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.book.install.InstallerEvent

Serialization support.

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.book.sword.RawLDBackend

Serialization support.

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.book.sword.ZLDBackend

Serialization support.

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.passage.AbstractPassage

Serialization support.

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.passage.BitwisePassage

Call the support mechanism in AbstractPassage

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.passage.DistinctPassage

Call the support mechanism in AbstractPassage

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.passage.PassageTally

Call the support mechanism in AbstractPassage

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.passage.RangedPassage

Call the support mechanism in AbstractPassage

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.passage.RocketPassage

Serialization support

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.passage.Verse

Write out the object to the given ObjectOutputStream

readObject(ObjectInputStream) - Method in class org.crosswire.jsword.passage.VerseRange

Write out the object to the given ObjectOutputStream

readObjectSupport(ObjectInputStream) - Method in class org.crosswire.jsword.passage.AbstractPassage

Write out the object to the given ObjectOutputStream

ReadOnlyKeyList - Class in org.crosswire.jsword.passage

A read-only wrapper around any writable implementation of Key.

ReadOnlyKeyList(Key, boolean) - Constructor for class org.crosswire.jsword.passage.ReadOnlyKeyList

Simple ctor

ReadOnlyPassage - Class in org.crosswire.jsword.passage

This is a simple proxy to a real Passage object that denies all attempts to write to it.

ReadOnlyPassage(Passage, boolean) - Constructor for class org.crosswire.jsword.passage.ReadOnlyPassage

Construct a ReadOnlyPassage from a real Passage to which we proxy.

readPassage(Reader) - Static method in class org.crosswire.jsword.passage.PassageKeyFactory

Read a passage from a given stream

readPassageOsis(Key, RawTextToXmlProcessor, List<Content>, T) - Method in class org.crosswire.jsword.book.sword.AbstractBackend

Reads a passage as OSIS

readRAF(RandomAccessFile, long, int) - Static method in class org.crosswire.jsword.book.sword.SwordUtil

Read a RandomAccessFile

readRawContent(GenBookBackendState, Key) - Method in class org.crosswire.jsword.book.sword.GenBookBackend

readRawContent(RawBackendState, Key) - Method in class org.crosswire.jsword.book.sword.RawBackend

readRawContent(RawLDBackendState, Key) - Method in class org.crosswire.jsword.book.sword.RawLDBackend

readRawContent(RawLDBackendState, String) - Method in class org.crosswire.jsword.book.sword.RawLDBackend

readRawContent(T, Key) - Method in interface org.crosswire.jsword.book.sword.StatefulFileBackedBackend

readRawContent(ZVerseBackendState, Key) - Method in class org.crosswire.jsword.book.sword.ZVerseBackend

readStyledText(String, String, int) - Method in class org.crosswire.jsword.examples.APIExamples

Obtain styled text (in this case HTML) for a book reference.

readSwordConf(List<File>, File) - Static method in class org.crosswire.jsword.book.sword.SwordBookPath

readSwordConf(List<File>, String) - Static method in class org.crosswire.jsword.book.sword.SwordBookPath

readTextDataFile(File) - Method in class org.crosswire.jsword.book.sword.RawFileBackend

readToOsis(Key, RawTextToXmlProcessor) - Method in class org.crosswire.jsword.book.sword.AbstractBackend

readToOsis(Key, RawTextToXmlProcessor) - Method in interface org.crosswire.jsword.book.sword.Backend

Get the text allotted for the given entry

readToOsis(Key, RawTextToXmlProcessor) - Method in class org.crosswire.jsword.book.sword.NullBackend

readUntilRAF(RandomAccessFile, int, byte) - Static method in class org.crosswire.jsword.book.sword.SwordUtil

Read a RandomAccessFile until a particular byte is seen

readUntilRAF(RandomAccessFile, byte) - Static method in class org.crosswire.jsword.book.sword.SwordUtil

Read a RandomAccessFile until a particular byte is seen

real - Variable in class org.crosswire.jsword.passage.RangedPassage.VerseIterator

The Iterator that we are proxying to

real - Variable in class org.crosswire.jsword.passage.RangedPassage.VerseRangeIterator

Where we read our base ranges from

recloseTags(String) - Static method in class org.crosswire.common.xml.XMLUtil

Strip all closing tags from the end of the XML fragment, and then re-close all tags that are open at the end of the string.

recurseChildren(Element, StringBuilder) - Static method in class org.crosswire.jsword.book.OSISUtil

Helper to extract the Strings from a nest of JDOM elements

recurseDeepContent(Element, String, List<Content>) - Static method in class org.crosswire.jsword.book.OSISUtil

Find all the instances of elements of type find under the element div.

recurseElement(Object, StringBuilder) - Static method in class org.crosswire.jsword.book.OSISUtil

If we have a String just add it to the buffer, but if we have an Element then try to dig the strings out of it.

RedLetterText - Class in org.crosswire.common.xml

RedLetterText remembers when text should be red.

RedLetterText() - Constructor for class org.crosswire.common.xml.RedLetterText

Construct a RedLetterText.

reduceMemoryUsage(Kill) - Static method in class org.crosswire.common.activate.Activator

If we need to tighten things up a bit we can save memory with this

reduceMemoryUsage() - Method in enum org.crosswire.common.activate.Kill

ref - Variable in class org.crosswire.jsword.passage.ReadOnlyPassage

The object we are proxying to

ref - Variable in class org.crosswire.jsword.passage.SynchronizedPassage

The object we are proxying to

REF_ALLOWED_DELIMS - Static variable in class org.crosswire.jsword.passage.AbstractPassage

What characters can we use to separate VerseRanges in a Passage

REF_OSIS_DELIM - Static variable in class org.crosswire.jsword.passage.AbstractPassage

What characters should we use to separate VerseRanges in a Passage

REF_PREF_DELIM - Static variable in class org.crosswire.jsword.passage.AbstractPassage

What characters should we use to separate VerseRanges in a Passage

ReferenceSystem - Interface in org.crosswire.jsword.book

A ReferenceSystem is a marker interface.

referenceSystem - Variable in class org.crosswire.jsword.passage.PassageTally.OrderedVerseIterator

The Versification is needed to decode board positions.

ReflectionUtil - Class in org.crosswire.common.util

Various utilities for calling constructors and methods via introspection.

ReflectionUtil() - Constructor for class org.crosswire.common.util.ReflectionUtil

Prevent instantiation

refreshBooks() - Static method in class org.crosswire.jsword.book.Defaults

Create book lists for every type of book.

register() - Method in class org.crosswire.common.util.Translations

Register this class with the common config engine.

register(Versification) - Method in class org.crosswire.jsword.versification.system.Versifications

Add a Versification that is not predefined by JSword.

registerDriver(BookDriver) - Method in class org.crosswire.jsword.book.Books

Register the driver, adding its books to the list.

registerNewBook(SwordBookMetaData) - Static method in class org.crosswire.jsword.book.sword.SwordBookDriver

A helper class for the SwordInstaller to tell us that it has copied a new Book into our install directory

release(OpenFileState) - Method in class org.crosswire.jsword.book.sword.state.OpenFileStateManager

releaseResources() - Method in class org.crosswire.jsword.book.sword.state.GenBookBackendState

releaseResources() - Method in interface org.crosswire.jsword.book.sword.state.OpenFileState

releaseResources() - Method in class org.crosswire.jsword.book.sword.state.RawBackendState

releaseResources() - Method in class org.crosswire.jsword.book.sword.state.RawLDBackendState

releaseResources() - Method in class org.crosswire.jsword.book.sword.state.ZLDBackendState

releaseResources() - Method in class org.crosswire.jsword.book.sword.state.ZVerseBackendState

RELOAD_BOOK_LIST - Static variable in interface org.crosswire.common.progress.Progress

reloadBookList() - Method in interface org.crosswire.jsword.book.install.Installer

Re-fetch a list of names from the remote source.

reloadBookList() - Method in class org.crosswire.jsword.book.install.sword.AbstractSwordInstaller

reloadBookList(String) - Method in class org.crosswire.jsword.bridge.BookInstaller

Reload the local cache for a remote repository.

remainder(VerseRange, VerseRange) - Static method in class org.crosswire.jsword.passage.VerseRange

Create a VerseRange that is the stuff left of VerseRange a when you remove the stuff in VerseRange b.

remove(String) - Method in class org.crosswire.common.config.Config

Remove a key/model pairing

remove() - Method in class org.crosswire.common.util.EmptyIterator

remove(String, String, String) - Method in class org.crosswire.common.util.Ini

Remove the value if present.

remove(String, String) - Method in class org.crosswire.common.util.Ini

Remove the key if present.

remove(String, String) - Method in class org.crosswire.common.util.IniSection

Remove the value if present.

remove(String) - Method in class org.crosswire.common.util.IniSection

Remove the value if present.

remove() - Method in class org.crosswire.common.util.ItemIterator

remove(Object) - Method in class org.crosswire.common.util.ListSet

remove(int) - Method in class org.crosswire.common.util.ListSet

remove() - Method in class org.crosswire.common.util.StackTrace.AbstractStackIterator

remove() - Method in class org.crosswire.jsword.book.BookFilterIterator

remove() - Method in class org.crosswire.jsword.passage.AbstractPassage.VerseRangeIterator

remove(Key) - Method in class org.crosswire.jsword.passage.BitwisePassage

remove() - Method in class org.crosswire.jsword.passage.BitwisePassage.VerseIterator

remove(Key) - Method in class org.crosswire.jsword.passage.DistinctPassage

remove() - Method in class org.crosswire.jsword.passage.KeyIterator

remove(Key) - Method in interface org.crosswire.jsword.passage.Passage

Remove this Verse/VerseRange from this Passage

remove() - Method in class org.crosswire.jsword.passage.PassageTally.OrderedVerseIterator

remove() - Method in class org.crosswire.jsword.passage.PassageTally.OrderedVerseRangeIterator

remove(Key) - Method in class org.crosswire.jsword.passage.PassageTally

Remove these verses from the rankings, ie, set their rank to zero.

remove() - Method in class org.crosswire.jsword.passage.PassageTally.VerseIterator

remove(Key) - Method in class org.crosswire.jsword.passage.RangedPassage

remove() - Method in class org.crosswire.jsword.passage.RangedPassage.VerseIterator

remove() - Method in class org.crosswire.jsword.passage.RangedPassage.VerseRangeIterator

remove(Key) - Method in class org.crosswire.jsword.passage.ReadOnlyPassage

remove(Key) - Method in class org.crosswire.jsword.passage.SynchronizedPassage

remove() - Method in class org.crosswire.jsword.passage.VerseRange.VerseIterator

removeAll(Key) - Method in class org.crosswire.jsword.book.sword.AbstractKeyBackend

removeAll(Key) - Method in class org.crosswire.jsword.passage.AbstractPassage

removeAll(Key) - Method in class org.crosswire.jsword.passage.BitwisePassage

removeAll(Key) - Method in class org.crosswire.jsword.passage.DefaultKeyList

removeAll(Key) - Method in class org.crosswire.jsword.passage.DefaultLeafKeyList

removeAll(Key) - Method in interface org.crosswire.jsword.passage.Key

Removes the specified elements from this set if it is present.

removeAll(Key) - Method in class org.crosswire.jsword.passage.PassageTally

removeAll(Key) - Method in class org.crosswire.jsword.passage.ReadOnlyKeyList

removeAll(Key) - Method in class org.crosswire.jsword.passage.ReadOnlyPassage

removeAll(Key) - Method in class org.crosswire.jsword.passage.SetKeyList

removeAll(Key) - Method in class org.crosswire.jsword.passage.SynchronizedPassage

removeAll(Key) - Method in class org.crosswire.jsword.passage.TreeKey

removeAll(Key) - Method in class org.crosswire.jsword.passage.Verse

removeAll(Key) - Method in class org.crosswire.jsword.passage.VerseRange

removeBook(Book) - Method in class org.crosswire.jsword.book.Books

Remove a Book from the current list of Books.

removeBooksListener(BooksListener) - Method in class org.crosswire.jsword.book.AbstractBookList

removeBooksListener(BooksListener) - Method in interface org.crosswire.jsword.book.BookList

Remove a BibleListener to our list of listeners

removeBooksListener(InstallerListener) - Method in class org.crosswire.jsword.book.install.InstallManager

Add a BibleListener to our list of listeners

removeConfigListener(ConfigListener) - Method in class org.crosswire.common.config.Config

Remove an Exception listener from the list of things wanting to know whenever we capture an Exception

removeFirstDifference() - Method in class org.crosswire.common.diff.PatchEntry

removeFromInstalledIndexMetadata(Book) - Method in class org.crosswire.jsword.index.lucene.InstalledIndex

removeHistoryListener(HistoryListener) - Method in class org.crosswire.common.history.History

Remove a listener of history events.

removeIndexStatusListener(IndexStatusListener) - Method in class org.crosswire.jsword.book.basic.AbstractBook

removeIndexStatusListener(IndexStatusListener) - Method in interface org.crosswire.jsword.book.Book

Removes a IndexStatusListener from the listener list.

removeInstaller(String) - Method in class org.crosswire.jsword.book.install.InstallManager

Remove an installer from our list

removePassageListener(PassageListener) - Method in class org.crosswire.jsword.passage.AbstractPassage

removePassageListener(PassageListener) - Method in interface org.crosswire.jsword.passage.Passage

Event Listeners - Remove Listener

removePassageListener(PassageListener) - Method in class org.crosswire.jsword.passage.ReadOnlyPassage

removePassageListener(PassageListener) - Method in class org.crosswire.jsword.passage.SynchronizedPassage

removePropertyChangeListener(PropertyChangeListener) - Method in class org.crosswire.common.config.Config

Remove a PropertyChangeListener from the listener list.

removePropertyChangeListener(String, PropertyChangeListener) - Method in class org.crosswire.common.config.Config

Remove a PropertyChangeListener for a specific property.

removeReporterListener(ReporterListener) - Static method in class org.crosswire.common.util.Reporter

Remove an Exception listener from the list of things wanting to know whenever we capture an Exception

removeValue(String, String) - Method in class org.crosswire.common.util.Ini

Remove the value if present in the first section.

removeValue(String) - Method in class org.crosswire.common.util.Ini

Remove the key if present.

removeWorkListener(WorkListener) - Method in class org.crosswire.common.progress.Job

Remote a listener from the list

removeWorkListener(WorkListener) - Static method in class org.crosswire.common.progress.JobManager

Remove a listener from the list

replace(String, String, String) - Method in class org.crosswire.common.util.Ini

Replace a value for a key.

replace(String, String) - Method in class org.crosswire.common.util.IniSection

Replace the value(s) for the key with a new value.

replaceValue(String, String) - Method in class org.crosswire.common.util.Ini

Replace a value for a key.

replyNext() - Method in class org.crosswire.jsword.passage.RangedPassage.VerseRangeIterator

The next object is correct, use that one

report() - Method in class org.crosswire.common.util.IniSection

Obtain a report of issues with this IniSection.

report(Book, Key, String) - Static method in class org.crosswire.jsword.book.DataPolice

Report a message against the current book and key.

report(IniSection) - Static method in class org.crosswire.jsword.book.sword.SwordBookMetaData

report(Book) - Static method in class org.crosswire.jsword.bridge.BibleScope

reportCardinalityError(VerseKey, VerseKey) - Method in class org.crosswire.jsword.versification.VersificationToKJVMapper

If for some reason cardinalities of keys are different, we report it.

Reporter - Class in org.crosswire.common.util

This package looks after Exceptions and messages as they happen.

Reporter() - Constructor for class org.crosswire.common.util.Reporter

Enforce Singleton

Reporter.CustomAWTExceptionHandler - Class in org.crosswire.common.util

A class to handle AWT caught Exceptions

Reporter.CustomAWTExceptionHandler() - Constructor for class org.crosswire.common.util.Reporter.CustomAWTExceptionHandler

ReporterEvent - Class in org.crosswire.common.util

An event indicating that some bit of data needs capturing.

ReporterEvent(Object, Throwable) - Constructor for class org.crosswire.common.util.ReporterEvent

Constructs an CaptureEvent object.

ReporterEvent(Object, String) - Constructor for class org.crosswire.common.util.ReporterEvent

Constructs an CaptureEvent object.

ReporterListener - Interface in org.crosswire.common.util

ReporterListener informs users of problems and messages.

reportException(ReporterEvent) - Method in interface org.crosswire.common.util.ReporterListener

Called whenever Reporter.informUser() is passed an Exception

REPORTING_INTERVAL - Static variable in class org.crosswire.common.progress.Job

reportMessage(ReporterEvent) - Method in interface org.crosswire.common.util.ReporterListener

Called whenever Reporter.informUser() is passed a message

request - Variable in class org.crosswire.jsword.index.search.DefaultSearchRequest

The actual search request

requiresRestart() - Method in class org.crosswire.common.config.AbstractReflectedChoice

requiresRestart() - Method in interface org.crosswire.common.config.Choice

Do we need to restart the program in order for this change to have effect?

reset() - Static method in class org.crosswire.common.util.CWProject

Required for reset of statics during testing

resetMax() - Method in class org.crosswire.jsword.passage.PassageTally

Sometimes we end up not knowing what the max is - this makes sure we know accurately.

resolveEntity(String, String) - Method in class org.crosswire.common.xml.XMLHandlerAdapter

resolver - Static variable in class org.crosswire.common.util.CallContext

resolver - Variable in class org.crosswire.common.xml.TransformingSAXEventProvider

The remembered URIResolver because the transformer has not been created

ResourceUtil - Class in org.crosswire.common.util

Better implementations of the getResource methods with less ambiguity and that are less dependent on the specific class loader situation.

ResourceUtil() - Constructor for class org.crosswire.common.util.ResourceUtil

Prevent Instantiation

restart - Variable in class org.crosswire.common.config.AbstractReflectedChoice

Whether this choice is requires a restart to be seen.

restore(List<?>) - Method in class org.crosswire.common.diff.LineMap

Rehydrate the text in a diff from a string of line hashes to real lines of text.

restrict - Variable in class org.crosswire.jsword.passage.AbstractPassage.VerseRangeIterator

Do we restrict ranges to not crossing chapter boundaries

restrict - Variable in class org.crosswire.jsword.passage.RangedPassage.VerseRangeIterator

Where do we break ranges

RestrictionType - Enum in org.crosswire.jsword.passage

Types of Passage Blurring Restrictions.

RestrictionType() - Constructor for enum org.crosswire.jsword.passage.RestrictionType

result - Variable in class org.crosswire.jsword.book.BookFilters.CustomBookFilter.Test

result - Variable in class org.crosswire.jsword.index.lucene.analysis.SavedStreams

results - Variable in class org.crosswire.common.diff.Patch.PatchResults

results - Variable in class org.crosswire.jsword.index.lucene.VerseCollector

retain(Key, Key) - Static method in class org.crosswire.jsword.passage.AbstractKeyList

Utility to remove all the keys from alter that are not in base

retainAll(Collection<?>) - Method in class org.crosswire.common.util.ListSet

retainAll(Key) - Method in class org.crosswire.jsword.book.sword.AbstractKeyBackend

retainAll(Key) - Method in class org.crosswire.jsword.passage.AbstractKeyList

retainAll(Key) - Method in class org.crosswire.jsword.passage.AbstractPassage

retainAll(Key) - Method in class org.crosswire.jsword.passage.BitwisePassage

retainAll(Key) - Method in class org.crosswire.jsword.passage.DefaultLeafKeyList

retainAll(Key) - Method in interface org.crosswire.jsword.passage.Key

Removes all but the specified element from this set.

retainAll(Key) - Method in class org.crosswire.jsword.passage.RangedPassage

retainAll(Key) - Method in class org.crosswire.jsword.passage.ReadOnlyKeyList

retainAll(Key) - Method in class org.crosswire.jsword.passage.ReadOnlyPassage

retainAll(Key) - Method in class org.crosswire.jsword.passage.SynchronizedPassage

retainAll(Key) - Method in class org.crosswire.jsword.passage.Verse

retainAll(Key) - Method in class org.crosswire.jsword.passage.VerseRange

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.ArabicLuceneAnalyzer

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.ChineseLuceneAnalyzer

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.ConfigurableSnowballAnalyzer

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.CzechLuceneAnalyzer

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.EnglishLuceneAnalyzer

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.GermanLuceneAnalyzer

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.GreekLuceneAnalyzer

Returns a (possibly reused) TokenStream which tokenizes all the text in the provided Reader.

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.KeyAnalyzer

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.PersianLuceneAnalyzer

Returns a (possibly reused) TokenStream which tokenizes all the text in the provided Reader.

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.SmartChineseLuceneAnalyzer

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.StrongsNumberAnalyzer

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.ThaiLuceneAnalyzer

reusableTokenStream(String, Reader) - Method in class org.crosswire.jsword.index.lucene.analysis.XRefAnalyzer

reversify(Versification) - Method in class org.crosswire.jsword.passage.AbstractPassage

reversify(Versification) - Method in class org.crosswire.jsword.passage.ReadOnlyPassage

reversify(Versification) - Method in class org.crosswire.jsword.passage.SynchronizedPassage

reversify(Versification) - Method in class org.crosswire.jsword.passage.Verse

reversify(Versification) - Method in interface org.crosswire.jsword.passage.VerseKey

Cast this VerseKey into another Versification.

reversify(Versification) - Method in class org.crosswire.jsword.passage.VerseRange

reversify(Versification) - Method in class org.crosswire.jsword.versification.QualifiedKey

Convert this QualifiedKey from one Versification to another.

rightQuery - Variable in class org.crosswire.jsword.index.query.AbstractBinaryQuery

rightSon - Variable in class org.crosswire.common.compress.LZSS

RING_SIZE - Static variable in class org.crosswire.common.compress.LZSS

This is the size of the ring buffer.

RING_WRAP - Static variable in class org.crosswire.common.compress.LZSS

This is used to determine the next position in the ring buffer, from 0 to RING_SIZE - 1.

ringBuffer - Variable in class org.crosswire.common.compress.LZSS

A text buffer.

rlt - Variable in class org.crosswire.common.xml.RedLetterText

RocketPassage - Class in org.crosswire.jsword.passage

A RocketPassage is a bit and heavy implementation of Passage that goes fairly quickly once let of the leash.

RocketPassage(Versification) - Constructor for class org.crosswire.jsword.passage.RocketPassage

Create a new RocketPassage

RocketPassage(Versification, String, Key) - Constructor for class org.crosswire.jsword.passage.RocketPassage

Create a Verse from a human readable string.

RocketPassage(Versification, String) - Constructor for class org.crosswire.jsword.passage.RocketPassage

Create a Verse from a human readable string.

rootElement - Variable in class org.crosswire.jsword.book.filter.thml.CustomHandler

When the document is parsed, this is the last element popped off the stack.

RootTag - Class in org.crosswire.jsword.book.filter.thml

THML Tag to process the root element.

RootTag() - Constructor for class org.crosswire.jsword.book.filter.thml.RootTag

rotor - Variable in class org.crosswire.common.crypt.Sapphire

rsum - Variable in class org.crosswire.common.crypt.Sapphire

RTF_PATTERN - Static variable in class org.crosswire.jsword.book.sword.SwordBookMetaData

rtfToOsis(String) - Static method in class org.crosswire.jsword.book.OSISUtil

rtol - Static variable in class org.crosswire.common.util.Languages.RtoL

Do lazy loading of the huge file of languages.

run() - Method in class org.crosswire.common.progress.Job.PredictTask

run() - Method in class org.crosswire.common.util.CWClassLoader.PrivilegedLoader