|
||||||||||
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
org.crosswire.jsword.book.sword.SwordBook
public class SwordBook
SwordBook is a base class for all sword type modules.
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 Backend |
backend
To read the data from the disk |
private SwordBookMetaData |
sbmd
The Sword configuration file |
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 | |
---|---|
SwordBook(SwordBookMetaData sbmd,
Backend backend)
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 |
addOSIS(Key key,
org.jdom.Element div,
List osisContent)
Add the OSIS elements to the div element. |
void |
deactivate(Lock lock)
Called to indicate that the Book should release whatever system resources it can to make way for other uses. |
protected Filter |
getFilter()
What filter should be used to filter data in the format produced by this Book?. |
protected String |
getText(Key key)
Read the unfiltered data for a given key |
protected 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.PassageAbstractBook |
---|
createEmptyKeyList, getData, getGlobalKeyList, getKey, getRawData, setDocument |
Methods inherited from class org.crosswire.jsword.book.basic.AbstractBook |
---|
addPropertyChangeListener, compareTo, 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 Backend backend
private SwordBookMetaData sbmd
Constructor Detail |
---|
public SwordBook(SwordBookMetaData sbmd, Backend backend)
Method Detail |
---|
public final void activate(Lock lock)
Activatable
activate
in interface Activatable
activate
in class AbstractBook
lock
- An attempt to ensure that only the Activator calls this methodpublic final void deactivate(Lock lock)
Activatable
deactivate
in interface Activatable
deactivate
in class AbstractBook
lock
- An attempt to ensure that only the Activator calls this methodprotected String getText(Key key) throws BookException
getText
in class PassageAbstractBook
BookException
public void addOSIS(Key key, org.jdom.Element div, List osisContent)
PassageAbstractBook
addOSIS
in class PassageAbstractBook
key
- The key being addeddiv
- The div element to which the key is being addedosisContent
- The OSIS representation of the key being added.protected void setText(Verse verse, String text) throws BookException
PassageAbstractBook
setText
in class PassageAbstractBook
BookException
protected Filter getFilter()
PassageAbstractBook
getFilter
in class PassageAbstractBook
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |