|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.sword.AbstractBackend<RawBackendState>
org.crosswire.jsword.book.sword.RawBackend<T>
T
- The type of the RawBackendState that this class extends.public class RawBackend<T extends RawBackendState>
Both Books and Commentaries seem to use the same format so this class abstracts out the similarities.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
protected int |
datasize
How many bytes in the size count in the index |
protected int |
entrysize
The number of bytes for each entry in the index: either 6 or 8 |
private static org.slf4j.Logger |
log
The log stream |
protected static int |
OFFSETSIZE
How many bytes in the offset pointers in the index |
Constructor Summary | |
---|---|
RawBackend(SwordBookMetaData sbmd,
int datasize)
Simple ctor |
Method Summary | |
---|---|
boolean |
contains(Key key)
Determine whether this Book contains the key in question |
protected String |
getEntry(RawBackendState state,
String name,
Testament testament,
long index)
Get the text for an indexed entry in the book. |
protected DataIndex |
getIndex(RandomAccessFile raf,
long entry)
Get the Index (that is offset and size) for an entry. |
String |
getRawText(RawBackendState state,
Key key)
|
T |
initState()
Initialises the state required to read from files, specific to each different backend |
boolean |
isWritable()
A Backend is writable if the file system allows the underlying files to be opened for writing and if the backend has implemented writing. |
String |
readRawContent(RawBackendState state,
Key key)
|
void |
setAliasKey(RawBackendState state,
Key alias,
Key source)
Sets alias for a comment on a verse range I.e. |
void |
setRawText(RawBackendState state,
Key key,
String text)
Set the text allotted for the given verse |
Methods inherited from class org.crosswire.jsword.book.sword.AbstractBackend |
---|
create, decipher, encipher, getBookMetaData, getGlobalKeyList, getVersification, isSupported, readIndex, readToOsis |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final int datasize
protected final int entrysize
protected static final int OFFSETSIZE
private static final org.slf4j.Logger log
Constructor Detail |
---|
public RawBackend(SwordBookMetaData sbmd, int datasize)
Method Detail |
---|
public boolean contains(Key key)
AbstractBackend
contains
in class AbstractBackend<RawBackendState>
key
- The key whose presence is desired.
public T initState() throws BookException
StatefulFileBackedBackend
BookException
public String getRawText(RawBackendState state, Key key) throws IOException
IOException
public String readRawContent(RawBackendState state, Key key) throws IOException
state
- the state object containing all the open random access fileskey
- the verse that is sought
IOException
- something went wrong when reading the versepublic void setRawText(RawBackendState state, Key key, String text) throws BookException, IOException
StatefulFileBackedBackend
state
- TODOkey
- The key to set text totext
- The text to be set for key
BookException
- If the data can not be set.
IOException
- If the module data path could not be created.public boolean isWritable()
AbstractBackend
isWritable
in class AbstractBackend<RawBackendState>
public void setAliasKey(RawBackendState state, Key alias, Key source) throws IOException
StatefulFileBackedBackend
alias
- Alias Keysource
- Source Key
IOException
- Exception when anything goes wrong on writing the aliasprotected DataIndex getIndex(RandomAccessFile raf, long entry) throws IOException
entry
-
IOException
protected String getEntry(RawBackendState state, String name, Testament testament, long index) throws IOException
state
- index
- the entry to getname
- name of the entrytestament
- the testament for the entry
IOException
- on a IO problem
|
Copyright ? 2003-2011 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |