Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.crosswire.jsword.book.sword
Class LZSSBackend

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

All Implemented Interfaces:
  Activatable

    public class LZSSBackend

extends AbstractBackend

A backend to read LZSS compressed data files.

Author:
  Joe Walker [joe at eireneh dot com]
See Also:
  `for license details. The copyright to this program is held by it's authors.`

Constructor Summary
`LZSSBackend(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.
`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 AbstractBackend is implemented.
`Key` | `readIndex()` Initialise a AbstractBackend before use.

Methods inherited from class org.crosswire.jsword.book.sword.AbstractBackend
`decipher, getBookMetaData, getRootPath`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### LZSSBackend

    public LZSSBackend(SwordBookMetaData sbmd,
                       File rootPath)

  Simple ctor

Method Detail

### activate

    public final void activate(Lock lock)

  Description copied from interface: `Activatable`
  Called to indicate that the Book should initialize itself, and consume whatever system resources it needs to be able to respond to other queries.

  Parameters:
    `lock` - An attempt to ensure that only the Activator calls this method

### deactivate

    public final void deactivate(Lock lock)

  Description copied from interface: `Activatable`
  Called to indicate that the Book should release whatever system resources it can to make way for other uses.

  Parameters:
    `lock` - An attempt to ensure that only the Activator calls this method

### getRawText

    public String getRawText(Key key)
                      throws BookException

  Description copied from class: `AbstractBackend`
  Get the bytes alotted for the given verse

  Specified by:
    `getRawText` in class `AbstractBackend`
  Parameters:
    `key` - The key to fetch
  Returns:
    String The data for the verse in question
  Throws:
    `BookException` - If the data can not be read.

### readIndex

    public Key readIndex()

  Description copied from class: `AbstractBackend`
  Initialise a AbstractBackend before use. This method needs to call addKey() a number of times on SwordDictionary

  Specified by:
    `readIndex` in class `AbstractBackend`

### isSupported

    public boolean isSupported()

  Description copied from class: `AbstractBackend`
  Returns whether this AbstractBackend is implemented.

  Specified by:
    `isSupported` in class `AbstractBackend`
  Returns:
    true if this AbstractBackend is implemented.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Copyright ¨ 2003-2005
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD