|
||||||||||
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 |
addOSIS(Key key,
List contentList,
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?. |
String |
getRawText(Key key)
Returns the raw text that getData(Key key) builds into OSIS. |
boolean |
isWritable()
A Book is writable if the file system allows the underlying files to be opened for writing and if the driver for the book allows writing. |
void |
setAliasKey(Key alias,
Key source)
Store an alias of one key to another. |
void |
setRawText(Key key,
String rawData)
Store the raw text for the given key. |
Methods inherited from class org.crosswire.jsword.book.basic.AbstractPassageBook |
---|
createEmptyKeyList, getGlobalKeyList, getKey, getOsisIterator, getValidKey, setDocument |
Methods inherited from class org.crosswire.jsword.book.basic.AbstractBook |
---|
addIndexStatusListener, compareTo, equals, find, find, firePropertyChange, getBook, getBookCategory, getBookMetaData, getDriver, getDriverName, getIndexStatus, getInitials, getLanguage, getName, getOsisID, getProperties, getProperty, getUnlockKey, hasFeature, hashCode, isEnciphered, isLeftToRight, isLocked, isQuestionable, isSupported, match, 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 methodpublic String getRawText(Key key) throws BookException
Book
key
- The item to locate
BookException
- If anything goes wrong with this methodpublic 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's OSIS representation is being addedosisContent
- The OSIS representation of the key being added.public void addOSIS(Key key, List contentList, List osisContent)
AbstractPassageBook
addOSIS
in class AbstractPassageBook
key
- The key being addedcontentList
- The list to which the key's OSIS representation is being addedosisContent
- The OSIS representation of the key being added.public boolean isWritable()
Book
isWritable
in interface Book
isWritable
in class AbstractPassageBook
public void setRawText(Key key, String rawData) throws BookException
Book
key
- The item to locaterawData
- The text to store
BookException
- If anything goes wrong with this methodpublic void setAliasKey(Key alias, Key source) throws BookException
Book
It should be an exception to set an alias when that alias already has raw text. Also, it should be an exception to set an alias to an alias. However, getRawText(Key) must be able to handle alias chains.
alias
- the key that aliases anothersource
- the key that holds the text
BookException
- If anything goes wrong with this methodprotected Filter getFilter()
AbstractPassageBook
getFilter
in class AbstractPassageBook
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |