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.book.sword.state |
File management of SWORD Books.
|
org.crosswire.jsword.examples |
Some examples of how to use the JSword API.
|
org.crosswire.jsword.index.lucene |
An implementation of an Index using Lucene.
|
Modifier and Type | Method and Description |
---|---|
BookMetaData |
Book.getBookMetaData()
Meta-Information: What version of the Bible is this?
|
Modifier and Type | Method and Description |
---|---|
static org.jdom2.Element |
OSISUtil.createOsisFramework(BookMetaData bmd)
Helper method to create the boilerplate headers in an OSIS document from
the current metadata object
|
void |
Book.setBookMetaData(BookMetaData bmd)
Set the meta-information for this book.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractBookMetaData |
class |
DefaultBookMetaData
DefaultBookMetaData is an implementation of the of the BookMetaData
interface.
|
Modifier and Type | Field and Description |
---|---|
private BookMetaData |
AbstractBook.bmd
The meta data for this book
|
Modifier and Type | Method and Description |
---|---|
BookMetaData |
AbstractBook.getBookMetaData() |
Modifier and Type | Method and Description |
---|---|
int |
AbstractBookMetaData.compareTo(BookMetaData obj) |
void |
AbstractBook.setBookMetaData(BookMetaData bmd) |
Constructor and Description |
---|
AbstractBook(BookMetaData bmd,
Backend backend)
Construct an AbstractBook given the BookMetaData and the AbstractBackend.
|
AbstractPassageBook(BookMetaData bmd,
Backend backend)
Construct an AbstractPassageBook given the BookMetaData and the AbstractBackend.
|
Modifier and Type | Class and Description |
---|---|
class |
SwordBookMetaData
A utility class for loading and representing Sword book configs.
|
Modifier and Type | Method and Description |
---|---|
BookMetaData |
Backend.getBookMetaData() |
BookMetaData |
AbstractBackend.getBookMetaData() |
Modifier and Type | Method and Description |
---|---|
static URI |
SwordUtil.getExpandedDataPath(BookMetaData bookMetaData)
Returns where the book should be located
|
Modifier and Type | Field and Description |
---|---|
private BookMetaData |
AbstractOpenFileState.bookMetaData
The BookMetaData for this OpenFileState.
|
Modifier and Type | Field and Description |
---|---|
private Map<BookMetaData,Queue<OpenFileState>> |
OpenFileStateManager.metaToStates |
Modifier and Type | Method and Description |
---|---|
BookMetaData |
OpenFileState.getBookMetaData() |
BookMetaData |
AbstractOpenFileState.getBookMetaData()
Get the BookMetaData for this OpenFileState.
|
Modifier and Type | Method and Description |
---|---|
GenBookBackendState |
OpenFileStateManager.getGenBookBackendState(BookMetaData metadata) |
private <T extends OpenFileState> |
OpenFileStateManager.getInstance(BookMetaData metadata) |
private Queue<OpenFileState> |
OpenFileStateManager.getQueueForMeta(BookMetaData metadata) |
RawBackendState |
OpenFileStateManager.getRawBackendState(BookMetaData metadata) |
RawFileBackendState |
OpenFileStateManager.getRawFileBackendState(BookMetaData metadata) |
RawLDBackendState |
OpenFileStateManager.getRawLDBackendState(BookMetaData metadata) |
ZLDBackendState |
OpenFileStateManager.getZLDBackendState(BookMetaData metadata) |
ZVerseBackendState |
OpenFileStateManager.getZVerseBackendState(BookMetaData metadata,
BlockType blockType) |
Constructor and Description |
---|
AbstractOpenFileState(BookMetaData bmd)
Create an AbstractOpenFileState tied to a BookMetaData.
|
GenBookBackendState(BookMetaData bookMetaData)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
RawBackendState(BookMetaData bookMetaData)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
RawFileBackendState(BookMetaData bookMetaData)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
RawLDBackendState(BookMetaData bookMetaData)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
ZLDBackendState(BookMetaData bookMetaData)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
ZVerseBackendState(BookMetaData bookMetaData,
BlockType blockType)
This is default package access for forcing the use of the
OpenFileStateManager to manage the creation.
|
Modifier and Type | Method and Description |
---|---|
private void |
DictToOsis.buildDocumentOpen(StringBuffer buf,
BookMetaData bmd) |
private void |
BibleToOsis.buildDocumentOpen(StringBuffer buf,
BookMetaData bmd,
String range,
boolean force) |
Modifier and Type | Method and Description |
---|---|
static String |
IndexMetadata.getBookIdentifierPropSuffix(BookMetaData meta) |