|
||||||||||
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.PassageAbstractBook
public abstract class PassageAbstractBook
An abstract implementation of Book that lets implementors just concentrate on reading book data.
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 KeyFactory |
keyf
Our key manager |
private static Logger |
log
The log stream |
Fields inherited from interface org.crosswire.jsword.book.BookMetaData |
---|
KEY_BOOK, KEY_DRIVER, KEY_INDEXSTATUS, KEY_INITIALS, KEY_LANGUAGE, KEY_NAME, KEY_TYPE |
Constructor Summary | |
---|---|
PassageAbstractBook()
|
Method Summary | |
---|---|
void |
addOSIS(Key key,
org.jdom.Element div,
List osisContent)
Add the OSIS elements to the div element. |
Key |
createEmptyKeyList()
Fetch an empty Key to which we can add Keys. |
BookData |
getData(Key key)
Retrieval: Add to the given document some mark-up for the specified Verses. |
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. |
String |
getRawData(Key key)
Returns the raw text that getData(Key key) builds into OSIS. |
protected abstract String |
getText(Key key)
Read the unfiltered data for a given key |
void |
setDocument(Verse verse,
BookData bdata)
For when we want to add writing functionality |
protected abstract void |
setText(Verse verse,
String text)
Set the unparsed text for a verse to permanent storage. |
Methods inherited from class org.crosswire.jsword.book.basic.AbstractBook |
---|
activate, addPropertyChangeListener, compareTo, deactivate, equals, find, getBook, getBookMetaData, getDriver, getDriverName, getFullName, getIndexStatus, getInitials, getLanguage, getName, getOsisID, getProperties, getType, hasFeature, hashCode, isLeftToRight, removePropertyChangeListener, setBookMetaData, setIndexStatus, toOSIS, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private KeyFactory keyf
private static final Logger log
Constructor Detail |
---|
public PassageAbstractBook()
Method Detail |
---|
public BookData getData(Key key) throws BookException
Book
key
- The verses to search for
BookException
- If anything goes wrong with this methodpublic void addOSIS(Key key, org.jdom.Element div, List osisContent)
key
- The key being addeddiv
- The div element to which the key is being addedosisContent
- The OSIS representation of the key being added.protected abstract Filter getFilter()
protected abstract String getText(Key key) throws BookException
BookException
public void setDocument(Verse verse, BookData bdata) throws BookException
BookException
protected abstract void setText(Verse verse, String text) throws BookException
BookException
public final Key createEmptyKeyList()
KeyFactory
public final Key getGlobalKeyList()
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.public String getRawData(Key key) throws BookException
Book
key
- The verses to search for
BookException
- If anything goes wrong with this method
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |