|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.sword.Backend
public abstract class Backend
A generic way to read data from disk for later formatting.
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 SwordBookMetaData |
bmd
|
private File |
rootPath
|
Constructor Summary | |
---|---|
Backend(SwordBookMetaData sbmd,
File location)
Construct a minimal backend |
Method Summary | |
---|---|
void |
decipher(byte[] data)
Decipher the data in place, if it is enciphered and there is a key to unlock it. |
SwordBookMetaData |
getBookMetaData()
|
abstract String |
getRawText(Key key)
Get the bytes alotted for the given verse |
File |
getRootPath()
|
abstract boolean |
isSupported()
Returns whether this Backend is implemented. |
abstract Key |
readIndex()
Initialise a Backend before use. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.crosswire.common.activate.Activatable |
---|
activate, deactivate |
Field Detail |
---|
private SwordBookMetaData bmd
private File rootPath
Constructor Detail |
---|
public Backend(SwordBookMetaData sbmd, File location)
sbmd
- location
- Method Detail |
---|
public File getRootPath()
public SwordBookMetaData getBookMetaData()
public void decipher(byte[] data)
data
- the data to unlockpublic abstract Key readIndex()
public abstract String getRawText(Key key) throws BookException
key
- The key to fetch
BookException
- If the data can not be read.public abstract boolean isSupported()
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |