Package org.crosswire.jsword.book.sword

An implementation of the Book interfaces that reads from SWORD project books (modules).

See:
          Description

Interface Summary
StatefulFileBackedBackend<T extends OpenFileState> Indicates that there is a stateful backend
 

Class Summary
AbstractBackend<T extends OpenFileState> A generic way to read data from disk for later formatting.
AbstractKeyBackend<T extends OpenFileState> A Backend that can be used as a global key list.
ConfigEntry A ConfigEntry holds the value(s) for an entry of ConfigEntryType.
ConfigEntryTable A utility class for loading the entries in a Sword book's conf file.
DataEntry Data entry represents an entry in a Data file.
DataIndex Data files are indexed by offset and size.
GenBookBackend Backend for General Books.
RawBackend<T extends RawBackendState> Both Books and Commentaries seem to use the same format so this class abstracts out the similarities.
RawFileBackend A Raw File format that allows for each verse to have it's own storage.
RawLDBackend<T extends RawLDBackendState> An implementation AbstractKeyBackend to read RAW format files.
SwordBook SwordBook is a base class for all verse based Sword type books.
SwordBookDriver This represents all of the Sword Books (aka modules).
SwordBookMetaData  
SwordBookPath This represents all of the Sword Books (aka modules).
SwordBookPath.CustomFilenameFilter Check that the directories in the version directory really represent versions.
SwordConstants A Constants to help the SwordBookDriver to read Sword format data.
SwordDailyDevotion A book that has a preferred key of today's date.
SwordDictionary A Sword version of Dictionary.
SwordGenBook A Sword version of Dictionary.
SwordUtil Various utilities used by different Sword classes.
TreeKeyIndex TreeKeyIndex reads Sword index files that are path based.
TreeNode A node that knows where the data is in the real file and where it is in relationship to other nodes.
ZLDBackend An extension of RawLDBackend to read Z format files.
ZVerseBackend A backend to read compressed data verse based files.
 

Enum Summary
BlockType Block types indicates the grain of compression.
BookType Data about book types.
ConfigEntryType Constants for the keys in a Sword Config file.
 

Exception Summary
MissingDataFilesException Indicates that the files are missing, and therefore this book should be excluded
 

Package org.crosswire.jsword.book.sword Description

An implementation of the Book interfaces that reads from SWORD project books (modules).


Copyright ? 2003-2011