|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.basic.AbstractBook
org.crosswire.jsword.book.basic.AbstractPassageBook
org.crosswire.jsword.book.sword.SwordBook
public class SwordBook
SwordBook is a base class for all sword type books.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
private AbstractBackend |
backend
To read the data from the disk |
private SwordBookMetaData |
sbmd
The Sword configuration file |
Constructor Summary | |
---|---|
SwordBook(SwordBookMetaData sbmd,
AbstractBackend backend)
Simple ctor |
Method Summary | |
---|---|
void |
activate(Lock lock)
Called to indicate that the Book should initialize itself, and consume whatever system resources it needs to be able to respond to other queries. |
void |
addOSIS(Key key,
org.jdom.Element div,
List osisContent)
Add the OSIS elements to the div element. |
void |
deactivate(Lock lock)
Called to indicate that the Book should release whatever system resources it can to make way for other uses. |
protected Filter |
getFilter()
What filter should be used to filter data in the format produced by this Book?. |
protected String |
getText(Key key)
Read the unfiltered data for a given key |
protected void |
setText(Verse verse,
String text)
Set the unparsed text for a verse to permanent storage. |
Methods inherited from class org.crosswire.jsword.book.basic.AbstractPassageBook |
---|
createEmptyKeyList, getData, getGlobalKeyList, getKey, getRawData, getValidKey, setDocument |
Methods inherited from class org.crosswire.jsword.book.basic.AbstractBook |
---|
addIndexStatusListener, compareTo, equals, find, find, firePropertyChange, getBook, getBookCategory, getBookMetaData, getDriver, getDriverName, getFullName, getIndexStatus, getInitials, getLanguage, getName, getOsisID, getProperties, getProperty, getUnlockKey, hasFeature, hashCode, isEnciphered, isLeftToRight, isLocked, isQuestionable, isSupported, putProperty, removeIndexStatusListener, setBookMetaData, setIndexStatus, toOSIS, toString, unlock |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private AbstractBackend backend
private SwordBookMetaData sbmd
Constructor Detail |
---|
public SwordBook(SwordBookMetaData sbmd, AbstractBackend backend)
Method Detail |
---|
public final void activate(Lock lock)
Activatable
activate
in interface Activatable
activate
in class AbstractBook
lock
- An attempt to ensure that only the Activator calls this methodpublic final void deactivate(Lock lock)
Activatable
deactivate
in interface Activatable
deactivate
in class AbstractBook
lock
- An attempt to ensure that only the Activator calls this methodprotected String getText(Key key) throws BookException
getText
in class AbstractPassageBook
BookException
public void addOSIS(Key key, org.jdom.Element div, List osisContent)
AbstractPassageBook
addOSIS
in class AbstractPassageBook
key
- The key being addeddiv
- The div element to which the key is being addedosisContent
- The OSIS representation of the key being added.protected void setText(Verse verse, String text) throws BookException
AbstractPassageBook
setText
in class AbstractPassageBook
BookException
protected Filter getFilter()
AbstractPassageBook
getFilter
in class AbstractPassageBook
|
Copyright ยจ 2003-2006 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |