|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.basic.AbstractBook
org.crosswire.jsword.book.basic.AbstractPassageBook
public abstract class AbstractPassageBook
An abstract implementation of Book that lets implementors just concentrate on reading book data.
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 KeyFactory |
keyf
Our key manager |
private static Logger |
log
The log stream |
Constructor Summary | |
---|---|
AbstractPassageBook(BookMetaData bmd)
|
Method Summary | |
---|---|
void |
addOSIS(Key key,
org.jdom.Element div,
List osisContent)
Add the OSIS elements to the div element. |
void |
addOSIS(Key key,
List content,
List 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 |
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 |
---|
private Key global
private KeyFactory keyf
private static final Logger log
Constructor Detail |
---|
public AbstractPassageBook(BookMetaData bmd)
Method Detail |
---|
public Iterator getOsisIterator(Key key, boolean allowEmpty) throws BookException
Book
key
- the Items to locateallowEmpty
- indicates whether empty keys should be present.
BookException
public void addOSIS(Key key, org.jdom.Element div, List osisContent)
key
- The key being addeddiv
- The div element to which the key's OSIS representation is being addedosisContent
- The OSIS representation of the key being added.public void addOSIS(Key key, List content, List osisContent)
key
- The key being addedcontent
- The list to which the key's OSIS representation is being addedosisContent
- The OSIS representation of the key being added.protected abstract Filter getFilter()
public void setDocument(Key key, BookData bdata) throws BookException
BookException
public boolean isWritable()
Book
public final Key createEmptyKeyList()
KeyFactory
public final Key getGlobalKeyList()
KeyFactory
public Key getValidKey(String name)
KeyFactory
public final Key getKey(String text) throws NoSuchKeyException
KeyFactory
text
- The string to translate into a Key
NoSuchKeyException
- If the name can not be parsed.
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |