|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BookMetaData
A BookMetaData represents a method of translating the Bible. All Books with
the same BookMetaData should return identical text for any call to
Bible.getText(VerseRange)
. The implication of this is that
there may be many instances of the Version "NIV", as there are several
different versions of the NIV - Original American-English, Anglicized,
and Inclusive Language editions at least.
BookMetaData like Strings must be compared using .equals()
instead of ==. A Bible must have the ability to handle a book unknown to
JSword. So Books must be able to add versions to the system, and the system
must cope with books that already exist.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
static String |
KEY_BOOK
The key for the book in the properties map |
static String |
KEY_CATEGORY
The key for the type in the properties map |
static String |
KEY_DRIVER
The key for the driver in the properties map |
static String |
KEY_FONT
The key for the font in the properties map |
static String |
KEY_INDEXSTATUS
The key for the indexed status in the properties map |
static String |
KEY_INITIALS
The key for the initials in the properties map |
static String |
KEY_LIBRARY_URI
The key for the URI locating where this book is installed |
static String |
KEY_LOCATION_URI
The key for the URI locating this book |
static String |
KEY_NAME
The key for the name in the properties map |
static String |
KEY_XML_LANG
The key for the language in the properties map |
Method Summary | |
---|---|
BookCategory |
getBookCategory()
What category of content is this, a Bible or a reference work like a Dictionary or Commentary. |
BookDriver |
getDriver()
Accessor for the driver that runs this Book. |
String |
getDriverName()
Calculated field: The name of the name, which could be helpful to distinguish similar Books available through 2 BookDrivers. |
IndexStatus |
getIndexStatus()
Has anyone generated a search index for this Book? |
String |
getInitials()
The initials of this book - how people familiar with this book will know it, for example "NIV", "KJV". |
Language |
getLanguage()
The language of the book. |
URI |
getLibrary()
Get the base URI for library of this module. |
URI |
getLocation()
Get the base URI for relative URIs in the document. |
String |
getName()
The name of the book, for example "King James Version" or "Bible in Basic English" or "Greek". |
String |
getOsisID()
Calculated field: Get an OSIS identifier for the OsisText.setOsisIDWork() and the Work.setOsisWork() methods. |
Map |
getProperties()
Get a list of all the properties available to do with this Book. |
Object |
getProperty(String key)
|
String |
getUnlockKey()
Gets the unlock key for the module. |
boolean |
hasFeature(FeatureType feature)
Return whether the feature is supported by the book. |
boolean |
isEnciphered()
Indicate whether this book is enciphered. |
boolean |
isLeftToRight()
Return the orientation of the language of the Book. |
boolean |
isLocked()
Indicate whether this book is enciphered and without a key. |
boolean |
isQuestionable()
Indicate whether this book is questionable. |
boolean |
isSupported()
Indicate whether this book is supported by JSword. |
void |
putProperty(String key,
Object value)
|
void |
setIndexStatus(IndexStatus status)
This method does not alter the index status, however it is for Indexers that are responsible for indexing and have changed the status themselves. |
void |
setLibrary(URI library)
Set the base URI for library of this module. |
void |
setLocation(URI library)
Set the base URI for relative URIs in the document. |
org.jdom.Document |
toOSIS()
Get an OSIS representation of information concerning this Book. |
boolean |
unlock(String unlockKey)
Unlocks a book with the given key. |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
static final String KEY_CATEGORY
static final String KEY_BOOK
static final String KEY_DRIVER
static final String KEY_NAME
static final String KEY_XML_LANG
static final String KEY_FONT
static final String KEY_INITIALS
static final String KEY_LIBRARY_URI
static final String KEY_LOCATION_URI
static final String KEY_INDEXSTATUS
Method Detail |
---|
String getName()
BookCategory getBookCategory()
BookDriver getDriver()
Language getLanguage()
String getInitials()
String getOsisID()
boolean isSupported()
boolean isEnciphered()
boolean isLocked()
boolean unlock(String unlockKey)
unlockKey
- the key to try
String getUnlockKey()
boolean isQuestionable()
String getDriverName()
boolean isLeftToRight()
boolean hasFeature(FeatureType feature)
URI getLibrary()
void setLibrary(URI library)
library
- the base URI or null if there is noneURI getLocation()
void setLocation(URI library)
library
- the base URI or null if there is noneMap getProperties()
Object getProperty(String key)
key
- the key of the property.
void putProperty(String key, Object value)
key
- the key of the property to setvalue
- the value of the propertyIndexStatus getIndexStatus()
IndexManager
void setIndexStatus(IndexStatus status)
IndexManager
org.jdom.Document toOSIS()
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |