|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.sword.Backend
org.crosswire.jsword.book.sword.RawBackend
public class RawBackend
Both Books and Commentaries seem to use the same format so this class abstracts out the similarities.
Distribution Licence: JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA The copyright to this program is held by it's authors. |
Licence
Field Summary | |
---|---|
private boolean |
active
Are we active |
private static int |
ENTRY_SIZE
How many bytes in an index? |
private File[] |
idxFile
The array of index random access files |
private RandomAccessFile[] |
idxRaf
The array of index files |
private static Logger |
log
The log stream |
private File[] |
txtFile
The array of data random access files |
private RandomAccessFile[] |
txtRaf
The array of data files |
Constructor Summary | |
---|---|
RawBackend(SwordBookMetaData sbmd,
File rootPath)
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. |
String |
getRawText(Key key)
Get the bytes alotted for the given verse |
boolean |
isSupported()
Returns whether this Backend is implemented. |
Key |
readIndex()
Initialise a Backend before use. |
Methods inherited from class org.crosswire.jsword.book.sword.Backend |
---|
decipher, getBookMetaData, getRootPath |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private boolean active
private static final Logger log
private RandomAccessFile[] idxRaf
private RandomAccessFile[] txtRaf
private File[] idxFile
private File[] txtFile
private static final int ENTRY_SIZE
Constructor Detail |
---|
public RawBackend(SwordBookMetaData sbmd, File rootPath) 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
Backend
getRawText
in class Backend
key
- The key to fetch
BookException
- If the data can not be read.public Key readIndex()
Backend
readIndex
in class Backend
public boolean isSupported()
Backend
isSupported
in class Backend
protected final void checkActive()
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |