|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.sword.AbstractBackend
org.crosswire.jsword.book.sword.GenBookBackend
public class GenBookBackend
Backend for General Books.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
private boolean |
active
Are we active |
private File |
bdtFile
The raw data file |
private RandomAccessFile |
bdtRaf
The random access file for the raw data |
private static String |
EXTENSION_BDT
Raw GenBook file extensions |
private TreeKeyIndex |
index
The raw index file |
private static Logger |
log
The log stream |
Constructor Summary | |
---|---|
GenBookBackend(SwordBookMetaData sbmd)
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. |
protected void |
checkActive()
Helper method so we can quickly activate ourselves on access |
void |
deactivate(Lock lock)
Called to indicate that the Book should release whatever system resources it can to make way for other uses. |
private void |
doReadIndex(TreeNode parentNode,
Key parentKey)
A helper function to recursively read the entire tree. |
private TreeNode |
find(Key key)
Given a Key, find the TreeNode for it. |
String |
getRawText(Key key)
Get the bytes alotted for the given verse |
Key |
readIndex()
Initialise a AbstractBackend before use. |
Methods inherited from class org.crosswire.jsword.book.sword.AbstractBackend |
---|
decipher, getBookMetaData, getExpandedDataPath, isSupported, isWritable |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final String EXTENSION_BDT
private File bdtFile
private RandomAccessFile bdtRaf
private TreeKeyIndex index
private boolean active
private static final Logger log
Constructor Detail |
---|
public GenBookBackend(SwordBookMetaData sbmd) throws BookException
BookException
Method Detail |
---|
public final void activate(Lock lock)
Activatable
lock
- An attempt to ensure that only the Activator calls this methodpublic final void deactivate(Lock lock)
Activatable
lock
- An attempt to ensure that only the Activator calls this methodpublic String getRawText(Key key) throws BookException
AbstractBackend
getRawText
in class AbstractBackend
key
- The key to fetch
BookException
- If the data can not be read.private TreeNode find(Key key) throws IOException
key
- The key to use for searching
IOException
public Key readIndex()
AbstractBackend
readIndex
in class AbstractBackend
private void doReadIndex(TreeNode parentNode, Key parentKey) throws IOException
parentNode
- the current node whose children are being soughtparentKey
-
IOException
protected final void checkActive()
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |