org.crosswire.jsword.book.sword
Class AbstractBackend

java.lang.Object
  org.crosswire.jsword.book.sword.AbstractBackend

All Implemented Interfaces:

Activatable

Direct Known Subclasses:

GenBookBackend, GZIPBackend, LZSSBackend, RawBackend, RawLDBackend, ZLDBackend

public abstract class AbstractBackend
extends Object
implements Activatable

A generic way to read data from disk for later formatting.

Author:

Joe Walker [joe at eireneh dot com]

See Also:

for license details. The copyright to this program is held by it's authors.

Field Summary

private SwordBookMetaData	bmd
private File	rootPath

Constructor Summary

AbstractBackend(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 AbstractBackend is implemented.
abstract Key	readIndex() Initialise a AbstractBackend 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

bmd

private SwordBookMetaData bmd

rootPath

private File rootPath

Constructor Detail

AbstractBackend

public AbstractBackend(SwordBookMetaData sbmd,
                       File location)

Construct a minimal backend

Parameters:

sbmd -

location -

Method Detail

getRootPath

public File getRootPath()

Returns:

Returns the root path.

getBookMetaData

public SwordBookMetaData getBookMetaData()

Returns:

Returns the Sword BookMetaData.

decipher

public void decipher(byte[] data)

Decipher the data in place, if it is enciphered and there is a key to unlock it.

Parameters:

data - the data to unlock

readIndex

public abstract Key readIndex()

Initialise a AbstractBackend before use. This method needs to call addKey() a number of times on SwordDictionary

getRawText

public abstract String getRawText(Key key)
                           throws BookException

Get the bytes alotted for the given verse

Parameters:

key - The key to fetch

Returns:

String The data for the verse in question

Throws:

BookException - If the data can not be read.

isSupported

public abstract boolean isSupported()

Returns whether this AbstractBackend is implemented.

Returns:

true if this AbstractBackend is implemented.