org.crosswire.jsword.book.basic
Class AbstractPassageBook

java.lang.Object
  org.crosswire.jsword.book.basic.AbstractBook
      org.crosswire.jsword.book.basic.AbstractPassageBook

All Implemented Interfaces:

Comparable<Book>, Activatable, Book

Direct Known Subclasses:

SwordBook

public abstract class AbstractPassageBook
extends AbstractBook

An abstract implementation of Book that lets implementors just concentrate on reading book data.

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 Key	global A cached representation of the global key list.
private PassageKeyFactory	keyf Our key manager
private static Logger	log The log stream
private String	versification The name of the versification or null

Constructor Summary

AbstractPassageBook(BookMetaData bmd)

Method Summary

void	addOSIS(Key key, org.jdom.Element div, List<org.jdom.Content> osisContent) Add the OSIS elements to the div element.
void	addOSIS(Key key, List<org.jdom.Content> content, List<org.jdom.Content> osisContent) Add the OSIS elements to the div element.
Key	createEmptyKeyList() Fetch an empty Key to which we can add Keys.
protected abstract Filter	getFilter() What filter should be used to filter data in the format produced by this Book?.
Key	getGlobalKeyList() Get a complete list of index entries.
Key	getKey(String text) Someone has typed in a reference to find, but we need a Key to actually look it up.
Iterator<org.jdom.Content>	getOsisIterator(Key key, boolean allowEmpty) Return an iterator that returns each key's OSIS in turn.
Key	getValidKey(String name) Get a Key for the name, if possible.
boolean	isWritable() A Book is writable if the file system allows the underlying files to be opened for writing and if the driver for the book allows writing.
void	setDocument(Key key, BookData bdata) For when we want to add writing functionality.

Methods inherited from class org.crosswire.jsword.book.basic.AbstractBook

activate, addIndexStatusListener, compareTo, deactivate, equals, find, find, firePropertyChange, getBook, getBookCategory, getBookMetaData, getDriver, getDriverName, getIndexStatus, getInitials, getLanguage, getName, getOsisID, getProperties, getProperty, getUnlockKey, hasFeature, hashCode, isEnciphered, isLeftToRight, isLocked, isQuestionable, isSupported, match, putProperty, removeIndexStatusListener, setBookMetaData, setIndexStatus, toOSIS, toString, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.crosswire.jsword.book.Book

contains, getRawText, setAliasKey, setRawText

Field Detail

global

private Key global

A cached representation of the global key list.

versification

private String versification

The name of the versification or null

keyf

private PassageKeyFactory keyf

Our key manager

log

private static final Logger log

The log stream

Constructor Detail

AbstractPassageBook

public AbstractPassageBook(BookMetaData bmd)

Method Detail

getOsisIterator

public Iterator<org.jdom.Content> getOsisIterator(Key key,
                                                  boolean allowEmpty)
                                           throws BookException

Description copied from interface: Book

Return an iterator that returns each key's OSIS in turn.

Parameters:

key - the Items to locate

allowEmpty - indicates whether empty keys should be present.

Throws:

BookException

addOSIS

public void addOSIS(Key key,
                    org.jdom.Element div,
                    List<org.jdom.Content> osisContent)

Add the OSIS elements to the div element. Note, this assumes that the data is fully marked up.

Parameters:

key - The key being added

div - The div element to which the key's OSIS representation is being added

osisContent - The OSIS representation of the key being added.

addOSIS

public void addOSIS(Key key,
                    List<org.jdom.Content> content,
                    List<org.jdom.Content> osisContent)

Add the OSIS elements to the div element. Note, this assumes that the data is fully marked up.

Parameters:

key - The key being added

content - The list to which the key's OSIS representation is being added

osisContent - The OSIS representation of the key being added.

getFilter

protected abstract Filter getFilter()

What filter should be used to filter data in the format produced by this Book?. In some ways this method is more suited to BookMetaData however we do not have a specialization of BookMetaData to fit AbstractPassageBook and it doesn't like any higher in the hierarchy at the moment so I will leave this here.

setDocument

public void setDocument(Key key,
                        BookData bdata)
                 throws BookException

For when we want to add writing functionality. This does not work.

Parameters:

key -

bdata -

Throws:

BookException

isWritable

public boolean isWritable()

Description copied from interface: Book

A Book is writable if the file system allows the underlying files to be opened for writing and if the driver for the book allows writing. Ultimately, all drivers should allow writing. At this time writing is not supported by drivers, so abstract implementations should return false and let specific implementations return true otherwise.

Returns:

true if the book is writable

createEmptyKeyList

public final Key createEmptyKeyList()

Description copied from interface: Book

Fetch an empty Key to which we can add Keys. Not all implementations of Key are able to hold any type of Key, It isn't reasonable to expect a Key of Bible verses (=Passage) to hold a dictionary Key. So each KeyFactory must be able to create you an empty Key to which you can safely add other Keys it generates.

Returns:

An empty Key that can hold other Keys from this factory.

getGlobalKeyList

public final Key getGlobalKeyList()

Description copied from interface: Book

Get a complete list of index entries. Create a Key that encompasses all of the known valid keys for the given context. For a dictionary this will include all of the entries in the dictionary, for a Bible this will probably include all the verses in the Bible, but a commentary may well miss some out.

Returns:

A Key that includes all of the known Keys

getValidKey

public Key getValidKey(String name)

Description copied from interface: Book

Get a Key for the name, if possible. Otherwise return an empty Key.

Returns:

a valid key.

getKey

public final Key getKey(String text)
                 throws NoSuchKeyException

Description copied from interface: Book

Someone has typed in a reference to find, but we need a Key to actually look it up. So we create a Key from the string if such a translation is possible. The returned Key may be a BranchKey if the string represents more than one Key.

Parameters:

text - The string to translate into a Key

Returns:

The Key corresponding to the input text

Throws:

NoSuchKeyException - If the name can not be parsed.